Class: RequestCancelExternalWorkflowExecution
coresdk.workflow_commands.RequestCancelExternalWorkflowExecution
Request cancellation of an external workflow execution (which may be a started child)
Implements
Constructors
constructor
• new RequestCancelExternalWorkflowExecution(properties?): RequestCancelExternalWorkflowExecution
Constructs a new RequestCancelExternalWorkflowExecution.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IRequestCancelExternalWorkflowExecution | Properties to set |
Returns
RequestCancelExternalWorkflowExecution
Properties
childWorkflowId
• Optional childWorkflowId: null | string
The desired target must be a child of the issuing workflow, and this is its workflow id
Implementation of
IRequestCancelExternalWorkflowExecution.childWorkflowId
seq
• seq: number
Lang's incremental sequence number, used as the operation identifier
Implementation of
IRequestCancelExternalWorkflowExecution.seq
target
• Optional target: "workflowExecution" | "childWorkflowId"
What workflow is being targeted
workflowExecution
• Optional workflowExecution: null | INamespacedWorkflowExecution
A specific workflow instance
Implementation of
IRequestCancelExternalWorkflowExecution.workflowExecution
Methods
toJSON
▸ toJSON(): Object
Converts this RequestCancelExternalWorkflowExecution to JSON.
Returns
Object
JSON object
create
▸ create(properties?): RequestCancelExternalWorkflowExecution
Creates a new RequestCancelExternalWorkflowExecution instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IRequestCancelExternalWorkflowExecution | Properties to set |
Returns
RequestCancelExternalWorkflowExecution
RequestCancelExternalWorkflowExecution instance
decode
▸ decode(reader, length?): RequestCancelExternalWorkflowExecution
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
RequestCancelExternalWorkflowExecution
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): RequestCancelExternalWorkflowExecution
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
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 | IRequestCancelExternalWorkflowExecution | 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 | IRequestCancelExternalWorkflowExecution | 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
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for RequestCancelExternalWorkflowExecution
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 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