Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ASRTask

Package version

interface

An interface representing ASRTask. Task of the Job.

Hierarchy

  • ASRTask

Index

Properties

Properties

Optional allowedActions

allowedActions: string[]
member

{string[]} [allowedActions] The state/actions applicable on this task.

Optional customDetails

customDetails: TaskTypeDetailsUnion
member

{TaskTypeDetailsUnion} [customDetails] The custom task details based on the task type.

Optional endTime

endTime: Date
member

{Date} [endTime] The end time.

Optional errors

errors: JobErrorDetails[]
member

{JobErrorDetails[]} [errors] The task error details.

Optional friendlyName

friendlyName: undefined | string
member

{string} [friendlyName] The name.

Optional groupTaskCustomDetails

groupTaskCustomDetails: GroupTaskDetailsUnion
member

{GroupTaskDetailsUnion} [groupTaskCustomDetails] The custom task details based on the task type, if the task type is GroupTaskDetails or one of the types derived from it.

Optional name

name: undefined | string
member

{string} [name] The unique Task name.

Optional startTime

startTime: Date
member

{Date} [startTime] The start time.

Optional state

state: undefined | string
member

{string} [state] The State. It is one of these values - NotStarted, InProgress, Succeeded, Failed, Cancelled, Suspended or Other.

Optional stateDescription

stateDescription: undefined | string
member

{string} [stateDescription] The description of the task state. For example - For Succeeded state, description can be Completed, PartiallySucceeded, CompletedWithInformation or Skipped.

Optional taskId

taskId: undefined | string
member

{string} [taskId] The Id.

Optional taskType

taskType: undefined | string
member

{string} [taskType] The type of task. Details in CustomDetails property depend on this type.

Generated using TypeDoc