Skip to main content

Interface: IPendingActivityInfo

Properties of a PendingActivityInfo.

Extends​

Properties​

activityId?​

optional activityId?: string | null

PendingActivityInfo activityId

Inherited from​

$Properties.activityId

activityOptions?​

optional activityOptions?: $Properties | null

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

Inherited from​

$Properties.activityOptions

activityType?​

optional activityType?: $Properties | null

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?: number | null

PendingActivityInfo attempt

Inherited from​

$Properties.attempt

currentRetryInterval?​

optional currentRetryInterval?: $Properties | null

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?: $Properties | null

PendingActivityInfo expirationTime

Inherited from​

$Properties.expirationTime

heartbeatDetails?​

optional heartbeatDetails?: $Properties | null

PendingActivityInfo heartbeatDetails

Inherited from​

$Properties.heartbeatDetails

lastAttemptCompleteTime?​

optional lastAttemptCompleteTime?: $Properties | null

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?: $Properties | null

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?: $Properties | null

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?: $Properties | null

PendingActivityInfo lastFailure

Inherited from​

$Properties.lastFailure

lastHeartbeatTime?​

optional lastHeartbeatTime?: $Properties | null

PendingActivityInfo lastHeartbeatTime

Inherited from​

$Properties.lastHeartbeatTime

lastIndependentlyAssignedBuildId?​

optional lastIndependentlyAssignedBuildId?: string | null

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?: $Properties | null

PendingActivityInfo lastStartedTime

Inherited from​

$Properties.lastStartedTime

lastWorkerDeploymentVersion?​

optional lastWorkerDeploymentVersion?: string | null

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

Inherited from​

$Properties.lastWorkerDeploymentVersion

lastWorkerIdentity?​

optional lastWorkerIdentity?: string | null

PendingActivityInfo lastWorkerIdentity

Inherited from​

$Properties.lastWorkerIdentity

lastWorkerVersionStamp?​

optional lastWorkerVersionStamp?: $Properties | null

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?: number | null

PendingActivityInfo maximumAttempts

Inherited from​

$Properties.maximumAttempts

nextAttemptScheduleTime?​

optional nextAttemptScheduleTime?: $Properties | null

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

Inherited from​

$Properties.nextAttemptScheduleTime

paused?​

optional paused?: boolean | null

Indicates if activity is paused.

Inherited from​

$Properties.paused

pauseInfo?​

optional pauseInfo?: $Properties | null

PendingActivityInfo pauseInfo

Inherited from​

$Properties.pauseInfo

priority?​

optional priority?: $Properties | null

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?: $Properties | null

PendingActivityInfo scheduledTime

Inherited from​

$Properties.scheduledTime

state?​

optional state?: PendingActivityState | null

PendingActivityInfo state

Inherited from​

$Properties.state

useWorkflowBuildId?​

optional useWorkflowBuildId?: $Properties | null

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

Inherited from​

$Properties.useWorkflowBuildId