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