Skip to main content

Class: CancelOperationRequest

A request to cancel an operation.

Properties​

operation​

operation: string

Type of operation to cancel.

operationId​

operationId: string

Operation ID as originally generated by a Handler.

Deprecated. Renamed to operation_token.

operationToken​

operationToken: string

Operation token as originally generated by a Handler.

service​

service: string

Service name.

Methods​

toJSON()​

toJSON(): object

Converts this CancelOperationRequest to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): CancelOperationRequest & $Properties

Creates a new CancelOperationRequest instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

CancelOperationRequest & $Properties

CancelOperationRequest instance

Call Signature​

static create(properties?): CancelOperationRequest

Creates a new CancelOperationRequest instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

CancelOperationRequest

CancelOperationRequest instance

decode()​

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

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

CancelOperationRequest & $Properties

CancelOperationRequest

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): CancelOperationRequest & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

CancelOperationRequest & $Properties

CancelOperationRequest

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 CancelOperationRequest message. Does not implicitly temporal.api.nexus.v1.CancelOperationRequest.verify|verify messages.

Parameters​

message​

$Properties

CancelOperationRequest message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

CancelOperationRequest message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): CancelOperationRequest

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

Parameters​

object​

Plain object

Returns​

CancelOperationRequest

CancelOperationRequest

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

CancelOperationRequest

CancelOperationRequest

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object