Skip to main content

Interface: ActivityExecutionDescription

Return type of ActivityClient.describe

Extends​

Properties​

activityId​

activityId: string

Inherited from​

ActivityExecutionInfo.activityId

activityRunId​

activityRunId: string

Inherited from​

ActivityExecutionInfo.activityRunId

activityType​

activityType: string

Inherited from​

ActivityExecutionInfo.activityType

attempt​

attempt: number

canceledReason?​

optional canceledReason?: string

closeTime?​

optional closeTime?: Date

Inherited from​

ActivityExecutionInfo.closeTime

currentRetryIntervalMs?​

optional currentRetryIntervalMs?: number

executionDurationMs?​

optional executionDurationMs?: number

Inherited from​

ActivityExecutionInfo.executionDurationMs

executionTime?​

optional executionTime?: Date

Inherited from​

ActivityExecutionInfo.executionTime

expirationTime?​

optional expirationTime?: Date

hasHeartbeatDetails​

hasHeartbeatDetails: boolean

True if heartbeat details are available. Always false if import('activity-client').ActivityDescribeOptions.includeHeartbeatDetails was false.

hasInput​

hasInput: boolean

True if activity input is available. Always false if import('activity-client').ActivityDescribeOptions.includeInput was false.

hasLastFailure​

hasLastFailure: boolean

True if last failure is available. Always false if import('activity-client').ActivityDescribeOptions.includeLastFailure was false.

hasOutcomeFailure​

hasOutcomeFailure: boolean

True if outcome failure is available. The activity must have closed with a failure for outcome failure to be available. Always false if import('activity-client').ActivityDescribeOptions.includeOutcome was false.

hasResult​

hasResult: boolean

True if activity result is available. The activity must have completed successfully for result to be available. Always false if import('activity-client').ActivityDescribeOptions.includeOutcome was false.

heartbeatTimeoutMs?​

optional heartbeatTimeoutMs?: number

lastAttemptCompleteTime?​

optional lastAttemptCompleteTime?: Date

lastDeploymentVersion?​

optional lastDeploymentVersion?: WorkerDeploymentVersion

lastHeartbeatTime?​

optional lastHeartbeatTime?: Date

lastStartedTime?​

optional lastStartedTime?: Date

lastWorkerIdentity?​

optional lastWorkerIdentity?: string

nextAttemptScheduleTime?​

optional nextAttemptScheduleTime?: Date

priority​

priority: Priority

rawCallbacks​

rawCallbacks: RawActivityExecutionCallbacks

rawInfo​

rawInfo: IActivityExecutionInfo

rawListInfo?​

optional rawListInfo?: IActivityExecutionListInfo

Inherited from​

ActivityExecutionInfo.rawListInfo

retryPolicy​

retryPolicy: RetryPolicy

runState?​

optional runState?: PendingActivityState

scheduleTime?​

optional scheduleTime?: Date

Inherited from​

ActivityExecutionInfo.scheduleTime

scheduleToCloseTimeoutMs?​

optional scheduleToCloseTimeoutMs?: number

scheduleToStartTimeoutMs?​

optional scheduleToStartTimeoutMs?: number

startDelayMs?​

optional startDelayMs?: number

startToCloseTimeoutMs?​

optional startToCloseTimeoutMs?: number

status​

status: ActivityExecutionStatus

Inherited from​

ActivityExecutionInfo.status

taskQueue​

taskQueue: string

Inherited from​

ActivityExecutionInfo.taskQueue

totalHeartbeatCount?​

optional totalHeartbeatCount?: number

typedSearchAttributes​

typedSearchAttributes: TypedSearchAttributes

Inherited from​

ActivityExecutionInfo.typedSearchAttributes

Methods​

getHeartbeatDetails()​

getHeartbeatDetails<T>(): Promise<T | undefined>

Deserializes heartbeat details. Returns undefined if heartbeat details are unavailable. Always returns undefined if import('activity-client').ActivityDescribeOptions.includeHeartbeatDetails was false.

Type Parameters​

T​

T = any

Returns​

Promise<T | undefined>

getInput()​

getInput<T>(): Promise<T | undefined>

Deserializes activity input. Returns undefined if input is unavailable. Always returns undefined if import('activity-client').ActivityDescribeOptions.includeInput was false.

Type Parameters​

T​

T extends any[] = any[]

Returns​

Promise<T | undefined>

getLastFailure()​

getLastFailure(): Promise<Error | undefined>

Deserializes last failure. Returns undefined if last failure is unavailable. Always returns undefined if import('activity-client').ActivityDescribeOptions.includeLastFailure was false.

Returns​

Promise<Error | undefined>

getOutcomeFailure()​

getOutcomeFailure(): Promise<Error | undefined>

Deserializes heartbeat details. Returns undefined if heartbeat details are unavailable. The activity must have closed with a failure for outcome failure to be available. Always returns undefined if import('activity-client').ActivityDescribeOptions.includeOutcome was false.

Returns​

Promise<Error | undefined>

getResult()​

getResult<T>(): Promise<T | undefined>

Deserializes activity result. Returns undefined if result is unavailable. The activity must have completed successfully for result to be available. Always returns undefined if import('activity-client').ActivityDescribeOptions.includeOutcome was false.

Type Parameters​

T​

T = any

Returns​

Promise<T | undefined>