Class: CancelWorkflowExecution
coresdk.workflow_commands.CancelWorkflowExecution
Indicate a workflow has completed as cancelled. Generally sent as a response to an activation containing a cancellation job.
Implements
Constructors
constructor
• new CancelWorkflowExecution(properties?): CancelWorkflowExecution
Constructs a new CancelWorkflowExecution.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | ICancelWorkflowExecution | Properties to set |
Returns
Methods
toJSON
▸ toJSON(): Object
Converts this CancelWorkflowExecution to JSON.
Returns
Object
JSON object
create
▸ create(properties?): CancelWorkflowExecution
Creates a new CancelWorkflowExecution instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | ICancelWorkflowExecution | Properties to set |
Returns
CancelWorkflowExecution instance
decode
▸ decode(reader, length?): CancelWorkflowExecution
Decodes a CancelWorkflowExecution 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
CancelWorkflowExecution
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): CancelWorkflowExecution
Decodes a CancelWorkflowExecution message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
CancelWorkflowExecution
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 CancelWorkflowExecution message. Does not implicitly coresdk.workflow_commands.CancelWorkflowExecution.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | ICancelWorkflowExecution | CancelWorkflowExecution message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified CancelWorkflowExecution message, length delimited. Does not implicitly coresdk.workflow_commands.CancelWorkflowExecution.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | ICancelWorkflowExecution | CancelWorkflowExecution message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): CancelWorkflowExecution
Creates a CancelWorkflowExecution message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
CancelWorkflowExecution
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for CancelWorkflowExecution
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 CancelWorkflowExecution message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | CancelWorkflowExecution | CancelWorkflowExecution |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object