Package version:

Interface ASRTask

Task of the Job.

interface ASRTask {
    allowedActions?: string[];
    customDetails?: TaskTypeDetailsUnion;
    endTime?: any;
    errors?: JobErrorDetails[];
    friendlyName?: string;
    groupTaskCustomDetails?: GroupTaskDetailsUnion;
    name?: string;
    startTime?: any;
    state?: string;
    stateDescription?: string;
    taskId?: string;
    taskType?: string;
}

Properties

allowedActions? customDetails? endTime? errors? friendlyName? groupTaskCustomDetails? name? startTime? state? stateDescription? taskId? taskType?

Properties

OptionalallowedActions

allowedActions?: string[]

The state/actions applicable on this task.

OptionalcustomDetails

customDetails?: TaskTypeDetailsUnion

The custom task details based on the task type.

OptionalendTime

endTime?: any

The end time.

Optionalerrors

errors?: JobErrorDetails[]

The task error details.

OptionalfriendlyName

friendlyName?: string

The name.

OptionalgroupTaskCustomDetails

groupTaskCustomDetails?: GroupTaskDetailsUnion

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

Optionalname

name?: string

The unique Task name.

OptionalstartTime

startTime?: any

The start time.

Optionalstate

state?: string

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

OptionalstateDescription

stateDescription?: string

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

OptionaltaskId

taskId?: string

The Id.

OptionaltaskType

taskType?: string

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

Settings

Member Visibility