Skip to main content

Class: 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()​

Call Signature​

static create(properties?): TerminateNexusOperationExecutionRequest & $Properties

Creates a new TerminateNexusOperationExecutionRequest instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

TerminateNexusOperationExecutionRequest & $Properties

TerminateNexusOperationExecutionRequest instance

Call Signature​

static create(properties?): TerminateNexusOperationExecutionRequest

Creates a new TerminateNexusOperationExecutionRequest instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

TerminateNexusOperationExecutionRequest

TerminateNexusOperationExecutionRequest instance


decode()​

static decode(reader, length?): TerminateNexusOperationExecutionRequest & $Properties

Decodes a TerminateNexusOperationExecutionRequest 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​

TerminateNexusOperationExecutionRequest & $Properties

TerminateNexusOperationExecutionRequest

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing


decodeDelimited()​

static decodeDelimited(reader): TerminateNexusOperationExecutionRequest & $Properties

Decodes a TerminateNexusOperationExecutionRequest message from the specified reader or buffer, length delimited.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | 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()​

static encode(message, writer?): Writer

Encodes the specified TerminateNexusOperationExecutionRequest message. Does not implicitly temporal.api.workflowservice.v1.TerminateNexusOperationExecutionRequest.verify|verify messages.

Parameters​

message​

$Properties

TerminateNexusOperationExecutionRequest message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer


encodeDelimited()​

static encodeDelimited(message, writer?): Writer

Encodes the specified TerminateNexusOperationExecutionRequest message, length delimited. Does not implicitly temporal.api.workflowservice.v1.TerminateNexusOperationExecutionRequest.verify|verify messages.

Parameters​

message​

$Properties

TerminateNexusOperationExecutionRequest message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer


fromObject()​

static fromObject(object): TerminateNexusOperationExecutionRequest

Creates a TerminateNexusOperationExecutionRequest message from a plain object. Also converts values to their respective internal types.

Parameters​

object​

Plain object

Returns​

TerminateNexusOperationExecutionRequest

TerminateNexusOperationExecutionRequest


toObject()​

static toObject(message, options?): object

Creates a plain object from a TerminateNexusOperationExecutionRequest message. Also converts values to other types if specified.

Parameters​

message​

TerminateNexusOperationExecutionRequest

TerminateNexusOperationExecutionRequest

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object