Skip to main content

Class: NexusOperationStartedEventAttributes

Event marking an asynchronous operation was started by the responding Nexus handler. If the operation completes synchronously, this event is not generated. In rare situations, such as request timeouts, the service may fail to record the actual start time and will fabricate this event upon receiving the operation completion via callback.

Properties​

operationId​

operationId: string

The operation ID returned by the Nexus handler in the response to the StartOperation request. This ID is used when canceling the operation.

Deprecated: Renamed to operation_token.

operationToken​

operationToken: string

The operation token returned by the Nexus handler in the response to the StartOperation request. This token is used when canceling the operation.

requestId​

requestId: string

The request ID allocated at schedule time.

scheduledEventId​

scheduledEventId: Long

The ID of the NEXUS_OPERATION_SCHEDULED event this task corresponds to.

Methods​

toJSON()​

toJSON(): object

Converts this NexusOperationStartedEventAttributes to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): NexusOperationStartedEventAttributes & $Properties

Creates a new NexusOperationStartedEventAttributes instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

NexusOperationStartedEventAttributes & $Properties

NexusOperationStartedEventAttributes instance

Call Signature​

static create(properties?): NexusOperationStartedEventAttributes

Creates a new NexusOperationStartedEventAttributes instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

NexusOperationStartedEventAttributes

NexusOperationStartedEventAttributes instance

decode()​

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

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

NexusOperationStartedEventAttributes & $Properties

NexusOperationStartedEventAttributes

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): NexusOperationStartedEventAttributes & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

NexusOperationStartedEventAttributes & $Properties

NexusOperationStartedEventAttributes

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

Parameters​

message​

$Properties

NexusOperationStartedEventAttributes message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

NexusOperationStartedEventAttributes message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): NexusOperationStartedEventAttributes

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

Parameters​

object​

Plain object

Returns​

NexusOperationStartedEventAttributes

NexusOperationStartedEventAttributes

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

NexusOperationStartedEventAttributes

NexusOperationStartedEventAttributes

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object