Class QTaskSummary

This class manages tasks life cycle: submission, monitor, delete.

Inheritance
object
AQTask
QTaskSummary
Inherited Members
Namespace: QarnotSDK
Assembly: QarnotSDK.dll
Syntax
public class QTaskSummary : AQTask

Properties

Completed

True if the task is completed or false if the task is still running or deploying.

Declaration
public virtual bool Completed { get; }
Property Value
Type Description
bool

CreationDate

The task creation date. Available only after the submission.

Declaration
public virtual DateTime CreationDate { get; }
Property Value
Type Description
DateTime

Executing

True if the task is executing (PartiallyExecuting or FullyExecuting) or false if the task is in another state.

Declaration
public virtual bool Executing { get; }
Property Value
Type Description
bool

InstanceCount

How many times this task have to run.

Declaration
public virtual uint InstanceCount { get; }
Property Value
Type Description
uint

Instances

Enumeration on the task instance ids. Useful if an advanced range is used.

Declaration
public virtual IEnumerable<uint> Instances { get; }
Property Value
Type Description
IEnumerable<uint>

Name

The task name.

Declaration
public virtual string Name { get; }
Property Value
Type Description
string

Pool

The pool where the task is running or null if the task doesn't belong to a pool.

Declaration
public virtual QPool Pool { get; }
Property Value
Type Description
QPool

Profile

The task profile.

Declaration
public virtual string Profile { get; }
Property Value
Type Description
string

Shortname

The task 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 task state (see QTaskStates). Available only after the submission.

Declaration
public virtual string State { get; }
Property Value
Type Description
string

WaitForPoolResourcesSynchronization

Queue in-pool task execution behind pool resources update.

Declaration
public virtual bool? WaitForPoolResourcesSynchronization { get; }
Property Value
Type Description
bool?
Remarks

For an in-pool task, if set to true, any task submitted after a pool resources update will be sure to see the newer pool resources during its execution. The task will be queued until a pool slot with recent enough resources is available. Setting this to false will deactivate this behavior. If left null, then the pool's TaskDefaultWaitForPoolResourcesSynchronization value will be used. If both are null, then it will default to false.

See Also

Methods

Delete(CancellationToken, bool, bool, bool)

Delete the task. If the task is running, the task 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, bool purgeResults = false)
Parameters
Type Name Description
CancellationToken cancellationToken

Optional token to cancel the request.
bool failIfDoesntExist

If set to false and the task doesn't exist, no exception is thrown. Default is true.
bool purgeResources

Boolean to trigger all resource storages deletion. Default is false.
bool purgeResults

Boolean to trigger result storage deletion. Default is false.
Overrides

DeleteAsync(CancellationToken, bool, bool, bool)

Delete the task. If the task is running, the task is aborted and deleted.

Declaration
public override Task DeleteAsync(CancellationToken cancellationToken, bool failIfDoesntExist = false, bool purgeResources = false, bool purgeResults = false)
Parameters
Type Name Description
CancellationToken cancellationToken

Optional token to cancel the request.
bool failIfDoesntExist

If set to false and the task doesn't exist, no exception is thrown. Default is true.
bool purgeResources

Boolean to trigger all resource storages deletion. Default is false.
bool purgeResults

Boolean to trigger result storage deletion. Default is false.
Returns
Type Description
Task
Overrides

GetFullQTask(CancellationToken)

Get The Full Task from this task summary.

Optional token to cancel the request.
Declaration
[Obsolete("GetFullQTask is deprecated, please use GetFullQTaskAsync instead.")]
public virtual QTask GetFullQTask(CancellationToken ct = default)
Parameters
Type Name Description
CancellationToken ct
Returns
Type Description
QTask

GetFullQTaskAsync(CancellationToken)

Get The Full Task from this task summary.

Optional token to cancel the request.
Declaration
public virtual Task<QTask> GetFullQTaskAsync(CancellationToken ct = default)
Parameters
Type Name Description
CancellationToken ct
Returns
Type Description
Task<QTask>