Class: PendingWorkflowTaskInfo
workflow.v1.PendingWorkflowTaskInfo
Represents a PendingWorkflowTaskInfo.
Properties
attempt
• attempt: number
PendingWorkflowTaskInfo attempt.
originalScheduledTime
• Optional originalScheduledTime: null | $Properties
original_scheduled_time is the scheduled time of the first workflow task during workflow task heartbeat. Heartbeat workflow task is done by RespondWorkflowTaskComplete with ForceCreateNewWorkflowTask == true and no command In this case, OriginalScheduledTime won't change. Then when current time - original_scheduled_time exceeds some threshold, the workflow task will be forced timeout.
scheduledTime
• Optional scheduledTime: null | $Properties
PendingWorkflowTaskInfo scheduledTime.
startedTime
• Optional startedTime: null | $Properties
PendingWorkflowTaskInfo startedTime.
state
• state: PendingWorkflowTaskState
PendingWorkflowTaskInfo state.
Methods
toJSON
▸ toJSON(): Object
Converts this PendingWorkflowTaskInfo to JSON.
Returns
Object
JSON object
create
▸ create(properties?): PendingWorkflowTaskInfo & $Properties
Creates a new PendingWorkflowTaskInfo instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Properties | Properties to set |
Returns
PendingWorkflowTaskInfo & $Properties
PendingWorkflowTaskInfo instance
▸ create(properties?): PendingWorkflowTaskInfo
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
decode
▸ decode(reader, length?): PendingWorkflowTaskInfo & $Properties
Decodes a PendingWorkflowTaskInfo 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
PendingWorkflowTaskInfo & $Properties
PendingWorkflowTaskInfo
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): PendingWorkflowTaskInfo & $Properties
Decodes a PendingWorkflowTaskInfo message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
PendingWorkflowTaskInfo & $Properties
PendingWorkflowTaskInfo
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 PendingWorkflowTaskInfo message. Does not implicitly temporal.api.workflow.v1.PendingWorkflowTaskInfo.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | PendingWorkflowTaskInfo message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified PendingWorkflowTaskInfo message, length delimited. Does not implicitly temporal.api.workflow.v1.PendingWorkflowTaskInfo.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | PendingWorkflowTaskInfo message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): PendingWorkflowTaskInfo
Creates a PendingWorkflowTaskInfo message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
PendingWorkflowTaskInfo
toObject
▸ toObject(message, options?): Object
Creates a plain object from a PendingWorkflowTaskInfo message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | PendingWorkflowTaskInfo | PendingWorkflowTaskInfo |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object