Skip to main content

Interface: Info

activity.Info

Holds information about the current Activity Execution. Retrieved inside an Activity with Context.current().info.

Properties

activityId

Readonly activityId: string


activityNamespace

Readonly activityNamespace: string

The namespace this Activity is running in


activityType

Readonly activityType: string

Exposed Activity function name


attempt

Readonly attempt: number

Attempt number for this activity


base64TaskToken

Readonly base64TaskToken: string

Base64 encoded taskToken


currentAttemptScheduledTimestampMs

Readonly currentAttemptScheduledTimestampMs: number

Timestamp for when the current attempt of this Activity was scheduled in milliseconds


heartbeatDetails

Readonly heartbeatDetails: any

The details from the last recorded heartbeat from the last attempt of this Activity.

Use this to resume your Activity from a checkpoint.


heartbeatTimeoutMs

Optional Readonly heartbeatTimeoutMs: number

Heartbeat timeout in milliseconds. If this timeout is defined, the Activity must heartbeat before the timeout is reached. The Activity must not heartbeat in case this timeout is not defined.


isLocal

Readonly isLocal: boolean

Whether this activity is scheduled in local or remote mode


scheduleToCloseTimeoutMs

Readonly scheduleToCloseTimeoutMs: number

Timeout for this Activity from schedule to close in milliseconds.


scheduledTimestampMs

Readonly scheduledTimestampMs: number

Timestamp for when this Activity was scheduled in milliseconds


startToCloseTimeoutMs

Readonly startToCloseTimeoutMs: number

Timeout for this Activity from start to close in milliseconds


taskQueue

Readonly taskQueue: string

Task Queue the Activity is scheduled in.

For Local Activities, this is set to the Workflow's Task Queue.


taskToken

Readonly taskToken: Uint8Array


workflowExecution

Readonly workflowExecution: Object

Information about the Workflow that scheduled the Activity

Type declaration

NameType
runIdstring
workflowIdstring

workflowNamespace

Readonly workflowNamespace: string

The namespace of the Workflow that scheduled this Activity


workflowType

Readonly workflowType: string

The module name of the Workflow that scheduled this Activity