Skip to main content

Class: NexusOperationExecutionListInfo

nexus.v1.NexusOperationExecutionListInfo

Limited Nexus operation information returned in the list response. When adding fields here, ensure that it is also present in NexusOperationExecutionInfo (note that it may already be present in NexusOperationExecutionInfo but not at the top-level).

Properties​

closeTime​

• Optional closeTime: null | $Properties

If the operation is in a terminal status, this field represents the time the operation transitioned to that status.


endpoint​

• endpoint: string

Endpoint name.


executionDuration​

• Optional executionDuration: null | $Properties

The difference between close time and scheduled time. This field is only populated if the operation is closed.


operation​

• operation: string

Operation name.


operationId​

• operationId: string

A unique identifier of this operation within its namespace along with run ID (below).


runId​

• runId: string

The run ID of the standalone Nexus operation.


scheduleTime​

• Optional scheduleTime: null | $Properties

Time the operation was originally scheduled via a StartNexusOperation request.


searchAttributes​

• Optional searchAttributes: null | $Properties

Search attributes from the start request.


service​

• service: string

Service name.


stateSizeBytes​

• stateSizeBytes: Long

Updated once on scheduled and once on terminal status.


stateTransitionCount​

• stateTransitionCount: Long

Updated on terminal status.


status​

• status: NexusOperationExecutionStatus

The status is updated once, when the operation is originally scheduled, and again when the operation reaches a terminal status.

Methods​

toJSON​

▸ toJSON(): Object

Converts this NexusOperationExecutionListInfo to JSON.

Returns​

Object

JSON object


create​

▸ create(properties?): NexusOperationExecutionListInfo & $Properties

Creates a new NexusOperationExecutionListInfo instance using the specified properties.

Parameters​

NameTypeDescription
properties?$PropertiesProperties to set

Returns​

NexusOperationExecutionListInfo & $Properties

NexusOperationExecutionListInfo instance

▸ create(properties?): NexusOperationExecutionListInfo

Parameters​

NameType
properties?$Properties

Returns​

NexusOperationExecutionListInfo


decode​

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

Decodes a NexusOperationExecutionListInfo message from the specified reader or buffer.

Parameters​

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

Returns​

NexusOperationExecutionListInfo & $Properties

NexusOperationExecutionListInfo

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited​

▸ decodeDelimited(reader): NexusOperationExecutionListInfo & $Properties

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

Parameters​

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns​

NexusOperationExecutionListInfo & $Properties

NexusOperationExecutionListInfo

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

Parameters​

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

Returns​

Writer

Writer


encodeDelimited​

▸ encodeDelimited(message, writer?): Writer

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

Parameters​

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

Returns​

Writer

Writer


fromObject​

▸ fromObject(object): NexusOperationExecutionListInfo

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

Parameters​

NameTypeDescription
objectObjectPlain object

Returns​

NexusOperationExecutionListInfo

NexusOperationExecutionListInfo


toObject​

▸ toObject(message, options?): Object

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

Parameters​

NameTypeDescription
messageNexusOperationExecutionListInfoNexusOperationExecutionListInfo
options?IConversionOptionsConversion options

Returns​

Object

Plain object