Class: WorkflowExecution
Identifies a specific workflow within a namespace. Practically speaking, because run_id is a uuid, a workflow execution is globally unique. Note that many commands allow specifying an empty run id as a way of saying "target the latest run of the workflow".
Properties
runId
• runId: string
WorkflowExecution runId.
workflowId
• workflowId: string
WorkflowExecution workflowId.
Methods
toJSON
▸ toJSON(): Object
Converts this WorkflowExecution to JSON.
Returns
Object
JSON object
create
▸ create(properties?): WorkflowExecution & $Properties
Creates a new WorkflowExecution instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Properties | Properties to set |
Returns
WorkflowExecution & $Properties
WorkflowExecution instance
▸ create(properties?): WorkflowExecution
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
decode
▸ decode(reader, length?): WorkflowExecution & $Properties
Decodes a WorkflowExecution 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
WorkflowExecution & $Properties
WorkflowExecution
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): WorkflowExecution & $Properties
Decodes a WorkflowExecution message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
WorkflowExecution & $Properties
WorkflowExecution
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 WorkflowExecution message. Does not implicitly temporal.api.common.v1.WorkflowExecution.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | WorkflowExecution message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified WorkflowExecution message, length delimited. Does not implicitly temporal.api.common.v1.WorkflowExecution.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | WorkflowExecution message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): WorkflowExecution
Creates a WorkflowExecution message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
WorkflowExecution
toObject
▸ toObject(message, options?): Object
Creates a plain object from a WorkflowExecution message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | WorkflowExecution | WorkflowExecution |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object