Class: RequestCancelActivityExecutionRequest
workflowservice.v1.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
▸ create(properties?): RequestCancelActivityExecutionRequest & $Properties
Creates a new RequestCancelActivityExecutionRequest instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Properties | Properties to set |
Returns
RequestCancelActivityExecutionRequest & $Properties
RequestCancelActivityExecutionRequest instance
▸ create(properties?): RequestCancelActivityExecutionRequest
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
RequestCancelActivityExecutionRequest
decode
▸ decode(reader, length?): RequestCancelActivityExecutionRequest & $Properties
Decodes a RequestCancelActivityExecutionRequest 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
RequestCancelActivityExecutionRequest & $Properties
RequestCancelActivityExecutionRequest
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): RequestCancelActivityExecutionRequest & $Properties
Decodes a RequestCancelActivityExecutionRequest message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | 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
▸ encode(message, writer?): Writer
Encodes the specified RequestCancelActivityExecutionRequest message. Does not implicitly temporal.api.workflowservice.v1.RequestCancelActivityExecutionRequest.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | RequestCancelActivityExecutionRequest message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified RequestCancelActivityExecutionRequest message, length delimited. Does not implicitly temporal.api.workflowservice.v1.RequestCancelActivityExecutionRequest.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | RequestCancelActivityExecutionRequest message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): RequestCancelActivityExecutionRequest
Creates a RequestCancelActivityExecutionRequest message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
RequestCancelActivityExecutionRequest
RequestCancelActivityExecutionRequest
toObject
▸ toObject(message, options?): Object
Creates a plain object from a RequestCancelActivityExecutionRequest message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | RequestCancelActivityExecutionRequest | RequestCancelActivityExecutionRequest |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object