Class: WorkflowExecutionExtendedInfo
workflow.v1.WorkflowExecutionExtendedInfo
Holds all the extra information about workflow execution that is not part of Visibility.
Properties
cancelRequested
• cancelRequested: boolean
indicates if the workflow received a cancel request
executionExpirationTime
• Optional executionExpirationTime: null | $Properties
Workflow execution expiration time is defined as workflow start time plus expiration timeout. Workflow start time may change after workflow reset.
lastResetTime
• Optional lastResetTime: null | $Properties
Last workflow reset time. Nil if the workflow was never reset.
originalStartTime
• Optional originalStartTime: null | $Properties
Original workflow start time.
pauseInfo
• Optional pauseInfo: null | $Properties
Information about the workflow execution pause operation.
requestIdInfos
• requestIdInfos: Object
Request ID information (eg: history event information associated with the request ID). Note: It only contains request IDs from StartWorkflowExecution requests, including indirect calls (eg: if SignalWithStartWorkflowExecution starts a new workflow, then the request ID is used in the StartWorkflowExecution request).
Index signature
▪ [k: string]: $Properties
resetRunId
• resetRunId: string
Reset Run ID points to the new run when this execution is reset. If the execution is reset multiple times, it points to the latest run.
runExpirationTime
• Optional runExpirationTime: null | $Properties
Workflow run expiration time is defined as current workflow run start time plus workflow run timeout.
timeSkippingInfo
• Optional timeSkippingInfo: null | $Properties
Information about time skipping of the workflow execution. If the execution has never enabled time skipping, it will be nil.
Methods
toJSON
▸ toJSON(): Object
Converts this WorkflowExecutionExtendedInfo to JSON.
Returns
Object
JSON object
create
▸ create(properties?): WorkflowExecutionExtendedInfo & $Properties
Creates a new WorkflowExecutionExtendedInfo instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Properties | Properties to set |
Returns
WorkflowExecutionExtendedInfo & $Properties
WorkflowExecutionExtendedInfo instance
▸ create(properties?): WorkflowExecutionExtendedInfo
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
decode
▸ decode(reader, length?): WorkflowExecutionExtendedInfo & $Properties
Decodes a WorkflowExecutionExtendedInfo 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
WorkflowExecutionExtendedInfo & $Properties
WorkflowExecutionExtendedInfo
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): WorkflowExecutionExtendedInfo & $Properties
Decodes a WorkflowExecutionExtendedInfo message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
WorkflowExecutionExtendedInfo & $Properties
WorkflowExecutionExtendedInfo
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 WorkflowExecutionExtendedInfo message. Does not implicitly temporal.api.workflow.v1.WorkflowExecutionExtendedInfo.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | WorkflowExecutionExtendedInfo message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified WorkflowExecutionExtendedInfo message, length delimited. Does not implicitly temporal.api.workflow.v1.WorkflowExecutionExtendedInfo.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | WorkflowExecutionExtendedInfo message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): WorkflowExecutionExtendedInfo
Creates a WorkflowExecutionExtendedInfo message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
WorkflowExecutionExtendedInfo
toObject
▸ toObject(message, options?): Object
Creates a plain object from a WorkflowExecutionExtendedInfo message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | WorkflowExecutionExtendedInfo | WorkflowExecutionExtendedInfo |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object