Skip to main content

Interface: ActivityExecutionDescription

client.ActivityExecutionDescription

Return type of ActivityClient.describe

Hierarchy​

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<undefined | T>

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

Type parameters​

NameType
Tany

Returns​

Promise<undefined | T>

getInput​

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

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

Type parameters​

NameType
Textends any[] = any[]

Returns​

Promise<undefined | T>

getLastFailure​

▸ getLastFailure(): Promise<undefined | Error>

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

Returns​

Promise<undefined | Error>

getOutcomeFailure​

▸ getOutcomeFailure(): Promise<undefined | Error>

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<undefined | Error>

getResult​

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

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​

NameType
Tany

Returns​

Promise<undefined | T>