Class: 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?
optionalworkflowExecution?:$Properties|null
RequestCancelWorkflowExecutionRequest workflowExecution.
Methods
toJSON()
toJSON():
object
Converts this RequestCancelWorkflowExecutionRequest to JSON.
Returns
object
JSON object
create()
Call Signature
staticcreate(properties?):RequestCancelWorkflowExecutionRequest&$Shape
Creates a new RequestCancelWorkflowExecutionRequest instance using the specified properties.
Parameters
properties?
Properties to set
Returns
RequestCancelWorkflowExecutionRequest & $Shape
RequestCancelWorkflowExecutionRequest instance
Call Signature
staticcreate(properties?):RequestCancelWorkflowExecutionRequest
Creates a new RequestCancelWorkflowExecutionRequest instance using the specified properties.
Parameters
properties?
Properties to set
Returns
RequestCancelWorkflowExecutionRequest
RequestCancelWorkflowExecutionRequest instance
decode()
staticdecode(reader,length?):RequestCancelWorkflowExecutionRequest&$Shape
Decodes a RequestCancelWorkflowExecutionRequest message from the specified reader or buffer.
Parameters
reader
Uint8Array<ArrayBufferLike> | 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()
staticdecodeDelimited(reader):RequestCancelWorkflowExecutionRequest&$Shape
Decodes a RequestCancelWorkflowExecutionRequest message from the specified reader or buffer, length delimited.
Parameters
reader
Uint8Array<ArrayBufferLike> | 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()
staticencode(message,writer?):Writer
Encodes the specified RequestCancelWorkflowExecutionRequest message. Does not implicitly temporal.api.workflowservice.v1.RequestCancelWorkflowExecutionRequest.verify|verify messages.
Parameters
message
RequestCancelWorkflowExecutionRequest message or plain object to encode
writer?
Writer
Writer to encode to
Returns
Writer
Writer
encodeDelimited()
staticencodeDelimited(message,writer?):Writer
Encodes the specified RequestCancelWorkflowExecutionRequest message, length delimited. Does not implicitly temporal.api.workflowservice.v1.RequestCancelWorkflowExecutionRequest.verify|verify messages.
Parameters
message
RequestCancelWorkflowExecutionRequest message or plain object to encode
writer?
Writer
Writer to encode to
Returns
Writer
Writer
fromObject()
staticfromObject(object):RequestCancelWorkflowExecutionRequest
Creates a RequestCancelWorkflowExecutionRequest message from a plain object. Also converts values to their respective internal types.
Parameters
object
Plain object
Returns
RequestCancelWorkflowExecutionRequest
RequestCancelWorkflowExecutionRequest
toObject()
statictoObject(message,options?):object
Creates a plain object from a RequestCancelWorkflowExecutionRequest message. Also converts values to other types if specified.
Parameters
message
RequestCancelWorkflowExecutionRequest
RequestCancelWorkflowExecutionRequest
options?
IConversionOptions
Conversion options
Returns
object
Plain object