Class: WorkflowExecutionInfo
workflow.v1.WorkflowExecutionInfo
Represents a WorkflowExecutionInfo.
Implements
Constructors
constructor
• new WorkflowExecutionInfo(properties?): WorkflowExecutionInfo
Constructs a new WorkflowExecutionInfo.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IWorkflowExecutionInfo | Properties to set |
Returns
Properties
autoResetPoints
• Optional autoResetPoints: null | IResetPoints
WorkflowExecutionInfo autoResetPoints.
Implementation of
IWorkflowExecutionInfo.autoResetPoints
closeTime
• Optional closeTime: null | ITimestamp
WorkflowExecutionInfo closeTime.
Implementation of
IWorkflowExecutionInfo.closeTime
execution
• Optional execution: null | IWorkflowExecution
WorkflowExecutionInfo execution.
Implementation of
IWorkflowExecutionInfo.execution
executionTime
• Optional executionTime: null | ITimestamp
WorkflowExecutionInfo executionTime.
Implementation of
IWorkflowExecutionInfo.executionTime
historyLength
• historyLength: Long
WorkflowExecutionInfo historyLength.
Implementation of
IWorkflowExecutionInfo.historyLength
historySizeBytes
• historySizeBytes: Long
WorkflowExecutionInfo historySizeBytes.
Implementation of
IWorkflowExecutionInfo.historySizeBytes
memo
• Optional memo: null | IMemo
WorkflowExecutionInfo memo.
Implementation of
mostRecentWorkerVersionStamp
• Optional mostRecentWorkerVersionStamp: null | IWorkerVersionStamp
If set, the most recent worker version stamp that appeared in a workflow task completion
Implementation of
IWorkflowExecutionInfo.mostRecentWorkerVersionStamp
parentExecution
• Optional parentExecution: null | IWorkflowExecution
WorkflowExecutionInfo parentExecution.
Implementation of
IWorkflowExecutionInfo.parentExecution
parentNamespaceId
• parentNamespaceId: string
WorkflowExecutionInfo parentNamespaceId.
Implementation of
IWorkflowExecutionInfo.parentNamespaceId
searchAttributes
• Optional searchAttributes: null | ISearchAttributes
WorkflowExecutionInfo searchAttributes.
Implementation of
IWorkflowExecutionInfo.searchAttributes
startTime
• Optional startTime: null | ITimestamp
WorkflowExecutionInfo startTime.
Implementation of
IWorkflowExecutionInfo.startTime
stateTransitionCount
• stateTransitionCount: Long
WorkflowExecutionInfo stateTransitionCount.
Implementation of
IWorkflowExecutionInfo.stateTransitionCount
status
• status: WorkflowExecutionStatus
WorkflowExecutionInfo status.
Implementation of
taskQueue
• taskQueue: string
WorkflowExecutionInfo taskQueue.
Implementation of
IWorkflowExecutionInfo.taskQueue
type
• Optional type: null | IWorkflowType
WorkflowExecutionInfo type.
Implementation of
Methods
toJSON
▸ toJSON(): Object
Converts this WorkflowExecutionInfo to JSON.
Returns
Object
JSON object
create
▸ create(properties?): WorkflowExecutionInfo
Creates a new WorkflowExecutionInfo instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IWorkflowExecutionInfo | Properties to set |
Returns
WorkflowExecutionInfo instance
decode
▸ decode(reader, length?): WorkflowExecutionInfo
Decodes a WorkflowExecutionInfo 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
WorkflowExecutionInfo
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): WorkflowExecutionInfo
Decodes a WorkflowExecutionInfo message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
WorkflowExecutionInfo
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 WorkflowExecutionInfo message. Does not implicitly temporal.api.workflow.v1.WorkflowExecutionInfo.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IWorkflowExecutionInfo | WorkflowExecutionInfo message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified WorkflowExecutionInfo message, length delimited. Does not implicitly temporal.api.workflow.v1.WorkflowExecutionInfo.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IWorkflowExecutionInfo | WorkflowExecutionInfo message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): WorkflowExecutionInfo
Creates a WorkflowExecutionInfo message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
WorkflowExecutionInfo
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for WorkflowExecutionInfo
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 WorkflowExecutionInfo message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | WorkflowExecutionInfo | WorkflowExecutionInfo |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object