Class: RequestCancelNexusOperationExecutionRequest
workflowservice.v1.RequestCancelNexusOperationExecutionRequest
Represents a RequestCancelNexusOperationExecutionRequest.
Implements
Constructors
constructor
• new RequestCancelNexusOperationExecutionRequest(properties?): RequestCancelNexusOperationExecutionRequest
Constructs a new RequestCancelNexusOperationExecutionRequest.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IRequestCancelNexusOperationExecutionRequest | Properties to set |
Returns
RequestCancelNexusOperationExecutionRequest
Properties
identity
• identity: string
The identity of the client who initiated this request.
Implementation of
IRequestCancelNexusOperationExecutionRequest.identity
namespace
• namespace: string
RequestCancelNexusOperationExecutionRequest namespace.
Implementation of
IRequestCancelNexusOperationExecutionRequest.namespace
operationId
• operationId: string
RequestCancelNexusOperationExecutionRequest operationId.
Implementation of
IRequestCancelNexusOperationExecutionRequest.operationId
reason
• reason: string
Reason for requesting the cancellation, recorded and available via the DescribeNexusOperationExecution API.
Implementation of
IRequestCancelNexusOperationExecutionRequest.reason
requestId
• requestId: string
Used to de-dupe cancellation requests.
Implementation of
IRequestCancelNexusOperationExecutionRequest.requestId
runId
• runId: string
Operation run ID, targets the latest run if empty.
Implementation of
IRequestCancelNexusOperationExecutionRequest.runId
Methods
toJSON
▸ toJSON(): Object
Converts this RequestCancelNexusOperationExecutionRequest to JSON.
Returns
Object
JSON object
create
▸ create(properties?): RequestCancelNexusOperationExecutionRequest
Creates a new RequestCancelNexusOperationExecutionRequest instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IRequestCancelNexusOperationExecutionRequest | Properties to set |
Returns
RequestCancelNexusOperationExecutionRequest
RequestCancelNexusOperationExecutionRequest instance
decode
▸ decode(reader, length?): RequestCancelNexusOperationExecutionRequest
Decodes a RequestCancelNexusOperationExecutionRequest 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
RequestCancelNexusOperationExecutionRequest
RequestCancelNexusOperationExecutionRequest
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): RequestCancelNexusOperationExecutionRequest
Decodes a RequestCancelNexusOperationExecutionRequest message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
RequestCancelNexusOperationExecutionRequest
RequestCancelNexusOperationExecutionRequest
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 RequestCancelNexusOperationExecutionRequest message. Does not implicitly temporal.api.workflowservice.v1.RequestCancelNexusOperationExecutionRequest.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IRequestCancelNexusOperationExecutionRequest | RequestCancelNexusOperationExecutionRequest message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified RequestCancelNexusOperationExecutionRequest message, length delimited. Does not implicitly temporal.api.workflowservice.v1.RequestCancelNexusOperationExecutionRequest.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IRequestCancelNexusOperationExecutionRequest | RequestCancelNexusOperationExecutionRequest message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): RequestCancelNexusOperationExecutionRequest
Creates a RequestCancelNexusOperationExecutionRequest message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
RequestCancelNexusOperationExecutionRequest
RequestCancelNexusOperationExecutionRequest
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for RequestCancelNexusOperationExecutionRequest
Parameters
| Name | Type | Description |
|---|---|---|
typeUrlPrefix? | string | your custom typeUrlPrefix(default "type.googleapis.com") |
Returns
string
The default type url
toObject
▸ toObject(message, options?): Object
Creates a plain object from a RequestCancelNexusOperationExecutionRequest message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | RequestCancelNexusOperationExecutionRequest | RequestCancelNexusOperationExecutionRequest |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object