Class: PendingNexusOperationInfo
workflow.v1.PendingNexusOperationInfo
PendingNexusOperationInfo contains the state of a pending Nexus operation.
Properties
attempt
• attempt: number
The number of attempts made to deliver the start operation request. This number is approximate, it is incremented when a task is added to the history queue. In practice, there could be more attempts if a task is executed but fails to commit, or less attempts if a task was never executed.
blockedReason
• blockedReason: string
If the state is BLOCKED, blocked reason provides additional information.
cancellationInfo
• Optional cancellationInfo: null | $Properties
PendingNexusOperationInfo cancellationInfo.
endpoint
• endpoint: string
Endpoint name. Resolved to a URL via the cluster's endpoint registry.
lastAttemptCompleteTime
• Optional lastAttemptCompleteTime: null | $Properties
The time when the last attempt completed.
lastAttemptFailure
• Optional lastAttemptFailure: null | $Properties
The last attempt's failure, if any.
nextAttemptScheduleTime
• Optional nextAttemptScheduleTime: null | $Properties
The time when the next attempt is scheduled.
operation
• operation: string
Operation name.
operationId
• operationId: string
Operation ID. Only set for asynchronous operations after a successful StartOperation call.
Deprecated. Renamed to operation_token.
operationToken
• operationToken: string
Operation token. Only set for asynchronous operations after a successful StartOperation call.
scheduleToCloseTimeout
• Optional scheduleToCloseTimeout: null | $Properties
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. --)
scheduleToStartTimeout
• Optional scheduleToStartTimeout: null | $Properties
Schedule-to-start timeout for this operation. (-- api-linter: core::0140::prepositions=disabled aip.dev/not-precedent: "to" is used to indicate interval. --)
scheduledEventId
• scheduledEventId: Long
The event ID of the NexusOperationScheduled event. Can be used to correlate an operation in the DescribeWorkflowExecution response with workflow history.
scheduledTime
• Optional scheduledTime: null | $Properties
The time when the operation was scheduled.
service
• service: string
Service name.
startToCloseTimeout
• Optional startToCloseTimeout: null | $Properties
Start-to-close timeout for this operation. (-- api-linter: core::0140::prepositions=disabled aip.dev/not-precedent: "to" is used to indicate interval. --)
state
• state: PendingNexusOperationState
PendingNexusOperationInfo state.
Methods
toJSON
▸ toJSON(): Object
Converts this PendingNexusOperationInfo to JSON.
Returns
Object
JSON object
create
▸ create(properties?): PendingNexusOperationInfo & $Shape
Creates a new PendingNexusOperationInfo instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Shape | Properties to set |
Returns
PendingNexusOperationInfo & $Shape
PendingNexusOperationInfo instance
▸ create(properties?): PendingNexusOperationInfo
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
decode
▸ decode(reader, length?): PendingNexusOperationInfo & $Shape
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 & $Shape
PendingNexusOperationInfo
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): PendingNexusOperationInfo & $Shape
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 & $Shape
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 | $Properties | 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 | $Properties | 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
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