Class: Workflow
A link to a workflow execution. This is a more general version of WorkflowEvent that doesn't specify a particular event within the workflow, useful when you want to link to a workflow but there is no particular event to link to, such as a Query or a Rejected Update.
Properties
namespace
• namespace: string
Workflow namespace.
reason
• reason: string
Workflow reason.
runId
• runId: string
Workflow runId.
workflowId
• workflowId: string
Workflow workflowId.
Methods
toJSON
▸ toJSON(): Object
Converts this Workflow to JSON.
Returns
Object
JSON object
create
▸ create(properties?): Workflow & $Properties
Creates a new Workflow instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Properties | Properties to set |
Returns
Workflow instance
▸ create(properties?): Workflow
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
decode
▸ decode(reader, length?): Workflow & $Properties
Decodes a Workflow 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
Workflow
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): Workflow & $Properties
Decodes a Workflow message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
Workflow
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 Workflow message. Does not implicitly temporal.api.common.v1.Link.Workflow.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | Workflow message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified Workflow message, length delimited. Does not implicitly temporal.api.common.v1.Link.Workflow.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | Workflow message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): Workflow
Creates a Workflow message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
Workflow
toObject
▸ toObject(message, options?): Object
Creates a plain object from a Workflow message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | Workflow | Workflow |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object