Class Connection
This class allows you to access the Qarnot compute API and construct other objects: QTask, QPool
Inherited Members
Namespace: QarnotSDK
Assembly: QarnotSDK.dll
Syntax
public class ConnectionConstructors
Connection(string, HttpClientHandler, IRetryHandler, bool, bool)
Construct a new Connection object using your token.
Declaration
public Connection(string token, HttpClientHandler httpClientHandler = null, IRetryHandler retryHandler = null, bool forceStoragePathStyle = false, bool sanitizeBucketPaths = true)Parameters
| Type | Name | Description |
|---|---|---|
| string | token | The Api token available at https://account.qarnot.com |
| HttpClientHandler | httpClientHandler | An optional HttpClientHandler if you need to setup a proxy for example. |
| IRetryHandler | retryHandler | An optional IRetryHandler if you need to setup retry for transient error (default to exponential). |
| bool | forceStoragePathStyle | An optional forceStoragePathStyle to force path style for request to storage. |
| bool | sanitizeBucketPaths | A flag to enable the sanitization of bucket paths (removing leading and duplicated slashes). Enabled by default |
Connection(string, string, HttpClientHandler, IRetryHandler, bool, bool)
Construct a new Connection object to a different Api endpoints (private, UAT, Dev...) using your token.
Declaration
public Connection(string uri, string token, HttpClientHandler httpClientHandler = null, IRetryHandler retryHandler = null, bool forceStoragePathStyle = false, bool sanitizeBucketPaths = true)Parameters
| Type | Name | Description |
|---|---|---|
| string | uri | Api Uri, should be https://api.qarnot.com |
| string | token | The Api token available at https://account.qarnot.com |
| HttpClientHandler | httpClientHandler | An optional HttpClientHandler if you need to setup a proxy for example. |
| IRetryHandler | retryHandler | An optional IRetryHandler if you need to setup retry for transient error (default to exponential). |
| bool | forceStoragePathStyle | An optional forceStoragePathStyle to force path style for request to storage. |
| bool | sanitizeBucketPaths | A flag to enable the sanitization of bucket paths (removing leading and duplicated slashes). Enabled by default |
Connection(string, string, string, HttpClientHandler, IRetryHandler, bool, List<DelegatingHandler>, uint?, bool, bool)
Construct a new Connection object to a different Api endpoints (private, UAT, Dev...) and different S3 storage endpoints using your token.
Declaration
public Connection(string uri, string storageUri, string token, HttpClientHandler httpClientHandler = null, IRetryHandler retryHandler = null, bool forceStoragePathStyle = false, List<DelegatingHandler> delegatingHandlers = null, uint? dnsSrvLoadBalancingCacheTime = 5, bool sanitizeBucketPaths = true, bool showBucketWarnings = true)Parameters
| Type | Name | Description |
|---|---|---|
| string | uri | Api Uri, should be https://api.qarnot.com |
| string | storageUri | Storage Uri, should be null or https://storage.qarnot.com |
| string | token | The api token available at https://account.qarnot.com |
| HttpClientHandler | httpClientHandler | An optional HttpClientHandler for the api, if you need to setup a proxy for example. |
| IRetryHandler | retryHandler | An optional IRetryHandler if you need to setup retry for transient error (default to exponential). |
| bool | forceStoragePathStyle | An optional forceStoragePathStyle to force path style for request to storage. |
| List<DelegatingHandler> | delegatingHandlers | A list of hander used by the api connection. Default will create a list with the QarnotSrvHandler. |
| uint? | dnsSrvLoadBalancingCacheTime | the cache time in minutes before retrieve the values of the QarnotSrvHandler. Unless you have a strong reason, you should keep the default value. |
| bool | sanitizeBucketPaths | A flag to enable the sanitization of bucket paths (removing leading and duplicated slashes). Enabled by default |
| bool | showBucketWarnings | A flag to choose to show or remove the warnings during bucket sanitization. Enabled by default |
Properties
CarbonClient
Allows to interact with the Qarnot Carbon API.
Declaration
public virtual CarbonCalculator CarbonClient { get; }Property Value
| Type | Description |
|---|---|
| CarbonCalculator |
ForceStoragePathStyle
Boolean to force all requests to the storage service to use a path style instead of a virtual host.
Declaration
public virtual bool ForceStoragePathStyle { get; set; }Property Value
| Type | Description |
|---|---|
| bool |
HasShortnameFeature
Specify if the Api has the shortname feature to retrieve the tasks/pools by name. If set to false, the task/pool shortname feature will be emulated by the SDK, however more requests are needed to achieve the same result. The default value is true.
Declaration
[Obsolete("It will always be True as the SDK don't need to emulate shortname anymore", false)]
public bool HasShortnameFeature { get; set; }Property Value
| Type | Description |
|---|---|
| bool |
IsReadOnly
Set the Connection object in read-only mode, useful for monitoring purpose.
Declaration
public virtual bool IsReadOnly { get; set; }Property Value
| Type | Description |
|---|---|
| bool |
MaxRetry
Maximum number of retries in case of transient error. Default is 3 times.
Declaration
public virtual int MaxRetry { get; set; }Property Value
| Type | Description |
|---|---|
| int |
MaxStorageRetry
Maximum number of retries in case of storage error. Default is 3 times.
Declaration
public virtual int MaxStorageRetry { get; set; }Property Value
| Type | Description |
|---|---|
| int |
RetryInterval
Interval between retries (in milliseconds). Default is 500 ms.
Declaration
public virtual int RetryInterval { get; set; }Property Value
| Type | Description |
|---|---|
| int |
Secrets
Allows to interact with the Qarnot Secrets API.
Declaration
public virtual Secrets Secrets { get; }Property Value
| Type | Description |
|---|---|
| Secrets |
StorageAccessKey
The access key to your buckets. By default, this is your account email. Note: if null or empty, this value is auto filled when calling any Bucket method for the first time.
Declaration
public virtual string StorageAccessKey { get; set; }Property Value
| Type | Description |
|---|---|
| string |
StorageAvailablePartSizes
List of part sizes to try to compute the bucket object eTag. The default element is "0" which means "try to guess the part sizes" If you know the part size or have a part size not multiple of 1MB, you can override this list to improve performances.
Declaration
public virtual List<long> StorageAvailablePartSizes { get; set; }Property Value
| Type | Description |
|---|---|
| List<long> |
StorageSecretKey
The secret key to your buckets. By default, this is your token.
Declaration
public virtual string StorageSecretKey { get; set; }Property Value
| Type | Description |
|---|---|
| string |
StorageUploadPartSize
The upload part size for your bucket's object. If set to 0, the object are not uploaded by part. Must be greater than "5 * 1024 * 1024" (5MB).
Declaration
public virtual long StorageUploadPartSize { get; set; }Property Value
| Type | Description |
|---|---|
| long |
StorageUri
The Uri where the buckets are stored. Note: if null or empty, this value is auto filled when calling any Bucket method for the first time.
Declaration
public virtual Uri StorageUri { get; set; }Property Value
| Type | Description |
|---|---|
| Uri |
Token
The token used for authentication against the Api. This token is available at https://account.qarnot.com
Declaration
public virtual string Token { get; }Property Value
| Type | Description |
|---|---|
| string |
Uri
Api Uri. The default ClusterUri is https://api.qarnot.com
Declaration
public virtual Uri Uri { get; }Property Value
| Type | Description |
|---|---|
| Uri |
Methods
CreateBucket(string, CancellationToken)
Create a new bucket.
Declaration
[Obsolete("CreateBucket is deprecated, please use CreateBucketAsync instead.")]
public virtual QBucket CreateBucket(string name, CancellationToken ct = default)Parameters
| Type | Name | Description |
|---|---|---|
| string | name | The name of the bucket. |
| CancellationToken | ct | Optional token to cancel the request. |
Returns
| Type | Description |
|---|---|
| QBucket | A new Bucket. |
CreateBucketAsync(string, CancellationToken)
Create a new bucket.
Declaration
public virtual Task<QBucket> CreateBucketAsync(string name, CancellationToken ct = default)Parameters
| Type | Name | Description |
|---|---|---|
| string | name | The name of the bucket. |
| CancellationToken | ct | Optional token to cancel the request. |
Returns
| Type | Description |
|---|---|
| Task<QBucket> | A new Bucket. |
CreateJob(string, QPool, string, bool)
Create a new job.
Declaration
public virtual QJob CreateJob(string name, QPool pool = null, string shortname = null, bool UseTaskDependencies = false)Parameters
| Type | Name | Description |
|---|---|---|
| string | name | The job name. |
| QPool | pool | The pool we want the job to be attached to. |
| string | shortname | The pool unique shortname. |
| bool | UseTaskDependencies | Bool to allow use of dependencies for tasks in this job. |
Returns
| Type | Description |
|---|---|
| QJob | A new job. |
CreatePool(string, string, uint, string, bool?)
Create a new Pool. A pool is a running set of nodes where you can execute tasks. The newly created pool has to be started.
Declaration
public virtual QPool CreatePool(string name, string profile = null, uint initialNodeCount = 0, string shortname = null, bool? taskDefaultWaitForPoolResourcesSynchronization = null)Parameters
| Type | Name | Description |
|---|---|---|
| string | name | The name of the pool |
| string | profile | The profile of the pool. If not specified, it must be given when the pool is started. |
| uint | initialNodeCount | The number of nodes you want in the pool. If not specified, it must be given when the pool is started. |
| string | shortname | optional unique friendly shortname of the pool. |
| bool? | taskDefaultWaitForPoolResourcesSynchronization | Default value for task's WaitForPoolResourcesSynchronization, see also TaskDefaultWaitForPoolResourcesSynchronization |
Returns
| Type | Description |
|---|---|
| QPool | A new pool. |
CreateTask(string, QJob, AdvancedRanges, string, string)
Create a new Task attached to a job. The newly created task has to be submitted.
Declaration
public virtual QTask CreateTask(string name, QJob job, AdvancedRanges range, string shortname = null, string profile = null)Parameters
| Type | Name | Description |
|---|---|---|
| string | name | The name of the task. |
| QJob | job | The job, the task will be attached to. |
| AdvancedRanges | range | Which instance ids of the task have to run. |
| string | shortname | optional unique friendly shortname of the task. |
| string | profile | optional task profile when using a job detached from a pool. |
Returns
| Type | Description |
|---|---|
| QTask | A new task. |
CreateTask(string, QJob, uint, string, string)
Create a new Task attached to a job. The newly created task has to be submitted.
Declaration
public virtual QTask CreateTask(string name, QJob job, uint instanceCount, string shortname = null, string profile = null)Parameters
| Type | Name | Description |
|---|---|---|
| string | name | The name of the task. |
| QJob | job | The job, the task will be attached to. |
| uint | instanceCount | How many times the task have to run. |
| string | shortname | optional unique friendly shortname of the task. |
| string | profile | optional task profile when using a job detached from a pool. |
Returns
| Type | Description |
|---|---|
| QTask | A new task. |
CreateTask(string, QPool, AdvancedRanges, string, bool?)
Create a new Task inside an existing pool. The newly created task has to be submitted.
Declaration
public virtual QTask CreateTask(string name, QPool pool, AdvancedRanges range, string shortname = null, bool? waitForPoolResourcesSynchronization = null)Parameters
| Type | Name | Description |
|---|---|---|
| string | name | The name of the task. |
| QPool | pool | The pool where the task will run. |
| AdvancedRanges | range | Which instance ids of the task have to run. |
| string | shortname | optional unique friendly shortname of the task. |
| bool? | waitForPoolResourcesSynchronization | Whether task should wait for previous pool resources update to be completed before executing. See WaitForPoolResourcesSynchronization |
Returns
| Type | Description |
|---|---|
| QTask | A new task. |
CreateTask(string, QPool, uint, string, bool?)
Create a new Task inside an existing pool. The newly created task has to be submitted.
Declaration
public virtual QTask CreateTask(string name, QPool pool, uint instanceCount, string shortname = null, bool? waitForPoolResourcesSynchronization = null)Parameters
| Type | Name | Description |
|---|---|---|
| string | name | The name of the task. |
| QPool | pool | The pool where the task will run. |
| uint | instanceCount | How many times the task have to run. |
| string | shortname | optional unique friendly shortname of the task. |
| bool? | waitForPoolResourcesSynchronization | Whether task should wait for previous pool resources update to be completed before executing. See WaitForPoolResourcesSynchronization |
Returns
| Type | Description |
|---|---|
| QTask | A new task. |
CreateTask(string, string, AdvancedRanges, string)
Create a new Task that will run outside of any pool. The newly created task has to be submitted.
Declaration
public virtual QTask CreateTask(string name, string profile, AdvancedRanges range, string shortname = null)Parameters
| Type | Name | Description |
|---|---|---|
| string | name | The name of the task. |
| string | profile | The profile of the task. If not specified, it must be given when the task is submitted. |
| AdvancedRanges | range | Which instance ids of the task have to run. If not specified, it must be given when the task is submitted. |
| string | shortname | optional unique friendly shortname of the task. |
Returns
| Type | Description |
|---|---|
| QTask | A new task. |
CreateTask(string, string, string)
Create a new Task that will run outside of any pool. The newly created task has to be submitted.
Declaration
public virtual QTask CreateTask(string name, string profile = null, string shortname = null)Parameters
| Type | Name | Description |
|---|---|---|
| string | name | The name of the task. |
| string | profile | The profile of the task. If not specified, it must be given when the task is submitted. |
| string | shortname | optional unique friendly shortname of the task. |
Returns
| Type | Description |
|---|---|
| QTask | A new task. |
CreateTask(string, string, uint, string)
Create a new Task that will run outside of any pool. The newly created task has to be submitted.
Declaration
public virtual QTask CreateTask(string name, string profile, uint instanceCount = 0, string shortname = null)Parameters
| Type | Name | Description |
|---|---|---|
| string | name | The name of the task. |
| string | profile | The profile of the task. If not specified, it must be given when the task is submitted. |
| uint | instanceCount | How many times the task have to run. If not specified, it must be given when the task is submitted. |
| string | shortname | optional unique friendly shortname of the task. |
Returns
| Type | Description |
|---|---|
| QTask | A new task. |
RetrieveApiSettingsAsync(CancellationToken)
Retrieve the rest Api settings.
Declaration
public virtual Task<ApiSettings> RetrieveApiSettingsAsync(CancellationToken cancellationToken = default)Parameters
| Type | Name | Description |
|---|---|---|
| CancellationToken | cancellationToken | Optional token to cancel the request. |
Returns
| Type | Description |
|---|---|
| Task<ApiSettings> | The rest Api settings. |
RetrieveBucket(string, CancellationToken)
Retrieve the bucket
Declaration
[Obsolete("RetrieveBucket is deprecated, please use RetrieveBucketAsync instead.")]
public virtual QBucket RetrieveBucket(string bucketName, CancellationToken cancellationToken = default)Parameters
| Type | Name | Description |
|---|---|---|
| string | bucketName | Unique name of the bucket to retrieve. |
| CancellationToken | cancellationToken | Optional token to cancel the request. |
Returns
| Type | Description |
|---|---|
| QBucket | Corresponding bucket. |
Remarks
If the bucket is not found, null is return
RetrieveBucketAsync(string, CancellationToken)
Retrieve the bucket for the corresponding unique name.
Declaration
public virtual Task<QBucket> RetrieveBucketAsync(string bucketName, CancellationToken cancellationToken = default)Parameters
| Type | Name | Description |
|---|---|---|
| string | bucketName | Unique name of the bucket. |
| CancellationToken | cancellationToken | Optional token to cancel the request. |
Returns
| Type | Description |
|---|---|
| Task<QBucket> | The bucket. |
RetrieveBuckets(bool, CancellationToken)
Retrieve the buckets list.
Declaration
[Obsolete("RetrieveBuckets is deprecated, please use RetrieveBucketsAsync instead.")]
public virtual List<QBucket> RetrieveBuckets(bool retrieveBucketStats, CancellationToken cancellationToken = default)Parameters
| Type | Name | Description |
|---|---|---|
| bool | retrieveBucketStats | If set to true, the file count and used space of each bucket is also retrieved. If set to false, it is faster but only the bucket names are returned. |
| CancellationToken | cancellationToken | Optional token to cancel the request. |
Returns
| Type | Description |
|---|---|
| List<QBucket> | A list of buckets. |
RetrieveBuckets(CancellationToken)
Retrieve the buckets list with each bucket file count and used space.
Declaration
[Obsolete("RetrieveBuckets is deprecated, please use RetrieveBucketsAsync instead.")]
public virtual List<QBucket> RetrieveBuckets(CancellationToken cancellationToken = default)Parameters
| Type | Name | Description |
|---|---|---|
| CancellationToken | cancellationToken | Optional token to cancel the request. |
Returns
| Type | Description |
|---|---|
| List<QBucket> | A list of buckets. |
RetrieveBucketsAsync(bool, CancellationToken)
Retrieve the buckets list.
Declaration
public virtual Task<List<QBucket>> RetrieveBucketsAsync(bool retrieveBucketStats, CancellationToken cancellationToken = default)Parameters
| Type | Name | Description |
|---|---|---|
| bool | retrieveBucketStats | If set to true, the file count and used space of each bucket is also retrieved. If set to false, it is faster but only the bucket names are returned. |
| CancellationToken | cancellationToken | Optional token to cancel the request. |
Returns
| Type | Description |
|---|---|
| Task<List<QBucket>> | A list of buckets. |
RetrieveBucketsAsync(CancellationToken)
Retrieve the buckets list with each bucket file count and used space.
Declaration
public virtual Task<List<QBucket>> RetrieveBucketsAsync(CancellationToken cancellationToken = default)Parameters
| Type | Name | Description |
|---|---|---|
| CancellationToken | cancellationToken | Optional token to cancel the request. |
Returns
| Type | Description |
|---|---|
| Task<List<QBucket>> | A list of buckets. |
RetrieveConstants(string, CancellationToken)
Retrieve the list of the constants you can override for a specific profile.
Declaration
[Obsolete("RetrieveConstants is deprecated, please use RetrieveConstantsAsync instead.")]
public virtual List<Constant> RetrieveConstants(string profile, CancellationToken cancellationToken = default)Parameters
| Type | Name | Description |
|---|---|---|
| string | profile | Name of the profile. |
| CancellationToken | cancellationToken | Optional token to cancel the request. |
Returns
| Type | Description |
|---|---|
| List<Constant> | A list of constants. |
RetrieveConstantsAsync(string, CancellationToken)
Retrieve the list of the constants you can override for a specific profile.
Declaration
public virtual Task<List<Constant>> RetrieveConstantsAsync(string profile, CancellationToken cancellationToken = default)Parameters
| Type | Name | Description |
|---|---|---|
| string | profile | Name of the profile. |
| CancellationToken | cancellationToken | Optional token to cancel the request. |
Returns
| Type | Description |
|---|---|
| Task<List<Constant>> | A list of constants. |
RetrieveJobByShortnameAsync(string, CancellationToken)
Retrieve a job by its shortname.
Declaration
public virtual Task<QJob> RetrieveJobByShortnameAsync(string shortname, CancellationToken cancellationToken = default)Parameters
| Type | Name | Description |
|---|---|---|
| string | shortname | shortname of the job to find, or it's uuid if no shortname has bin set. |
| CancellationToken | cancellationToken | Optional token to cancel the request. |
Returns
| Type | Description |
|---|---|
| Task<QJob> | The job object for that shortname or null if it hasn't been found. |
RetrieveJobByUuid(string, CancellationToken)
Retrieve a job by its uuid or shortname.
Declaration
[Obsolete("RetrieveJobByUuid is deprecated, please use RetrieveJobByUuidAsync instead.")]
public virtual QJob RetrieveJobByUuid(string uuid, CancellationToken cancellationToken = default)Parameters
| Type | Name | Description |
|---|---|---|
| string | uuid | uuid or shortname of the job to find. |
| CancellationToken | cancellationToken | Optional token to cancel the request. |
Returns
| Type | Description |
|---|---|
| QJob | The job object for that uuid or null if it hasn't been found. |
RetrieveJobByUuidAsync(string, CancellationToken)
Retrieve a job by its uuid or shortname.
Declaration
public virtual Task<QJob> RetrieveJobByUuidAsync(string uuid, CancellationToken cancellationToken = default)Parameters
| Type | Name | Description |
|---|---|---|
| string | uuid | uuid or shortname of the job to find. |
| CancellationToken | cancellationToken | Optional token to cancel the request. |
Returns
| Type | Description |
|---|---|
| Task<QJob> | The job object for that uuid or null if it hasn't been found. |
RetrieveJobs(QDataDetail<QJob>, CancellationToken)
Retrieve the jobs list with custom filtering.
Declaration
[Obsolete("RetrieveJobs is deprecated, please use RetrieveJobsAsync instead.")]
public virtual List<QJob> RetrieveJobs(QDataDetail<QJob> level, CancellationToken cancellationToken = default)Parameters
| Type | Name | Description |
|---|---|---|
| QDataDetail<QJob> | level | the sjob filter object |
| CancellationToken | cancellationToken | Optional token to cancel the request. |
Returns
| Type | Description |
|---|---|
| List<QJob> | A list of jobs. |
RetrieveJobs(CancellationToken)
Retrieve the list of jobs.
Declaration
[Obsolete("RetrieveJobs is deprecated, please use RetrieveJobsAsync instead.")]
public virtual List<QJob> RetrieveJobs(CancellationToken cancellationToken = default)Parameters
| Type | Name | Description |
|---|---|---|
| CancellationToken | cancellationToken | Optional token to cancel the request. |
Returns
| Type | Description |
|---|---|
| List<QJob> | A list of jobs. |
RetrieveJobsAsync(QDataDetail<QJob>, CancellationToken)
Retrieve the jobs list with custom filtering.
Declaration
public virtual Task<List<QJob>> RetrieveJobsAsync(QDataDetail<QJob> level, CancellationToken cancellationToken = default)Parameters
| Type | Name | Description |
|---|---|---|
| QDataDetail<QJob> | level | the qjob filter object |
| CancellationToken | cancellationToken | Optional token to cancel the request. |
Returns
| Type | Description |
|---|---|
| Task<List<QJob>> | A list of jobs. |
RetrieveJobsAsync(CancellationToken)
Retrieve the job list.
Declaration
public virtual Task<List<QJob>> RetrieveJobsAsync(CancellationToken cancellationToken = default)Parameters
| Type | Name | Description |
|---|---|---|
| CancellationToken | cancellationToken | Optional token to cancel the request. |
Returns
| Type | Description |
|---|---|
| Task<List<QJob>> | A list of jobs. |
RetrieveJobsByTagsAsync(List<string>, CancellationToken)
Retrieve the jobs list filtered by tags.
Declaration
public virtual Task<IEnumerable<QJob>> RetrieveJobsByTagsAsync(List<string> tags, CancellationToken cancellationToken = default)Parameters
| Type | Name | Description |
|---|---|---|
| List<string> | tags | list of tags for job filtering. |
| CancellationToken | cancellationToken | Optional token to cancel the request. |
Returns
| Type | Description |
|---|---|
| Task<IEnumerable<QJob>> | An enumeration of jobs. |
RetrieveOrCreateBucket(string, CancellationToken)
Retrieve the bucket, if it does not exist, create it
Declaration
[Obsolete("RetrieveOrCreateBucket is deprecated, please use RetrieveOrCreateBucketAsync instead.")]
public virtual QBucket RetrieveOrCreateBucket(string bucketName, CancellationToken cancellationToken = default)Parameters
| Type | Name | Description |
|---|---|---|
| string | bucketName | Unique name of the bucket to retrieve. |
| CancellationToken | cancellationToken | Optional token to cancel the request. |
Returns
| Type | Description |
|---|---|
| QBucket | Corresponding bucket. |
RetrieveOrCreateBucketAsync(string, CancellationToken)
Retrieve a bucket or create one if it does not exist.
Declaration
public virtual Task<QBucket> RetrieveOrCreateBucketAsync(string bucketName, CancellationToken cancellationToken = default)Parameters
| Type | Name | Description |
|---|---|---|
| string | bucketName | The name of the bucket. |
| CancellationToken | cancellationToken | Optional token to cancel the request. |
Returns
| Type | Description |
|---|---|
| Task<QBucket> | A new Bucket. |
RetrievePaginatedJob(PaginatedRequest<QJob>, CancellationToken)
Retrieve a page of the jobs list.
Declaration
[Obsolete("RetrievePaginatedJob is deprecated, please use RetrievePaginatedJobAsync instead.")]
public virtual PaginatedResponse<QJob> RetrievePaginatedJob(PaginatedRequest<QJob> pageDetails, CancellationToken cancellationToken = default)Parameters
| Type | Name | Description |
|---|---|---|
| PaginatedRequest<QJob> | pageDetails | The pagination details, with the result number by page, the filters and the token of the page to reach. |
| CancellationToken | cancellationToken | Optional token to cancel the request. |
Returns
| Type | Description |
|---|---|
| PaginatedResponse<QJob> | A page with a list of jobs. |
RetrievePaginatedJobAsync(PaginatedRequest<QJob>, CancellationToken)
Retrieve a page of the jobs list.
Declaration
public virtual Task<PaginatedResponse<QJob>> RetrievePaginatedJobAsync(PaginatedRequest<QJob> pageDetails, CancellationToken cancellationToken = default)Parameters
| Type | Name | Description |
|---|---|---|
| PaginatedRequest<QJob> | pageDetails | The pagination details, with the result number by page, the filters and the token of the page to reach. |
| CancellationToken | cancellationToken | Optional token to cancel the request. |
Returns
| Type | Description |
|---|---|
| Task<PaginatedResponse<QJob>> | A page with a list of jobs. |
RetrievePaginatedPool(PaginatedRequest<QPool>, CancellationToken)
Retrieve a page of the pools list.
Declaration
[Obsolete("RetrievePaginatedPool is deprecated, please use RetrievePaginatedPoolAsync instead.")]
public virtual PaginatedResponse<QPool> RetrievePaginatedPool(PaginatedRequest<QPool> pageDetails, CancellationToken cancellationToken = default)Parameters
| Type | Name | Description |
|---|---|---|
| PaginatedRequest<QPool> | pageDetails | The pagination details, with the result number by page, the filters and the token of the page to reach. |
| CancellationToken | cancellationToken | Optional token to cancel the request. |
Returns
| Type | Description |
|---|---|
| PaginatedResponse<QPool> | A page with a list of pools. |
RetrievePaginatedPoolAsync(PaginatedRequest<QPool>, CancellationToken)
Retrieve a page of the pools list.
Declaration
public virtual Task<PaginatedResponse<QPool>> RetrievePaginatedPoolAsync(PaginatedRequest<QPool> pageDetails, CancellationToken cancellationToken = default)Parameters
| Type | Name | Description |
|---|---|---|
| PaginatedRequest<QPool> | pageDetails | The pagination details, with the result number by page, the filters and the token of the page to reach. |
| CancellationToken | cancellationToken | Optional token to cancel the request. |
Returns
| Type | Description |
|---|---|
| Task<PaginatedResponse<QPool>> | A page with a list of pools. |
RetrievePaginatedPoolSummaries(PaginatedRequest<QPoolSummary>, CancellationToken)
Retrieve a page of the pools list summaries.
Declaration
[Obsolete("RetrievePaginatedPoolSummaries is deprecated, please use RetrievePaginatedPoolSummariesAsync instead.")]
public virtual PaginatedResponse<QPoolSummary> RetrievePaginatedPoolSummaries(PaginatedRequest<QPoolSummary> pageDetails, CancellationToken cancellationToken = default)Parameters
| Type | Name | Description |
|---|---|---|
| PaginatedRequest<QPoolSummary> | pageDetails | The pagination details, with the result number by page, the filters and the token of the page to reach. |
| CancellationToken | cancellationToken | Optional token to cancel the request. |
Returns
| Type | Description |
|---|---|
| PaginatedResponse<QPoolSummary> | A response page with list of pools. |
RetrievePaginatedPoolSummariesAsync(PaginatedRequest<QPoolSummary>, CancellationToken)
Retrieve a page of the pools list summaries.
Declaration
public virtual Task<PaginatedResponse<QPoolSummary>> RetrievePaginatedPoolSummariesAsync(PaginatedRequest<QPoolSummary> pageDetails, CancellationToken cancellationToken = default)Parameters
| Type | Name | Description |
|---|---|---|
| PaginatedRequest<QPoolSummary> | pageDetails | The pagination details, with the result number by page, the filters and the token of the page to reach. |
| CancellationToken | cancellationToken | Optional token to cancel the request. |
Returns
| Type | Description |
|---|---|
| Task<PaginatedResponse<QPoolSummary>> | A response page with list of pools. |
RetrievePaginatedTask(PaginatedRequest<QTask>, CancellationToken)
Retrieve a page of the tasks list.
Declaration
[Obsolete("RetrievePaginatedTask is deprecated, please use RetrievePaginatedTaskAsync instead.")]
public virtual PaginatedResponse<QTask> RetrievePaginatedTask(PaginatedRequest<QTask> pageDetails, CancellationToken cancellationToken = default)Parameters
| Type | Name | Description |
|---|---|---|
| PaginatedRequest<QTask> | pageDetails | The pagination details, with the result number by page, the filters and the token of the page to reach. |
| CancellationToken | cancellationToken | Optional token to cancel the request. |
Returns
| Type | Description |
|---|---|
| PaginatedResponse<QTask> | A page with a list of tasks. |
RetrievePaginatedTaskAsync(PaginatedRequest<QTask>, CancellationToken)
Retrieve a page of the tasks list.
Declaration
public virtual Task<PaginatedResponse<QTask>> RetrievePaginatedTaskAsync(PaginatedRequest<QTask> pageDetails, CancellationToken cancellationToken = default)Parameters
| Type | Name | Description |
|---|---|---|
| PaginatedRequest<QTask> | pageDetails | The pagination details, with the result number by page, the filters and the token of the page to reach. |
| CancellationToken | cancellationToken | Optional token to cancel the request. |
Returns
| Type | Description |
|---|---|
| Task<PaginatedResponse<QTask>> | A page with a list of tasks. |
RetrievePaginatedTaskSummaries(PaginatedRequest<QTaskSummary>, CancellationToken)
Retrieve a page of the tasks list summaries.
Declaration
[Obsolete("RetrievePaginatedTaskSummaries is deprecated, please use RetrievePaginatedTaskSummariesAsync instead.")]
public virtual PaginatedResponse<QTaskSummary> RetrievePaginatedTaskSummaries(PaginatedRequest<QTaskSummary> pageDetails, CancellationToken cancellationToken = default)Parameters
| Type | Name | Description |
|---|---|---|
| PaginatedRequest<QTaskSummary> | pageDetails | The pagination details, with the result number by page, the filters and the token of the page to reach. |
| CancellationToken | cancellationToken | Optional token to cancel the request. |
Returns
| Type | Description |
|---|---|
| PaginatedResponse<QTaskSummary> | A response page with list of tasks. |
RetrievePaginatedTaskSummariesAsync(PaginatedRequest<QTaskSummary>, CancellationToken)
Retrieve a page of the tasks list summaries.
Declaration
public virtual Task<PaginatedResponse<QTaskSummary>> RetrievePaginatedTaskSummariesAsync(PaginatedRequest<QTaskSummary> pageDetails, CancellationToken cancellationToken = default)Parameters
| Type | Name | Description |
|---|---|---|
| PaginatedRequest<QTaskSummary> | pageDetails | The pagination details, with the result number by page, the filters and the token of the page to reach. |
| CancellationToken | cancellationToken | Optional token to cancel the request. |
Returns
| Type | Description |
|---|---|
| Task<PaginatedResponse<QTaskSummary>> | A response page with list of tasks. |
RetrievePoolByName(string, CancellationToken)
Retrieve a pool by its name.
Declaration
[Obsolete("RetrievePoolByName is deprecated, please use RetrievePoolByShortnameAsync or RetrievePoolsByNameAsync instead.")]
public virtual QPool RetrievePoolByName(string name, CancellationToken cancellationToken = default)Parameters
| Type | Name | Description |
|---|---|---|
| string | name | Name of the pool to find. |
| CancellationToken | cancellationToken | Optional token to cancel the request. |
Returns
| Type | Description |
|---|---|
| QPool | The pool object for that name or null if it hasn't been found. |
RetrievePoolByNameAsync(string, CancellationToken)
Retrieve a pool by its name.
Declaration
[Obsolete("RetrievePoolByNameAsync is deprecated, please use RetrievePoolByShortnameAsync or RetrievePoolsByNameAsync instead.")]
public virtual Task<QPool> RetrievePoolByNameAsync(string name, CancellationToken cancellationToken = default)Parameters
| Type | Name | Description |
|---|---|---|
| string | name | Name of the pool to find. |
| CancellationToken | cancellationToken | Optional token to cancel the request. |
Returns
| Type | Description |
|---|---|
| Task<QPool> | The pool object for that name or null if it hasn't been found. |
RetrievePoolByShortnameAsync(string, CancellationToken)
Retrieve a pool by its shortname.
Declaration
public virtual Task<QPool> RetrievePoolByShortnameAsync(string shortname, CancellationToken cancellationToken = default)Parameters
| Type | Name | Description |
|---|---|---|
| string | shortname | shortname of the pool to find. (if shortname is not set, the shortname is equivalant to the uuid). |
| CancellationToken | cancellationToken | Optional token to cancel the request. |
Returns
| Type | Description |
|---|---|
| Task<QPool> | The pool object for that shortname or null if it hasn't been found. |
RetrievePoolByUuid(string, CancellationToken)
Retrieve a pool by its uuid or shortname(unique and dns compliant).
Declaration
[Obsolete("RetrievePoolByUuid is deprecated, please use RetrievePoolByUuidAsync instead.")]
public virtual QPool RetrievePoolByUuid(string uuid, CancellationToken cancellationToken = default)Parameters
| Type | Name | Description |
|---|---|---|
| string | uuid | uuid or shortname of the pool to find. |
| CancellationToken | cancellationToken | Optional token to cancel the request. |
Returns
| Type | Description |
|---|---|
| QPool | The pool object for that uuid or null if it hasn't been found. |
RetrievePoolByUuidAsync(string, CancellationToken)
Retrieve a pool by its uuid or shortname.
Declaration
public virtual Task<QPool> RetrievePoolByUuidAsync(string uuid, CancellationToken cancellationToken = default)Parameters
| Type | Name | Description |
|---|---|---|
| string | uuid | uuid or shortname of the pool to find. |
| CancellationToken | cancellationToken | Optional token to cancel the request. |
Returns
| Type | Description |
|---|---|
| Task<QPool> | The pool object for that uuid or null if it hasn't been found. |
RetrievePoolSummaries(CancellationToken)
Retrieve the list of pools summary.
Declaration
[Obsolete("RetrievePoolSummaries is deprecated, please use RetrievePoolSummariesAsync instead.")]
public virtual List<QPoolSummary> RetrievePoolSummaries(CancellationToken cancellationToken = default)Parameters
| Type | Name | Description |
|---|---|---|
| CancellationToken | cancellationToken | Optional token to cancel the request. |
Returns
| Type | Description |
|---|---|
| List<QPoolSummary> | A list of pools summary. |
RetrievePoolSummariesAsync(CancellationToken)
Retrieve the pools summary list.
Declaration
public virtual Task<List<QPoolSummary>> RetrievePoolSummariesAsync(CancellationToken cancellationToken = default)Parameters
| Type | Name | Description |
|---|---|---|
| CancellationToken | cancellationToken | Optional token to cancel the request. |
Returns
| Type | Description |
|---|---|
| Task<List<QPoolSummary>> | A list of pools. |
RetrievePoolSummaryByName(string, CancellationToken)
Retrieve a pool summary by its name.
Declaration
[Obsolete("RetrievePoolSummaryByName is deprecated, please use RetrievePoolSummaryByShortnameAsync instead.")]
public virtual QPoolSummary RetrievePoolSummaryByName(string name, CancellationToken cancellationToken = default)Parameters
| Type | Name | Description |
|---|---|---|
| string | name | Name of the pool to find. |
| CancellationToken | cancellationToken | Optional token to cancel the request. |
Returns
| Type | Description |
|---|---|
| QPoolSummary | The pool summary object for that name or null if it hasn't been found. |
RetrievePoolSummaryByNameAsync(string, CancellationToken)
Retrieve a pool summary by its name.
Declaration
[Obsolete("RetrievePoolSummaryByNameAsync is deprecated, please use RetrievePoolSummaryByShortnameAsync instead.")]
public virtual Task<QPoolSummary> RetrievePoolSummaryByNameAsync(string name, CancellationToken cancellationToken = default)Parameters
| Type | Name | Description |
|---|---|---|
| string | name | Name of the pool to find. |
| CancellationToken | cancellationToken | Optional token to cancel the request. |
Returns
| Type | Description |
|---|---|
| Task<QPoolSummary> | The pool object for that name or null if it hasn't been found. |
RetrievePoolSummaryByShortnameAsync(string, CancellationToken)
Retrieve a pool summary by its shortname.
Declaration
public virtual Task<QPoolSummary> RetrievePoolSummaryByShortnameAsync(string shortname, CancellationToken cancellationToken = default)Parameters
| Type | Name | Description |
|---|---|---|
| string | shortname | shortname of the pool summary to find. (if shortname is not set, the shortname is equivalant to the uuid). |
| CancellationToken | cancellationToken | Optional token to cancel the request. |
Returns
| Type | Description |
|---|---|
| Task<QPoolSummary> | The pool summary object for that shortname or null if it hasn't been found. |
RetrievePoolSummaryByUuid(string, CancellationToken)
Retrieve a pool summary by its uuid or shortname.
Declaration
[Obsolete("RetrievePoolSummaryByUuid is deprecated, please use RetrievePoolSummaryByUuidAsync instead.")]
public virtual QPoolSummary RetrievePoolSummaryByUuid(string uuid, CancellationToken cancellationToken = default)Parameters
| Type | Name | Description |
|---|---|---|
| string | uuid | uuid or shortname of the pool to find. |
| CancellationToken | cancellationToken | Optional token to cancel the request. |
Returns
| Type | Description |
|---|---|
| QPoolSummary | The pool summary object for that uuid or null if it hasn't been found. |
RetrievePoolSummaryByUuidAsync(string, CancellationToken)
Retrieve a pool summary by its uuid or shortname.
Declaration
public virtual Task<QPoolSummary> RetrievePoolSummaryByUuidAsync(string uuid, CancellationToken cancellationToken = default)Parameters
| Type | Name | Description |
|---|---|---|
| string | uuid | uuid or shortname of the pool summary to find. |
| CancellationToken | cancellationToken | Optional token to cancel the request. |
Returns
| Type | Description |
|---|---|
| Task<QPoolSummary> | The pool summary object for that uuid or null if it hasn't been found. |
RetrievePools(QDataDetail<QPool>, CancellationToken)
Retrieve the pools list with custom filtering.
Declaration
[Obsolete("RetrievePools is deprecated, please use RetrievePoolsAsync instead.")]
public virtual List<QPool> RetrievePools(QDataDetail<QPool> level, CancellationToken cancellationToken = default)Parameters
| Type | Name | Description |
|---|---|---|
| QDataDetail<QPool> | level | the qpool filter object |
| CancellationToken | cancellationToken | Optional token to cancel the request. |
Returns
| Type | Description |
|---|---|
| List<QPool> | A list of pools. |
RetrievePools(bool, CancellationToken)
Retrieve the pools list. (deprecated)
Declaration
[Obsolete("RetrievePools is deprecated, please use RetrievePoolsAsync instead.")]
public virtual List<QPool> RetrievePools(bool summary, CancellationToken cancellationToken = default)Parameters
| Type | Name | Description |
|---|---|---|
| bool | summary | Obsolete params to get a summary version of a pool. |
| CancellationToken | cancellationToken | Optional token to cancel the request. |
Returns
| Type | Description |
|---|---|
| List<QPool> | A list of pools. |
RetrievePools(CancellationToken)
Retrieve the list of pools.
Declaration
[Obsolete("RetrievePools is deprecated, please use RetrievePoolsAsync instead.")]
public virtual List<QPool> RetrievePools(CancellationToken cancellationToken = default)Parameters
| Type | Name | Description |
|---|---|---|
| CancellationToken | cancellationToken | Optional token to cancel the request. |
Returns
| Type | Description |
|---|---|
| List<QPool> | A list of pools. |
RetrievePoolsAsync(QDataDetail<QPool>, CancellationToken)
Retrieve the pools list with custom filtering.
Declaration
public virtual Task<List<QPool>> RetrievePoolsAsync(QDataDetail<QPool> level, CancellationToken cancellationToken = default)Parameters
| Type | Name | Description |
|---|---|---|
| QDataDetail<QPool> | level | the qpool filter object |
| CancellationToken | cancellationToken | Optional token to cancel the request. |
Returns
| Type | Description |
|---|---|
| Task<List<QPool>> | A list of pools. |
RetrievePoolsAsync(bool, CancellationToken)
Retrieve the pools list. (deprecated)
Declaration
public virtual Task<List<QPool>> RetrievePoolsAsync(bool summary, CancellationToken cancellationToken = default)Parameters
| Type | Name | Description |
|---|---|---|
| bool | summary | Obsolete params to get a summary version of a pool. |
| CancellationToken | cancellationToken | Optional token to cancel the request. |
Returns
| Type | Description |
|---|---|
| Task<List<QPool>> | A list of pools. |
RetrievePoolsAsync(CancellationToken)
Retrieve the pools list.
Declaration
public virtual Task<List<QPool>> RetrievePoolsAsync(CancellationToken cancellationToken = default)Parameters
| Type | Name | Description |
|---|---|---|
| CancellationToken | cancellationToken | Optional token to cancel the request. |
Returns
| Type | Description |
|---|---|
| Task<List<QPool>> | A list of pools. |
RetrievePoolsByNameAsync(string, CancellationToken)
Retrieve a pool list by its name.
Declaration
public virtual Task<List<QPool>> RetrievePoolsByNameAsync(string name, CancellationToken cancellationToken = default)Parameters
| Type | Name | Description |
|---|---|---|
| string | name | Name of the pools to find. |
| CancellationToken | cancellationToken | Optional token to cancel the request. |
Returns
| Type | Description |
|---|---|
| Task<List<QPool>> | The pool list for that name. |
RetrievePoolsByTags(List<string>, bool, CancellationToken)
Retrieve the list of pools filtered by tags.
Declaration
[Obsolete("RetrievePoolsByTags is deprecated, please use RetrievePoolsByTagsAsync instead.")]
public virtual List<QPool> RetrievePoolsByTags(List<string> tags, bool summary = true, CancellationToken cancellationToken = default)Parameters
| Type | Name | Description |
|---|---|---|
| List<string> | tags | list of tags for pool filtering. |
| bool | summary | Optional token to choose between full pools and pools summaries. |
| CancellationToken | cancellationToken | Optional token to cancel the request. |
Returns
| Type | Description |
|---|---|
| List<QPool> | A list of pools. |
RetrievePoolsByTagsAsync(List<string>, bool, CancellationToken)
Retrieve the pools list filtered by tags.
Declaration
public virtual Task<List<QPool>> RetrievePoolsByTagsAsync(List<string> tags, bool summary = true, CancellationToken cancellationToken = default)Parameters
| Type | Name | Description |
|---|---|---|
| List<string> | tags | list of tags for pool filtering. |
| bool | summary | Optional token to choose between full pools and pools summaries. |
| CancellationToken | cancellationToken | Optional token to cancel the request. |
Returns
| Type | Description |
|---|---|
| Task<List<QPool>> | A list of pools. |
RetrieveProfiles(CancellationToken)
Retrieve the list of profiles available for your account.
Declaration
[Obsolete("RetrieveProfiles is deprecated, please use RetrieveProfilesAsync instead.")]
public virtual List<string> RetrieveProfiles(CancellationToken cancellationToken = default)Parameters
| Type | Name | Description |
|---|---|---|
| CancellationToken | cancellationToken | Optional token to cancel the request. |
Returns
| Type | Description |
|---|---|
| List<string> | A list of profile names. |
RetrieveProfilesAsync(CancellationToken)
Retrieve the list of profiles available for your account.
Declaration
public virtual Task<List<string>> RetrieveProfilesAsync(CancellationToken cancellationToken = default)Parameters
| Type | Name | Description |
|---|---|---|
| CancellationToken | cancellationToken | Optional token to cancel the request. |
Returns
| Type | Description |
|---|---|
| Task<List<string>> | A list of profile names. |
RetrieveTaskByName(string, CancellationToken)
Retrieve a task by its name.
Declaration
[Obsolete("RetrieveTaskByName is deprecated, please use RetrieveTaskByShortnameAsync or RetrieveTasksByNameAsync instead.")]
public virtual QTask RetrieveTaskByName(string name, CancellationToken cancellationToken = default)Parameters
| Type | Name | Description |
|---|---|---|
| string | name | Name of the task to find. |
| CancellationToken | cancellationToken | Optional token to cancel the request. |
Returns
| Type | Description |
|---|---|
| QTask | The task object for that name or null if it hasn't been found. |
RetrieveTaskByNameAsync(string, CancellationToken)
Retrieve a task by its name.
Declaration
[Obsolete("RetrieveTaskByNameAsync is deprecated, please use RetrieveTaskByShortnameAsync or RetrieveTasksByNameAsync instead.")]
public virtual Task<QTask> RetrieveTaskByNameAsync(string name, CancellationToken cancellationToken = default)Parameters
| Type | Name | Description |
|---|---|---|
| string | name | Name of the task to find. |
| CancellationToken | cancellationToken | Optional token to cancel the request. |
Returns
| Type | Description |
|---|---|
| Task<QTask> | The task object for that name or null if it hasn't been found. |
RetrieveTaskByShortnameAsync(string, CancellationToken)
Retrieve a task by its shortname.
Declaration
public virtual Task<QTask> RetrieveTaskByShortnameAsync(string shortname, CancellationToken cancellationToken = default)Parameters
| Type | Name | Description |
|---|---|---|
| string | shortname | shortname of the task to find, if the task shortname has not bean set, the shortname is equivalent to the uuid. |
| CancellationToken | cancellationToken | Optional token to cancel the request. |
Returns
| Type | Description |
|---|---|
| Task<QTask> | The task object for that shortname or null if it hasn't been found. |
RetrieveTaskByUuid(string, CancellationToken)
Retrieve a task by its uuid or shortname(unique and dns compliant).
Declaration
[Obsolete("RetrieveTaskByUuid is deprecated, please use RetrieveTaskByUuidAsync instead.")]
public virtual QTask RetrieveTaskByUuid(string uuid, CancellationToken cancellationToken = default)Parameters
| Type | Name | Description |
|---|---|---|
| string | uuid | uuid or shortname of the task to find. |
| CancellationToken | cancellationToken | Optional token to cancel the request. |
Returns
| Type | Description |
|---|---|
| QTask | The task object for that uuid or null if it hasn't been found. |
RetrieveTaskByUuidAsync(string, CancellationToken)
Retrieve a task by its uuid.
Declaration
public virtual Task<QTask> RetrieveTaskByUuidAsync(string uuid, CancellationToken cancellationToken = default)Parameters
| Type | Name | Description |
|---|---|---|
| string | uuid | uuid of the task to find. |
| CancellationToken | cancellationToken | Optional token to cancel the request. |
Returns
| Type | Description |
|---|---|
| Task<QTask> | The task object for that uuid or null if it hasn't been found. |
RetrieveTaskSummaries(CancellationToken)
Retrieve the list of tasks summary.
Declaration
[Obsolete("RetrieveTaskSummaries is deprecated, please use RetrieveTaskSummariesAsync instead.")]
public virtual List<QTaskSummary> RetrieveTaskSummaries(CancellationToken cancellationToken = default)Parameters
| Type | Name | Description |
|---|---|---|
| CancellationToken | cancellationToken | Optional token to cancel the request. |
Returns
| Type | Description |
|---|---|
| List<QTaskSummary> | A list of tasks. |
RetrieveTaskSummariesAsync(CancellationToken)
Retrieve the tasks list.
Declaration
public virtual Task<List<QTaskSummary>> RetrieveTaskSummariesAsync(CancellationToken cancellationToken = default)Parameters
| Type | Name | Description |
|---|---|---|
| CancellationToken | cancellationToken | Optional token to cancel the request. |
Returns
| Type | Description |
|---|---|
| Task<List<QTaskSummary>> | A list of tasks. |
RetrieveTaskSummariesByTags(List<string>, CancellationToken)
Retrieve the list of tasks summary filtered by tags.
Declaration
[Obsolete("RetrieveTaskSummariesByTags is deprecated, please use RetrieveTaskSummariesByTagsAsync instead.")]
public virtual List<QTaskSummary> RetrieveTaskSummariesByTags(List<string> tags, CancellationToken cancellationToken = default)Parameters
| Type | Name | Description |
|---|---|---|
| List<string> | tags | list of tags for task filtering. |
| CancellationToken | cancellationToken | Optional token to cancel the request. |
Returns
| Type | Description |
|---|---|
| List<QTaskSummary> | A list of tasks summary. |
RetrieveTaskSummariesByTagsAsync(List<string>, CancellationToken)
Retrieve the tasks list filtered by tags.
Declaration
public virtual Task<List<QTaskSummary>> RetrieveTaskSummariesByTagsAsync(List<string> tags, CancellationToken cancellationToken = default)Parameters
| Type | Name | Description |
|---|---|---|
| List<string> | tags | list of tags for task filtering. |
| CancellationToken | cancellationToken | Optional token to cancel the request. |
Returns
| Type | Description |
|---|---|
| Task<List<QTaskSummary>> | A list of tasks. |
RetrieveTaskSummaryByName(string, CancellationToken)
Retrieve a task summary by its name.
Declaration
[Obsolete("RetrieveTaskSummaryByName is deprecated, please use RetrieveTaskSummaryByShortnameAsync instead.")]
public virtual QTaskSummary RetrieveTaskSummaryByName(string name, CancellationToken cancellationToken = default)Parameters
| Type | Name | Description |
|---|---|---|
| string | name | Name of the task to find. |
| CancellationToken | cancellationToken | Optional token to cancel the request. |
Returns
| Type | Description |
|---|---|
| QTaskSummary | The task summary object for that name or null if it hasn't been found. |
RetrieveTaskSummaryByNameAsync(string, CancellationToken)
Retrieve a task summary by its name.
Declaration
[Obsolete("RetrieveTaskSummaryByNameAsync is deprecated, please use RetrieveTaskSummaryByShortnameAsync instead.")]
public virtual Task<QTaskSummary> RetrieveTaskSummaryByNameAsync(string name, CancellationToken cancellationToken = default)Parameters
| Type | Name | Description |
|---|---|---|
| string | name | Name of the task to find. |
| CancellationToken | cancellationToken | Optional token to cancel the request. |
Returns
| Type | Description |
|---|---|
| Task<QTaskSummary> | The task object for that name or null if it hasn't been found. |
RetrieveTaskSummaryByShortnameAsync(string, CancellationToken)
Retrieve a task summary by its shortname.
Declaration
public virtual Task<QTaskSummary> RetrieveTaskSummaryByShortnameAsync(string shortname, CancellationToken cancellationToken = default)Parameters
| Type | Name | Description |
|---|---|---|
| string | shortname | Shortname of the task summary to find, if the task shortname has not bean set, the shortname is equivalent to the uuid. |
| CancellationToken | cancellationToken | Optional token to cancel the request. |
Returns
| Type | Description |
|---|---|
| Task<QTaskSummary> | The task summary object for that shortname or null if it hasn't been found. |
RetrieveTaskSummaryByUuid(string, CancellationToken)
Retrieve a task summary by its uuid.
Declaration
[Obsolete("RetrieveTaskSummaryByUuid is deprecated, please use RetrieveTaskSummaryByUuidAsync instead.")]
public virtual QTaskSummary RetrieveTaskSummaryByUuid(string uuid, CancellationToken cancellationToken = default)Parameters
| Type | Name | Description |
|---|---|---|
| string | uuid | uuid of the task summary to find. |
| CancellationToken | cancellationToken | Optional token to cancel the request. |
Returns
| Type | Description |
|---|---|
| QTaskSummary | The task summary object for that uuid or null if it hasn't been found. |
RetrieveTaskSummaryByUuidAsync(string, CancellationToken)
Retrieve a task summary by its uuid.
Declaration
public virtual Task<QTaskSummary> RetrieveTaskSummaryByUuidAsync(string uuid, CancellationToken cancellationToken = default)Parameters
| Type | Name | Description |
|---|---|---|
| string | uuid | uuid of the task summary to find. |
| CancellationToken | cancellationToken | Optional token to cancel the request. |
Returns
| Type | Description |
|---|---|
| Task<QTaskSummary> | The task summary object for that uuid or null if it hasn't been found. |
RetrieveTasks(QDataDetail<QTask>, CancellationToken)
Retrieve the tasks list with custom filtering.
Declaration
[Obsolete("RetrieveTasks is deprecated, please use RetrieveTasksAsync instead.")]
public virtual List<QTask> RetrieveTasks(QDataDetail<QTask> level, CancellationToken cancellationToken = default)Parameters
| Type | Name | Description |
|---|---|---|
| QDataDetail<QTask> | level | the qtask filter object |
| CancellationToken | cancellationToken | Optional token to cancel the request. |
Returns
| Type | Description |
|---|---|
| List<QTask> | A list of tasks. |
RetrieveTasks(bool, CancellationToken)
Retrieve the tasks list. (deprecated)
Declaration
[Obsolete("RetrieveTasks is deprecated, please use RetrieveTasksAsync instead.")]
public virtual List<QTask> RetrieveTasks(bool summary, CancellationToken cancellationToken = default)Parameters
| Type | Name | Description |
|---|---|---|
| bool | summary | Obsolete params to get a summary version of a task. |
| CancellationToken | cancellationToken | Optional token to cancel the request. |
Returns
| Type | Description |
|---|---|
| List<QTask> | A list of tasks. |
RetrieveTasks(CancellationToken)
Retrieve the list of tasks.
Declaration
[Obsolete("RetrieveTasks is deprecated, please use RetrieveTasksAsync instead.")]
public virtual List<QTask> RetrieveTasks(CancellationToken cancellationToken = default)Parameters
| Type | Name | Description |
|---|---|---|
| CancellationToken | cancellationToken | Optional token to cancel the request. |
Returns
| Type | Description |
|---|---|
| List<QTask> | A list of tasks. |
RetrieveTasksAsync(QDataDetail<QTask>, CancellationToken)
Retrieve the tasks list with custom filtering.
Declaration
public virtual Task<List<QTask>> RetrieveTasksAsync(QDataDetail<QTask> level, CancellationToken cancellationToken = default)Parameters
| Type | Name | Description |
|---|---|---|
| QDataDetail<QTask> | level | the qtask filter object |
| CancellationToken | cancellationToken | Optional token to cancel the request. |
Returns
| Type | Description |
|---|---|
| Task<List<QTask>> | A list of tasks. |
RetrieveTasksAsync(bool, CancellationToken)
Retrieve the tasks list. (deprecated)
Declaration
public virtual Task<List<QTask>> RetrieveTasksAsync(bool summary, CancellationToken cancellationToken = default)Parameters
| Type | Name | Description |
|---|---|---|
| bool | summary | Obsolete params to get a summary version of a task. |
| CancellationToken | cancellationToken | Optional token to cancel the request. |
Returns
| Type | Description |
|---|---|
| Task<List<QTask>> | A list of tasks. |
RetrieveTasksAsync(CancellationToken)
Retrieve the tasks list.
Declaration
public virtual Task<List<QTask>> RetrieveTasksAsync(CancellationToken cancellationToken = default)Parameters
| Type | Name | Description |
|---|---|---|
| CancellationToken | cancellationToken | Optional token to cancel the request. |
Returns
| Type | Description |
|---|---|
| Task<List<QTask>> | A list of tasks. |
RetrieveTasksByNameAsync(string, CancellationToken)
Retrieve a task list by there name.
Declaration
public virtual Task<List<QTask>> RetrieveTasksByNameAsync(string name, CancellationToken cancellationToken = default)Parameters
| Type | Name | Description |
|---|---|---|
| string | name | Name of the tasks to find. |
| CancellationToken | cancellationToken | Optional token to cancel the request. |
Returns
| Type | Description |
|---|---|
| Task<List<QTask>> | The task list for that name. |
RetrieveTasksByTags(List<string>, CancellationToken)
Retrieve the list of tasks filtered by tags.
Declaration
[Obsolete("RetrieveTasksByTags is deprecated, please use RetrieveTasksByTagsAsync instead.")]
public virtual List<QTask> RetrieveTasksByTags(List<string> tags, CancellationToken cancellationToken = default)Parameters
| Type | Name | Description |
|---|---|---|
| List<string> | tags | list of tags for task filtering. |
| CancellationToken | cancellationToken | Optional token to cancel the request. |
Returns
| Type | Description |
|---|---|
| List<QTask> | A list of tasks. |
RetrieveTasksByTagsAsync(List<string>, CancellationToken)
Retrieve the tasks list filtered by tags.
Declaration
public virtual Task<List<QTask>> RetrieveTasksByTagsAsync(List<string> tags, CancellationToken cancellationToken = default)Parameters
| Type | Name | Description |
|---|---|---|
| List<string> | tags | list of tags for task filtering. |
| CancellationToken | cancellationToken | Optional token to cancel the request. |
Returns
| Type | Description |
|---|---|
| Task<List<QTask>> | A list of tasks. |
RetrieveUserHardwareConstraintsAsync(CancellationToken)
Retrieve all available hardware constraints.
Declaration
public virtual Task<IEnumerable<HardwareConstraint>> RetrieveUserHardwareConstraintsAsync(CancellationToken cancellationToken = default)Parameters
| Type | Name | Description |
|---|---|---|
| CancellationToken | cancellationToken | Optional token to cancel the request. |
Returns
| Type | Description |
|---|---|
| Task<IEnumerable<HardwareConstraint>> | The user hardware constraints list. |
RetrieveUserHardwareConstraintsPageAsync(OffsetPageRequest, CancellationToken)
Retrieve a page of your user available hardware constraints.
Declaration
public virtual Task<OffsetPageResponse<HardwareConstraint>> RetrieveUserHardwareConstraintsPageAsync(OffsetPageRequest pageOffset, CancellationToken cancellationToken = default)Parameters
| Type | Name | Description |
|---|---|---|
| OffsetPageRequest | pageOffset | Response page limitation details |
| CancellationToken | cancellationToken | Optional token to cancel the request. |
Returns
| Type | Description |
|---|---|
| Task<OffsetPageResponse<HardwareConstraint>> | The complete user hardware constraints list. |
RetrieveUserInformation(bool, CancellationToken)
Retrieve the user quotas and buckets information for your account. Note: BucketCount field is retrieved with a second request to the bucket Api.
Declaration
[Obsolete("RetrieveUserInformation is deprecated, please use RetrieveUserInformationAsync instead.")]
public virtual UserInformation RetrieveUserInformation(bool retrieveBucketCount, CancellationToken cancellationToken = default)Parameters
| Type | Name | Description |
|---|---|---|
| bool | retrieveBucketCount | If set to false, the BucketCount field is not filled but the request is faster. |
| CancellationToken | cancellationToken | Optional token to cancel the request. |
Returns
| Type | Description |
|---|---|
| UserInformation | The quotas and buckets information without BucketCount. |
RetrieveUserInformation(CancellationToken)
Retrieve the user quotas and buckets information for your account.
Declaration
[Obsolete("RetrieveUserInformation is deprecated, please use RetrieveUserInformationAsync instead.")]
public virtual UserInformation RetrieveUserInformation(CancellationToken cancellationToken = default)Parameters
| Type | Name | Description |
|---|---|---|
| CancellationToken | cancellationToken | Optional token to cancel the request. |
Returns
| Type | Description |
|---|---|
| UserInformation | The quotas and buckets information. |
RetrieveUserInformationAsync(bool, CancellationToken)
Retrieve the user quotas and buckets information for your account. Note: BucketCount field is retrieved with a second request to the bucket Api.
Declaration
public virtual Task<UserInformation> RetrieveUserInformationAsync(bool retrieveBucketCount, CancellationToken cancellationToken = default)Parameters
| Type | Name | Description |
|---|---|---|
| bool | retrieveBucketCount | If set to false, the BucketCount field is not filled but the request is faster. |
| CancellationToken | cancellationToken | Optional token to cancel the request. |
Returns
| Type | Description |
|---|---|
| Task<UserInformation> | The quotas and buckets information without BucketCount. |
RetrieveUserInformationAsync(CancellationToken)
Retrieve the user quotas information for your account.
Declaration
public virtual Task<UserInformation> RetrieveUserInformationAsync(CancellationToken cancellationToken = default)Parameters
| Type | Name | Description |
|---|---|---|
| CancellationToken | cancellationToken | Optional token to cancel the request. |
Returns
| Type | Description |
|---|---|
| Task<UserInformation> | The quotas and buckets information. |
SearchCpuModelConstraints(string, CancellationToken)
Search for CPU Model constraints matching a given CPU model search term.
Declaration
public virtual Task<IEnumerable<CpuModelHardware>> SearchCpuModelConstraints(string cpuModel, CancellationToken cancellationToken = default)Parameters
| Type | Name | Description |
|---|---|---|
| string | cpuModel | Search term to be used to match constraints |
| CancellationToken | cancellationToken | Optional token to cancel the request. |
Returns
| Type | Description |
|---|---|
| Task<IEnumerable<CpuModelHardware>> | Matching CPU model constraints, ordered by relevancy. |
SubmitTasks(List<QTask>, CancellationToken)
Submit a list of task as a bulk.
Declaration
[Obsolete("SubmitTasks is deprecated, please use SubmitTasksAsync instead.")]
public virtual void SubmitTasks(List<QTask> tasks, CancellationToken cancellationToken = default)Parameters
| Type | Name | Description |
|---|---|---|
| List<QTask> | tasks | The task list to submit as a bulk. |
| CancellationToken | cancellationToken | Optional token to cancel the request. |
SubmitTasksAsync(List<QTask>, CancellationToken)
Submit a list of task as a bulk.
Declaration
public virtual Task SubmitTasksAsync(List<QTask> tasks, CancellationToken cancellationToken = default)Parameters
| Type | Name | Description |
|---|---|---|
| List<QTask> | tasks | The task list to submit as a bulk. |
| CancellationToken | cancellationToken | Optional token to cancel the request. |
Returns
| Type | Description |
|---|---|
| Task | void. |