Class: RequestCancelNexusOperationExecutionRequest
Represents a RequestCancelNexusOperationExecutionRequest.
Properties
identity
identity:
string
The identity of the client who initiated this request.
namespace
namespace:
string
RequestCancelNexusOperationExecutionRequest namespace.
operationId
operationId:
string
RequestCancelNexusOperationExecutionRequest operationId.
reason
reason:
string
Reason for requesting the cancellation, recorded and available via the DescribeNexusOperationExecution API.
requestId
requestId:
string
Used to de-dupe cancellation requests.
runId
runId:
string
Operation run ID, targets the latest run if empty.
Methods
toJSON()
toJSON():
object
Converts this RequestCancelNexusOperationExecutionRequest to JSON.
Returns
object
JSON object
create()
Call Signature
staticcreate(properties?):RequestCancelNexusOperationExecutionRequest&$Properties
Creates a new RequestCancelNexusOperationExecutionRequest instance using the specified properties.
Parameters
properties?
Properties to set
Returns
RequestCancelNexusOperationExecutionRequest & $Properties
RequestCancelNexusOperationExecutionRequest instance
Call Signature
staticcreate(properties?):RequestCancelNexusOperationExecutionRequest
Creates a new RequestCancelNexusOperationExecutionRequest instance using the specified properties.
Parameters
properties?
Properties to set
Returns
RequestCancelNexusOperationExecutionRequest
RequestCancelNexusOperationExecutionRequest instance
decode()
staticdecode(reader,length?):RequestCancelNexusOperationExecutionRequest&$Properties
Decodes a RequestCancelNexusOperationExecutionRequest 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
RequestCancelNexusOperationExecutionRequest & $Properties
RequestCancelNexusOperationExecutionRequest
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited()
staticdecodeDelimited(reader):RequestCancelNexusOperationExecutionRequest&$Properties
Decodes a RequestCancelNexusOperationExecutionRequest message from the specified reader or buffer, length delimited.
Parameters
reader
Uint8Array<ArrayBufferLike> | Reader
Reader or buffer to decode from
Returns
RequestCancelNexusOperationExecutionRequest & $Properties
RequestCancelNexusOperationExecutionRequest
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 RequestCancelNexusOperationExecutionRequest message. Does not implicitly temporal.api.workflowservice.v1.RequestCancelNexusOperationExecutionRequest.verify|verify messages.
Parameters
message
RequestCancelNexusOperationExecutionRequest message or plain object to encode
writer?
Writer
Writer to encode to
Returns
Writer
Writer
encodeDelimited()
staticencodeDelimited(message,writer?):Writer
Encodes the specified RequestCancelNexusOperationExecutionRequest message, length delimited. Does not implicitly temporal.api.workflowservice.v1.RequestCancelNexusOperationExecutionRequest.verify|verify messages.
Parameters
message
RequestCancelNexusOperationExecutionRequest message or plain object to encode
writer?
Writer
Writer to encode to
Returns
Writer
Writer
fromObject()
staticfromObject(object):RequestCancelNexusOperationExecutionRequest
Creates a RequestCancelNexusOperationExecutionRequest message from a plain object. Also converts values to their respective internal types.
Parameters
object
Plain object
Returns
RequestCancelNexusOperationExecutionRequest
RequestCancelNexusOperationExecutionRequest
toObject()
statictoObject(message,options?):object
Creates a plain object from a RequestCancelNexusOperationExecutionRequest message. Also converts values to other types if specified.
Parameters
message
RequestCancelNexusOperationExecutionRequest
RequestCancelNexusOperationExecutionRequest
options?
IConversionOptions
Conversion options
Returns
object
Plain object