Class: PendingActivityInfo
workflow.v1.PendingActivityInfo
Represents a PendingActivityInfo.
Implements
Constructors
constructor
• new PendingActivityInfo(properties?): PendingActivityInfo
Constructs a new PendingActivityInfo.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IPendingActivityInfo | Properties to set |
Returns
Properties
activityId
• activityId: string
PendingActivityInfo activityId.
Implementation of
IPendingActivityInfo.activityId
activityType
• Optional activityType: null | IActivityType
PendingActivityInfo activityType.
Implementation of
IPendingActivityInfo.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.
attempt
• attempt: number
PendingActivityInfo attempt.
Implementation of
expirationTime
• Optional expirationTime: null | ITimestamp
PendingActivityInfo expirationTime.
Implementation of
IPendingActivityInfo.expirationTime
heartbeatDetails
• Optional heartbeatDetails: null | IPayloads
PendingActivityInfo heartbeatDetails.
Implementation of
IPendingActivityInfo.heartbeatDetails
lastFailure
• Optional lastFailure: null | IFailure
PendingActivityInfo lastFailure.
Implementation of
IPendingActivityInfo.lastFailure
lastHeartbeatTime
• Optional lastHeartbeatTime: null | ITimestamp
PendingActivityInfo lastHeartbeatTime.
Implementation of
IPendingActivityInfo.lastHeartbeatTime
lastIndependentlyAssignedBuildId
• Optional lastIndependentlyAssignedBuildId: null | string
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.
Implementation of
IPendingActivityInfo.lastIndependentlyAssignedBuildId
lastStartedTime
• Optional lastStartedTime: null | ITimestamp
PendingActivityInfo lastStartedTime.
Implementation of
IPendingActivityInfo.lastStartedTime
lastWorkerIdentity
• lastWorkerIdentity: string
PendingActivityInfo lastWorkerIdentity.
Implementation of
IPendingActivityInfo.lastWorkerIdentity
lastWorkerVersionStamp
• Optional lastWorkerVersionStamp: null | IWorkerVersionStamp
The version stamp of the worker to whom this activity was most recently dispatched
Implementation of
IPendingActivityInfo.lastWorkerVersionStamp
maximumAttempts
• maximumAttempts: number
PendingActivityInfo maximumAttempts.
Implementation of
IPendingActivityInfo.maximumAttempts
scheduledTime
• Optional scheduledTime: null | ITimestamp
PendingActivityInfo scheduledTime.
Implementation of
IPendingActivityInfo.scheduledTime
state
• state: PendingActivityState
PendingActivityInfo state.
Implementation of
useWorkflowBuildId
• Optional useWorkflowBuildId: null | IEmpty
When present, it means this activity is assigned to the build ID of its workflow.
Implementation of
IPendingActivityInfo.useWorkflowBuildId
Methods
toJSON
▸ toJSON(): Object
Converts this PendingActivityInfo to JSON.
Returns
Object
JSON object
create
▸ create(properties?): PendingActivityInfo
Creates a new PendingActivityInfo instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IPendingActivityInfo | Properties to set |
Returns
PendingActivityInfo instance
decode
▸ decode(reader, length?): PendingActivityInfo
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
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 | IPendingActivityInfo | 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 | IPendingActivityInfo | 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
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for PendingActivityInfo
Parameters
| Name | Type | Description |
|---|---|---|
typeUrlPrefix? | string | your custom typeUrlPrefix(default "type.googleapis.com") |
Returns
string
The default type url
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