ASRTask interface

Task of the Job.

Properties

allowedActions

The state/actions applicable on this task.

customDetails

The custom task details based on the task type.

endTime

The end time.

errors

The task error details.

friendlyName

The name.

groupTaskCustomDetails

The custom task details based on the task type, if the task type is GroupTaskDetails or one of the types derived from it.

name

The unique Task name.

startTime

The start time.

state

The State. It is one of these values - NotStarted, InProgress, Succeeded, Failed, Cancelled, Suspended or Other.

stateDescription

The description of the task state. For example - For Succeeded state, description can be Completed, PartiallySucceeded, CompletedWithInformation or Skipped.

taskId

The Id.

taskType

The type of task. Details in CustomDetails property depend on this type.

Property Details

allowedActions

The state/actions applicable on this task.

allowedActions?: string[]

Property Value

string[]

customDetails

The custom task details based on the task type.

customDetails?: TaskTypeDetailsUnion

Property Value

endTime

The end time.

endTime?: Date

Property Value

Date

errors

The task error details.

errors?: JobErrorDetails[]

Property Value

friendlyName

The name.

friendlyName?: string

Property Value

string

groupTaskCustomDetails

The custom task details based on the task type, if the task type is GroupTaskDetails or one of the types derived from it.

groupTaskCustomDetails?: GroupTaskDetailsUnion

Property Value

name

The unique Task name.

name?: string

Property Value

string

startTime

The start time.

startTime?: Date

Property Value

Date

state

The State. It is one of these values - NotStarted, InProgress, Succeeded, Failed, Cancelled, Suspended or Other.

state?: string

Property Value

string

stateDescription

The description of the task state. For example - For Succeeded state, description can be Completed, PartiallySucceeded, CompletedWithInformation or Skipped.

stateDescription?: string

Property Value

string

taskId

The Id.

taskId?: string

Property Value

string

taskType

The type of task. Details in CustomDetails property depend on this type.

taskType?: string

Property Value

string