Class: CancelChildWorkflowExecution
coresdk.workflow_commands.CancelChildWorkflowExecution
Cancel a child workflow
Implements
Constructors
constructor
• new CancelChildWorkflowExecution(properties?): CancelChildWorkflowExecution
Constructs a new CancelChildWorkflowExecution.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | ICancelChildWorkflowExecution | Properties to set |
Returns
Properties
childWorkflowSeq
• childWorkflowSeq: number
Sequence number as given to the StartChildWorkflowExecution command
Implementation of
ICancelChildWorkflowExecution.childWorkflowSeq
Methods
toJSON
▸ toJSON(): Object
Converts this CancelChildWorkflowExecution to JSON.
Returns
Object
JSON object
create
▸ create(properties?): CancelChildWorkflowExecution
Creates a new CancelChildWorkflowExecution instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | ICancelChildWorkflowExecution | Properties to set |
Returns
CancelChildWorkflowExecution instance
decode
▸ decode(reader, length?): CancelChildWorkflowExecution
Decodes a CancelChildWorkflowExecution 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
CancelChildWorkflowExecution
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): CancelChildWorkflowExecution
Decodes a CancelChildWorkflowExecution message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
CancelChildWorkflowExecution
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 CancelChildWorkflowExecution message. Does not implicitly coresdk.workflow_commands.CancelChildWorkflowExecution.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | ICancelChildWorkflowExecution | CancelChildWorkflowExecution message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified CancelChildWorkflowExecution message, length delimited. Does not implicitly coresdk.workflow_commands.CancelChildWorkflowExecution.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | ICancelChildWorkflowExecution | CancelChildWorkflowExecution message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): CancelChildWorkflowExecution
Creates a CancelChildWorkflowExecution message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
CancelChildWorkflowExecution
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for CancelChildWorkflowExecution
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 CancelChildWorkflowExecution message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | CancelChildWorkflowExecution | CancelChildWorkflowExecution |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object