Skip to main content

Class: NexusOperation

v1.Link.NexusOperation

A link to a standalone Nexus operation.

Properties​

namespace​

• namespace: string

NexusOperation namespace.


operationId​

• operationId: string

NexusOperation operationId.


runId​

• runId: string

NexusOperation runId.

Methods​

toJSON​

▸ toJSON(): Object

Converts this NexusOperation to JSON.

Returns​

Object

JSON object


create​

▸ create(properties?): NexusOperation & $Properties

Creates a new NexusOperation instance using the specified properties.

Parameters​

NameTypeDescription
properties?$PropertiesProperties to set

Returns​

NexusOperation & $Properties

NexusOperation instance

▸ create(properties?): NexusOperation

Parameters​

NameType
properties?$Properties

Returns​

NexusOperation


decode​

▸ decode(reader, length?): NexusOperation & $Properties

Decodes a NexusOperation message from the specified reader or buffer.

Parameters​

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

Returns​

NexusOperation & $Properties

NexusOperation

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited​

▸ decodeDelimited(reader): NexusOperation & $Properties

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

Parameters​

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns​

NexusOperation & $Properties

NexusOperation

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 NexusOperation message. Does not implicitly temporal.api.common.v1.Link.NexusOperation.verify|verify messages.

Parameters​

NameTypeDescription
message$PropertiesNexusOperation message or plain object to encode
writer?WriterWriter to encode to

Returns​

Writer

Writer


encodeDelimited​

▸ encodeDelimited(message, writer?): Writer

Encodes the specified NexusOperation message, length delimited. Does not implicitly temporal.api.common.v1.Link.NexusOperation.verify|verify messages.

Parameters​

NameTypeDescription
message$PropertiesNexusOperation message or plain object to encode
writer?WriterWriter to encode to

Returns​

Writer

Writer


fromObject​

▸ fromObject(object): NexusOperation

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

Parameters​

NameTypeDescription
objectObjectPlain object

Returns​

NexusOperation

NexusOperation


toObject​

▸ toObject(message, options?): Object

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

Parameters​

NameTypeDescription
messageNexusOperationNexusOperation
options?IConversionOptionsConversion options

Returns​

Object

Plain object