Class: PendingActivityInfo
workflow.v1.PendingActivityInfo
Represents a PendingActivityInfo.
Properties
activityId
• activityId: string
PendingActivityInfo activityId.
activityOptions
• Optional activityOptions: null | $Properties
Current activity options. May be different from the one used to start the activity.
activityType
• Optional activityType: null | $Properties
PendingActivityInfo 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]
attempt
• attempt: number
PendingActivityInfo 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.
expirationTime
• Optional expirationTime: null | $Properties
PendingActivityInfo expirationTime.
heartbeatDetails
• Optional heartbeatDetails: null | $Properties
PendingActivityInfo 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.
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.
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.
lastFailure
• Optional lastFailure: null | $Properties
PendingActivityInfo lastFailure.
lastHeartbeatTime
• Optional lastHeartbeatTime: null | $Properties
PendingActivityInfo 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.
lastStartedTime
• Optional lastStartedTime: null | $Properties
PendingActivityInfo lastStartedTime.
lastWorkerDeploymentVersion
• lastWorkerDeploymentVersion: string
The Worker Deployment Version this activity was dispatched to most recently.
Deprecated. Use last_deployment_version.
lastWorkerIdentity
• lastWorkerIdentity: string
PendingActivityInfo 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]
maximumAttempts
• maximumAttempts: number
PendingActivityInfo maximumAttempts.
nextAttemptScheduleTime
• Optional nextAttemptScheduleTime: null | $Properties
Next time when activity will be scheduled. If activity is currently scheduled or started it will be null.
pauseInfo
• Optional pauseInfo: null | $Properties
PendingActivityInfo pauseInfo.
paused
• paused: boolean
Indicates if activity is 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.
scheduledTime
• Optional scheduledTime: null | $Properties
PendingActivityInfo scheduledTime.
state
• state: PendingActivityState
PendingActivityInfo state.
useWorkflowBuildId
• Optional useWorkflowBuildId: null | $Properties
Deprecated. When present, it means this activity is assigned to the build ID of its workflow.
Methods
toJSON
▸ toJSON(): Object
Converts this PendingActivityInfo to JSON.
Returns
Object
JSON object
create
▸ create(properties?): PendingActivityInfo & $Shape
Creates a new PendingActivityInfo instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Shape | Properties to set |
Returns
PendingActivityInfo instance
▸ create(properties?): PendingActivityInfo
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
decode
▸ decode(reader, length?): PendingActivityInfo & $Shape
Decodes a PendingActivityInfo message from the specified reader or buffer.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
length? | number | Message length if known beforehand |
Returns
PendingActivityInfo
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): PendingActivityInfo & $Shape
Decodes a PendingActivityInfo message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
PendingActivityInfo
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
encode
▸ encode(message, writer?): Writer
Encodes the specified PendingActivityInfo message. Does not implicitly temporal.api.workflow.v1.PendingActivityInfo.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | PendingActivityInfo message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified PendingActivityInfo message, length delimited. Does not implicitly temporal.api.workflow.v1.PendingActivityInfo.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | PendingActivityInfo message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): PendingActivityInfo
Creates a PendingActivityInfo message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
PendingActivityInfo
toObject
▸ toObject(message, options?): Object
Creates a plain object from a PendingActivityInfo message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | PendingActivityInfo | PendingActivityInfo |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object