Class QPoolSummary
This class manages pools life cycle: submission, monitor, delete.
Inherited Members
Namespace: QarnotSDK
Assembly: QarnotSDK.dll
Syntax
public class QPoolSummary : AQPoolProperties
CreationDate
The pool creation date. Available only after the submission.
Declaration
public virtual DateTime CreationDate { get; }Property Value
| Type | Description |
|---|---|
| DateTime |
Name
The pool name.
Declaration
public virtual string Name { get; }Property Value
| Type | Description |
|---|---|
| string |
Profile
The pool profile.
Declaration
public virtual string Profile { get; }Property Value
| Type | Description |
|---|---|
| string |
QueuedOrRunningTaskInstancesCount
The count of task instances running or enqueued on this pool. Available only after the submission.
Declaration
public virtual int QueuedOrRunningTaskInstancesCount { get; }Property Value
| Type | Description |
|---|---|
| int |
Shortname
The pool shortname identifier. The shortname is provided by the user. It has to be unique.
Declaration
public virtual string Shortname { get; }Property Value
| Type | Description |
|---|---|
| string |
State
Retrieve the pool state (see QTaskStates). Available only after the submission.
Declaration
public virtual string State { get; }Property Value
| Type | Description |
|---|---|
| string |
TaskDefaultWaitForPoolResourcesSynchronization
Default value of WaitForPoolResourcesSynchronization for pool's tasks
Declaration
public virtual bool? TaskDefaultWaitForPoolResourcesSynchronization { get; }Property Value
| Type | Description |
|---|---|
| bool? |
Methods
Delete(CancellationToken, bool, bool)
Delete the pool. If the pool is running, the pool is aborted and deleted.
Declaration
[Obsolete("Delete is deprecated, please use DeleteAsync instead.")]
public override void Delete(CancellationToken cancellationToken, bool failIfDoesntExist = false, bool purgeResources = false)Parameters
| Type | Name | Description |
|---|---|---|
| CancellationToken | cancellationToken | Optional token to cancel the request. |
| bool | failIfDoesntExist | If set to false and the pool doesn't exist, no exception is thrown. Default is true. |
| bool | purgeResources | Boolean to trigger all resource storages deletion. Default is false. |
Overrides
DeleteAsync(CancellationToken, bool, bool)
Delete the pool. If the pool is running, the pool is aborted and deleted.
Declaration
public override Task DeleteAsync(CancellationToken cancellationToken, bool failIfDoesntExist = false, bool purgeResources = false)Parameters
| Type | Name | Description |
|---|---|---|
| CancellationToken | cancellationToken | Optional token to cancel the request. |
| bool | failIfDoesntExist | If set to false and the pool doesn't exist, no exception is thrown. Default is true. |
| bool | purgeResources | Boolean to trigger all resource storages deletion. Default is false. |
Returns
| Type | Description |
|---|---|
| Task |
Overrides
GetFullQPool(CancellationToken)
Get The Full Pool from this task summary.
Optional token to cancel the request.Declaration
[Obsolete("GetFullQPool is deprecated, please use GetFullQPoolAsync instead.")]
public virtual QPool GetFullQPool(CancellationToken ct = default)Parameters
| Type | Name | Description |
|---|---|---|
| CancellationToken | ct |
Returns
| Type | Description |
|---|---|
| QPool |
GetFullQPoolAsync(CancellationToken)
Get The Full Pool from this pool summary.
Optional token to cancel the request.Declaration
public virtual Task<QPool> GetFullQPoolAsync(CancellationToken ct = default)Parameters
| Type | Name | Description |
|---|---|---|
| CancellationToken | ct |
Returns
| Type | Description |
|---|---|
| Task<QPool> |