Skip to main content

Class: CancelOperationRequest

nexus.v1.CancelOperationRequest

A request to cancel an operation.

Implements

Constructors

constructor

new CancelOperationRequest(properties?): CancelOperationRequest

Constructs a new CancelOperationRequest.

Parameters

NameTypeDescription
properties?ICancelOperationRequestProperties to set

Returns

CancelOperationRequest

Properties

operation

operation: string

Type of operation to cancel.

Implementation of

ICancelOperationRequest.operation


operationId

operationId: string

Operation ID as originally generated by a Handler.

Implementation of

ICancelOperationRequest.operationId


service

service: string

Service name.

Implementation of

ICancelOperationRequest.service

Methods

toJSON

toJSON(): Object

Converts this CancelOperationRequest to JSON.

Returns

Object

JSON object


create

create(properties?): CancelOperationRequest

Creates a new CancelOperationRequest instance using the specified properties.

Parameters

NameTypeDescription
properties?ICancelOperationRequestProperties to set

Returns

CancelOperationRequest

CancelOperationRequest instance


decode

decode(reader, length?): CancelOperationRequest

Decodes a CancelOperationRequest message from the specified reader or buffer.

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from
length?numberMessage length if known beforehand

Returns

CancelOperationRequest

CancelOperationRequest

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited

decodeDelimited(reader): CancelOperationRequest

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

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns

CancelOperationRequest

CancelOperationRequest

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

Parameters

NameTypeDescription
messageICancelOperationRequestCancelOperationRequest message or plain object to encode
writer?WriterWriter to encode to

Returns

Writer

Writer


encodeDelimited

encodeDelimited(message, writer?): Writer

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

Parameters

NameTypeDescription
messageICancelOperationRequestCancelOperationRequest message or plain object to encode
writer?WriterWriter to encode to

Returns

Writer

Writer


fromObject

fromObject(object): CancelOperationRequest

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

Parameters

NameTypeDescription
objectObjectPlain object

Returns

CancelOperationRequest

CancelOperationRequest


getTypeUrl

getTypeUrl(typeUrlPrefix?): string

Gets the default type url for CancelOperationRequest

Parameters

NameTypeDescription
typeUrlPrefix?stringyour custom typeUrlPrefix(default "type.googleapis.com")

Returns

string

The default type url


toObject

toObject(message, options?): Object

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

Parameters

NameTypeDescription
messageCancelOperationRequestCancelOperationRequest
options?IConversionOptionsConversion options

Returns

Object

Plain object