Skip to main content

Interface: IPendingActivityInfo

workflow.v1.IPendingActivityInfo

Properties of a PendingActivityInfo.

Hierarchy

Properties

activityId

Optional activityId: null | string

PendingActivityInfo activityId

Inherited from

$Properties.activityId


activityOptions

Optional activityOptions: null | $Properties

Current activity options. May be different from the one used to start the activity.

Inherited from

$Properties.activityOptions


activityType

Optional activityType: null | $Properties

PendingActivityInfo activityType

Inherited from

$Properties.activityType


assignedBuildId

Optional assignedBuildId: "useWorkflowBuildId" | "lastIndependentlyAssignedBuildId"

Absence of assigned_build_id generally means this task is on an "unversioned" task queue. In rare cases, it can also mean that the task queue is versioned but we failed to write activity's independently-assigned build ID to the database. This case heals automatically once the task is dispatched. Deprecated. This field should be cleaned up when versioning-2 API is removed. [cleanup-experimental-wv]

Inherited from

$Properties.assignedBuildId


attempt

Optional attempt: null | number

PendingActivityInfo attempt

Inherited from

$Properties.attempt


currentRetryInterval

Optional currentRetryInterval: null | $Properties

The time activity will wait until the next retry. If activity is currently running it will be next retry interval if activity failed. If activity is currently waiting it will be current retry interval. If there will be no retry it will be null.

Inherited from

$Properties.currentRetryInterval


expirationTime

Optional expirationTime: null | $Properties

PendingActivityInfo expirationTime

Inherited from

$Properties.expirationTime


heartbeatDetails

Optional heartbeatDetails: null | $Properties

PendingActivityInfo heartbeatDetails

Inherited from

$Properties.heartbeatDetails


lastAttemptCompleteTime

Optional lastAttemptCompleteTime: null | $Properties

The time when the last activity attempt was completed. If activity has not been completed yet then it will be null.

Inherited from

$Properties.lastAttemptCompleteTime


lastDeployment

Optional lastDeployment: null | $Properties

The deployment this activity was dispatched to most recently. Present only if the activity was dispatched to a versioned worker. Deprecated. Use last_deployment_version.

Inherited from

$Properties.lastDeployment


lastDeploymentVersion

Optional lastDeploymentVersion: null | $Properties

The Worker Deployment Version this activity was dispatched to most recently. If nil, the activity has not yet been dispatched or was last dispatched to an unversioned worker.

Inherited from

$Properties.lastDeploymentVersion


lastFailure

Optional lastFailure: null | $Properties

PendingActivityInfo lastFailure

Inherited from

$Properties.lastFailure


lastHeartbeatTime

Optional lastHeartbeatTime: null | $Properties

PendingActivityInfo lastHeartbeatTime

Inherited from

$Properties.lastHeartbeatTime


lastIndependentlyAssignedBuildId

Optional lastIndependentlyAssignedBuildId: null | string

Deprecated. This means the activity is independently versioned and not bound to the build ID of its workflow. The activity will use the build id in this field instead. If the task fails and is scheduled again, the assigned build ID may change according to the latest versioning rules.

Inherited from

$Properties.lastIndependentlyAssignedBuildId


lastStartedTime

Optional lastStartedTime: null | $Properties

PendingActivityInfo lastStartedTime

Inherited from

$Properties.lastStartedTime


lastWorkerDeploymentVersion

Optional lastWorkerDeploymentVersion: null | string

The Worker Deployment Version this activity was dispatched to most recently. Deprecated. Use last_deployment_version.

Inherited from

$Properties.lastWorkerDeploymentVersion


lastWorkerIdentity

Optional lastWorkerIdentity: null | string

PendingActivityInfo lastWorkerIdentity

Inherited from

$Properties.lastWorkerIdentity


lastWorkerVersionStamp

Optional lastWorkerVersionStamp: null | $Properties

Deprecated. The version stamp of the worker to whom this activity was most recently dispatched This field should be cleaned up when versioning-2 API is removed. [cleanup-experimental-wv]

Inherited from

$Properties.lastWorkerVersionStamp


maximumAttempts

Optional maximumAttempts: null | number

PendingActivityInfo maximumAttempts

Inherited from

$Properties.maximumAttempts


nextAttemptScheduleTime

Optional nextAttemptScheduleTime: null | $Properties

Next time when activity will be scheduled. If activity is currently scheduled or started it will be null.

Inherited from

$Properties.nextAttemptScheduleTime


pauseInfo

Optional pauseInfo: null | $Properties

PendingActivityInfo pauseInfo

Inherited from

$Properties.pauseInfo


paused

Optional paused: null | boolean

Indicates if activity is paused.

Inherited from

$Properties.paused


priority

Optional priority: null | $Properties

Priority metadata. If this message is not present, or any fields are not present, they inherit the values from the workflow.

Inherited from

$Properties.priority


scheduledTime

Optional scheduledTime: null | $Properties

PendingActivityInfo scheduledTime

Inherited from

$Properties.scheduledTime


state

Optional state: null | PendingActivityState

PendingActivityInfo state

Inherited from

$Properties.state


useWorkflowBuildId

Optional useWorkflowBuildId: null | $Properties

Deprecated. When present, it means this activity is assigned to the build ID of its workflow.

Inherited from

$Properties.useWorkflowBuildId