Class: TerminateNexusOperationExecutionRequest
workflowservice.v1.TerminateNexusOperationExecutionRequest
Represents a TerminateNexusOperationExecutionRequest.
Implements
Constructors
constructor
• new TerminateNexusOperationExecutionRequest(properties?): TerminateNexusOperationExecutionRequest
Constructs a new TerminateNexusOperationExecutionRequest.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | ITerminateNexusOperationExecutionRequest | Properties to set |
Returns
TerminateNexusOperationExecutionRequest
Properties
identity
• identity: string
The identity of the client who initiated this request.
Implementation of
ITerminateNexusOperationExecutionRequest.identity
namespace
• namespace: string
TerminateNexusOperationExecutionRequest namespace.
Implementation of
ITerminateNexusOperationExecutionRequest.namespace
operationId
• operationId: string
TerminateNexusOperationExecutionRequest operationId.
Implementation of
ITerminateNexusOperationExecutionRequest.operationId
reason
• reason: string
Reason for requesting the termination, recorded in the operation's result failure outcome.
Implementation of
ITerminateNexusOperationExecutionRequest.reason
requestId
• requestId: string
Used to de-dupe termination requests.
Implementation of
ITerminateNexusOperationExecutionRequest.requestId
runId
• runId: string
Operation run ID, targets the latest run if empty.
Implementation of
ITerminateNexusOperationExecutionRequest.runId
Methods
toJSON
▸ toJSON(): Object
Converts this TerminateNexusOperationExecutionRequest to JSON.
Returns
Object
JSON object
create
▸ create(properties?): TerminateNexusOperationExecutionRequest
Creates a new TerminateNexusOperationExecutionRequest instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | ITerminateNexusOperationExecutionRequest | Properties to set |
Returns
TerminateNexusOperationExecutionRequest
TerminateNexusOperationExecutionRequest instance
decode
▸ decode(reader, length?): TerminateNexusOperationExecutionRequest
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
TerminateNexusOperationExecutionRequest
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): TerminateNexusOperationExecutionRequest
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
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 | ITerminateNexusOperationExecutionRequest | 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 | ITerminateNexusOperationExecutionRequest | 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
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for TerminateNexusOperationExecutionRequest
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 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