Class: RequestCancelWorkflowExecutionRequest
workflowservice.v1.RequestCancelWorkflowExecutionRequest
Represents a RequestCancelWorkflowExecutionRequest.
Properties
firstExecutionRunId
• firstExecutionRunId: string
If set, this call will error if the most recent (if no run id is set on
workflow_execution), or specified (if it is) workflow execution is not part of the same
execution chain as this id.
identity
• identity: string
The identity of the worker/client
links
• links: $Properties[]
Links to be associated with the WorkflowExecutionCanceled event.
namespace
• namespace: string
RequestCancelWorkflowExecutionRequest namespace.
reason
• reason: string
Reason for requesting the cancellation
requestId
• requestId: string
Used to de-dupe cancellation requests
workflowExecution
• Optional workflowExecution: null | $Properties
RequestCancelWorkflowExecutionRequest workflowExecution.
Methods
toJSON
▸ toJSON(): Object
Converts this RequestCancelWorkflowExecutionRequest to JSON.
Returns
Object
JSON object
create
▸ create(properties?): RequestCancelWorkflowExecutionRequest & $Shape
Creates a new RequestCancelWorkflowExecutionRequest instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Shape | Properties to set |
Returns
RequestCancelWorkflowExecutionRequest & $Shape
RequestCancelWorkflowExecutionRequest instance
▸ create(properties?): RequestCancelWorkflowExecutionRequest
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
RequestCancelWorkflowExecutionRequest
decode
▸ decode(reader, length?): RequestCancelWorkflowExecutionRequest & $Shape
Decodes a RequestCancelWorkflowExecutionRequest 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
RequestCancelWorkflowExecutionRequest & $Shape
RequestCancelWorkflowExecutionRequest
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): RequestCancelWorkflowExecutionRequest & $Shape
Decodes a RequestCancelWorkflowExecutionRequest message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
RequestCancelWorkflowExecutionRequest & $Shape
RequestCancelWorkflowExecutionRequest
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 RequestCancelWorkflowExecutionRequest message. Does not implicitly temporal.api.workflowservice.v1.RequestCancelWorkflowExecutionRequest.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | RequestCancelWorkflowExecutionRequest message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified RequestCancelWorkflowExecutionRequest message, length delimited. Does not implicitly temporal.api.workflowservice.v1.RequestCancelWorkflowExecutionRequest.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | RequestCancelWorkflowExecutionRequest message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): RequestCancelWorkflowExecutionRequest
Creates a RequestCancelWorkflowExecutionRequest message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
RequestCancelWorkflowExecutionRequest
RequestCancelWorkflowExecutionRequest
toObject
▸ toObject(message, options?): Object
Creates a plain object from a RequestCancelWorkflowExecutionRequest message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | RequestCancelWorkflowExecutionRequest | RequestCancelWorkflowExecutionRequest |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object