Class: PendingNexusOperationInfo

workflow.v1.PendingNexusOperationInfo

PendingNexusOperationInfo contains the state of a pending Nexus operation.

Implements

• IPendingNexusOperationInfo

Constructors

constructor

• new PendingNexusOperationInfo(properties?): PendingNexusOperationInfo

Constructs a new PendingNexusOperationInfo.

Parameters

Name	Type	Description
properties?	IPendingNexusOperationInfo	Properties to set

Returns

PendingNexusOperationInfo

Properties

attempt

• attempt: number

The number of attempts made to deliver the start operation request. This number represents a minimum bound since the attempt is incremented after the request completes.

Implementation of

IPendingNexusOperationInfo.attempt

---

blockedReason

• blockedReason: string

If the state is BLOCKED, blocked reason provides additional information.

Implementation of

IPendingNexusOperationInfo.blockedReason

---

cancellationInfo

• Optional cancellationInfo: null | INexusOperationCancellationInfo

PendingNexusOperationInfo cancellationInfo.

Implementation of

IPendingNexusOperationInfo.cancellationInfo

---

endpoint

• endpoint: string

Endpoint name. Resolved to a URL via the cluster's endpoint registry.

Implementation of

IPendingNexusOperationInfo.endpoint

---

lastAttemptCompleteTime

• Optional lastAttemptCompleteTime: null | ITimestamp

The time when the last attempt completed.

Implementation of

IPendingNexusOperationInfo.lastAttemptCompleteTime

---

lastAttemptFailure

• Optional lastAttemptFailure: null | IFailure

The last attempt's failure, if any.

Implementation of

IPendingNexusOperationInfo.lastAttemptFailure

---

nextAttemptScheduleTime

• Optional nextAttemptScheduleTime: null | ITimestamp

The time when the next attempt is scheduled.

Implementation of

IPendingNexusOperationInfo.nextAttemptScheduleTime

---

operation

• operation: string

Operation name.

Implementation of

IPendingNexusOperationInfo.operation

---

operationId

• operationId: string

Operation ID. Only set for asynchronous operations after a successful StartOperation call.

Deprecated. Renamed to operation_token.

Implementation of

IPendingNexusOperationInfo.operationId

---

operationToken

• operationToken: string

Operation token. Only set for asynchronous operations after a successful StartOperation call.

Implementation of

IPendingNexusOperationInfo.operationToken

---

scheduleToCloseTimeout

• Optional scheduleToCloseTimeout: null | IDuration

Schedule-to-close timeout for this operation. This is the only timeout settable by a workflow. (-- api-linter: core::0140::prepositions=disabled aip.dev/not-precedent: "to" is used to indicate interval. --)

Implementation of

IPendingNexusOperationInfo.scheduleToCloseTimeout

---

scheduleToStartTimeout

• Optional scheduleToStartTimeout: null | IDuration

Schedule-to-start timeout for this operation. (-- api-linter: core::0140::prepositions=disabled aip.dev/not-precedent: "to" is used to indicate interval. --)

Implementation of

IPendingNexusOperationInfo.scheduleToStartTimeout

---

scheduledEventId

• scheduledEventId: Long

The event ID of the NexusOperationScheduled event. Can be used to correlate an operation in the DescribeWorkflowExecution response with workflow history.

Implementation of

IPendingNexusOperationInfo.scheduledEventId

---

scheduledTime

• Optional scheduledTime: null | ITimestamp

The time when the operation was scheduled.

Implementation of

IPendingNexusOperationInfo.scheduledTime

---

service

• service: string

Service name.

Implementation of

IPendingNexusOperationInfo.service

---

startToCloseTimeout

• Optional startToCloseTimeout: null | IDuration

Start-to-close timeout for this operation. (-- api-linter: core::0140::prepositions=disabled aip.dev/not-precedent: "to" is used to indicate interval. --)

Implementation of

IPendingNexusOperationInfo.startToCloseTimeout

---

state

• state: PendingNexusOperationState

PendingNexusOperationInfo state.

Implementation of

IPendingNexusOperationInfo.state

Methods

toJSON

▸ toJSON(): Object

Converts this PendingNexusOperationInfo to JSON.

Returns

Object

JSON object

---

create

▸ create(properties?): PendingNexusOperationInfo

Creates a new PendingNexusOperationInfo instance using the specified properties.

Parameters

Name	Type	Description
properties?	IPendingNexusOperationInfo	Properties to set

Returns

PendingNexusOperationInfo

PendingNexusOperationInfo instance

---

decode

▸ decode(reader, length?): PendingNexusOperationInfo

Decodes a PendingNexusOperationInfo message from the specified reader or buffer.

Parameters

Name	Type	Description
reader	Uint8Array | Reader	Reader or buffer to decode from
length?	number	Message length if known beforehand

Returns

PendingNexusOperationInfo

PendingNexusOperationInfo

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited

▸ decodeDelimited(reader): PendingNexusOperationInfo

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

Parameters

Name	Type	Description
reader	Uint8Array | Reader	Reader or buffer to decode from

Returns

PendingNexusOperationInfo

PendingNexusOperationInfo

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

Parameters

Name	Type	Description
message	IPendingNexusOperationInfo	PendingNexusOperationInfo message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

encodeDelimited

▸ encodeDelimited(message, writer?): Writer

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

Parameters

Name	Type	Description
message	IPendingNexusOperationInfo	PendingNexusOperationInfo message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

fromObject

▸ fromObject(object): PendingNexusOperationInfo

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

Parameters

Name	Type	Description
object	Object	Plain object

Returns

PendingNexusOperationInfo

PendingNexusOperationInfo

---

getTypeUrl

▸ getTypeUrl(typeUrlPrefix?): string

Gets the default type url for PendingNexusOperationInfo

Parameters

Name	Type	Description
typeUrlPrefix?	string	your custom typeUrlPrefix(default "type.googleapis.com")

Returns

string

The default type url

---

toObject

▸ toObject(message, options?): Object

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

Parameters

Name	Type	Description
message	PendingNexusOperationInfo	PendingNexusOperationInfo
options?	IConversionOptions	Conversion options

Returns

Object

Plain object