Class: RequestCancelExternalWorkflowExecution
coresdk.workflow_commands.RequestCancelExternalWorkflowExecution
Request cancellation of an external workflow execution. For cancellation of a child workflow,
prefer CancelChildWorkflowExecution instead, as it guards against cancel-before-start issues.
Properties
reason
• reason: string
A reason for the cancellation
seq
• seq: number
Lang's incremental sequence number, used as the operation identifier
workflowExecution
• Optional workflowExecution: null | $Properties
The workflow instance being targeted
Methods
toJSON
▸ toJSON(): Object
Converts this RequestCancelExternalWorkflowExecution to JSON.
Returns
Object
JSON object
create
▸ create(properties?): RequestCancelExternalWorkflowExecution & $Properties
Creates a new RequestCancelExternalWorkflowExecution instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Properties | Properties to set |
Returns
RequestCancelExternalWorkflowExecution & $Properties
RequestCancelExternalWorkflowExecution instance
▸ create(properties?): RequestCancelExternalWorkflowExecution
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
RequestCancelExternalWorkflowExecution
decode
▸ decode(reader, length?): RequestCancelExternalWorkflowExecution & $Properties
Decodes a RequestCancelExternalWorkflowExecution 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
RequestCancelExternalWorkflowExecution & $Properties
RequestCancelExternalWorkflowExecution
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): RequestCancelExternalWorkflowExecution & $Properties
Decodes a RequestCancelExternalWorkflowExecution message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
RequestCancelExternalWorkflowExecution & $Properties
RequestCancelExternalWorkflowExecution
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 RequestCancelExternalWorkflowExecution message. Does not implicitly coresdk.workflow_commands.RequestCancelExternalWorkflowExecution.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | RequestCancelExternalWorkflowExecution message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified RequestCancelExternalWorkflowExecution message, length delimited. Does not implicitly coresdk.workflow_commands.RequestCancelExternalWorkflowExecution.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | RequestCancelExternalWorkflowExecution message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): RequestCancelExternalWorkflowExecution
Creates a RequestCancelExternalWorkflowExecution message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
RequestCancelExternalWorkflowExecution
RequestCancelExternalWorkflowExecution
toObject
▸ toObject(message, options?): Object
Creates a plain object from a RequestCancelExternalWorkflowExecution message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | RequestCancelExternalWorkflowExecution | RequestCancelExternalWorkflowExecution |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object