Class: RequestCancelExternalWorkflowExecutionCommandAttributes
command.v1.RequestCancelExternalWorkflowExecutionCommandAttributes
Represents a RequestCancelExternalWorkflowExecutionCommandAttributes.
Implements
Constructors
constructor
• new RequestCancelExternalWorkflowExecutionCommandAttributes(properties?): RequestCancelExternalWorkflowExecutionCommandAttributes
Constructs a new RequestCancelExternalWorkflowExecutionCommandAttributes.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IRequestCancelExternalWorkflowExecutionCommandAttributes | Properties to set |
Returns
RequestCancelExternalWorkflowExecutionCommandAttributes
Properties
childWorkflowOnly
• childWorkflowOnly: boolean
Set this to true if the workflow being cancelled is a child of the workflow originating this command. The request will be rejected if it is set to true and the target workflow is not a child of the requesting workflow.
Implementation of
IRequestCancelExternalWorkflowExecutionCommandAttributes.childWorkflowOnly
control
• control: string
Deprecated.
Implementation of
IRequestCancelExternalWorkflowExecutionCommandAttributes.control
namespace
• namespace: string
RequestCancelExternalWorkflowExecutionCommandAttributes namespace.
Implementation of
IRequestCancelExternalWorkflowExecutionCommandAttributes.namespace
reason
• reason: string
Reason for requesting the cancellation
Implementation of
IRequestCancelExternalWorkflowExecutionCommandAttributes.reason
runId
• runId: string
RequestCancelExternalWorkflowExecutionCommandAttributes runId.
Implementation of
IRequestCancelExternalWorkflowExecutionCommandAttributes.runId
workflowId
• workflowId: string
RequestCancelExternalWorkflowExecutionCommandAttributes workflowId.
Implementation of
IRequestCancelExternalWorkflowExecutionCommandAttributes.workflowId
Methods
toJSON
▸ toJSON(): Object
Converts this RequestCancelExternalWorkflowExecutionCommandAttributes to JSON.
Returns
Object
JSON object
create
▸ create(properties?): RequestCancelExternalWorkflowExecutionCommandAttributes
Creates a new RequestCancelExternalWorkflowExecutionCommandAttributes instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IRequestCancelExternalWorkflowExecutionCommandAttributes | Properties to set |
Returns
RequestCancelExternalWorkflowExecutionCommandAttributes
RequestCancelExternalWorkflowExecutionCommandAttributes instance
decode
▸ decode(reader, length?): RequestCancelExternalWorkflowExecutionCommandAttributes
Decodes a RequestCancelExternalWorkflowExecutionCommandAttributes 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
RequestCancelExternalWorkflowExecutionCommandAttributes
RequestCancelExternalWorkflowExecutionCommandAttributes
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): RequestCancelExternalWorkflowExecutionCommandAttributes
Decodes a RequestCancelExternalWorkflowExecutionCommandAttributes message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
RequestCancelExternalWorkflowExecutionCommandAttributes
RequestCancelExternalWorkflowExecutionCommandAttributes
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 RequestCancelExternalWorkflowExecutionCommandAttributes message. Does not implicitly temporal.api.command.v1.RequestCancelExternalWorkflowExecutionCommandAttributes.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IRequestCancelExternalWorkflowExecutionCommandAttributes | RequestCancelExternalWorkflowExecutionCommandAttributes message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified RequestCancelExternalWorkflowExecutionCommandAttributes message, length delimited. Does not implicitly temporal.api.command.v1.RequestCancelExternalWorkflowExecutionCommandAttributes.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IRequestCancelExternalWorkflowExecutionCommandAttributes | RequestCancelExternalWorkflowExecutionCommandAttributes message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): RequestCancelExternalWorkflowExecutionCommandAttributes
Creates a RequestCancelExternalWorkflowExecutionCommandAttributes message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
RequestCancelExternalWorkflowExecutionCommandAttributes
RequestCancelExternalWorkflowExecutionCommandAttributes
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for RequestCancelExternalWorkflowExecutionCommandAttributes
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 RequestCancelExternalWorkflowExecutionCommandAttributes message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | RequestCancelExternalWorkflowExecutionCommandAttributes | RequestCancelExternalWorkflowExecutionCommandAttributes |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object