Class: TerminateNexusOperationExecutionRequest
workflowservice.v1.TerminateNexusOperationExecutionRequest
Represents a TerminateNexusOperationExecutionRequest.
Properties
identity
• identity: string
The identity of the client who initiated this request.
namespace
• namespace: string
TerminateNexusOperationExecutionRequest namespace.
operationId
• operationId: string
TerminateNexusOperationExecutionRequest operationId.
reason
• reason: string
Reason for requesting the termination, recorded in the operation's result failure outcome.
requestId
• requestId: string
Used to de-dupe termination requests.
runId
• runId: string
Operation run ID, targets the latest run if empty.
Methods
toJSON
▸ toJSON(): Object
Converts this TerminateNexusOperationExecutionRequest to JSON.
Returns
Object
JSON object
create
▸ create(properties?): TerminateNexusOperationExecutionRequest & $Properties
Creates a new TerminateNexusOperationExecutionRequest instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Properties | Properties to set |
Returns
TerminateNexusOperationExecutionRequest & $Properties
TerminateNexusOperationExecutionRequest instance
▸ create(properties?): TerminateNexusOperationExecutionRequest
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
TerminateNexusOperationExecutionRequest
decode
▸ decode(reader, length?): TerminateNexusOperationExecutionRequest & $Properties
Decodes a TerminateNexusOperationExecutionRequest 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
TerminateNexusOperationExecutionRequest & $Properties
TerminateNexusOperationExecutionRequest
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): TerminateNexusOperationExecutionRequest & $Properties
Decodes a TerminateNexusOperationExecutionRequest message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
TerminateNexusOperationExecutionRequest & $Properties
TerminateNexusOperationExecutionRequest
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 TerminateNexusOperationExecutionRequest message. Does not implicitly temporal.api.workflowservice.v1.TerminateNexusOperationExecutionRequest.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | TerminateNexusOperationExecutionRequest message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified TerminateNexusOperationExecutionRequest message, length delimited. Does not implicitly temporal.api.workflowservice.v1.TerminateNexusOperationExecutionRequest.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | TerminateNexusOperationExecutionRequest message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): TerminateNexusOperationExecutionRequest
Creates a TerminateNexusOperationExecutionRequest message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
TerminateNexusOperationExecutionRequest
TerminateNexusOperationExecutionRequest
toObject
▸ toObject(message, options?): Object
Creates a plain object from a TerminateNexusOperationExecutionRequest message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | TerminateNexusOperationExecutionRequest | TerminateNexusOperationExecutionRequest |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object