Class: NexusOperationExecutionCancellationInfo
nexus.v1.NexusOperationExecutionCancellationInfo
NexusOperationExecutionCancellationInfo contains the state of a Nexus operation cancellation.
Properties
attempt
• attempt: number
The number of attempts made to deliver the cancel operation request. This number represents a minimum bound since the attempt is incremented after the request completes.
blockedReason
• blockedReason: string
If the state is BLOCKED, blocked reason provides additional information.
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.
reason
• reason: string
A reason that may be specified in the CancelNexusOperationRequest.
requestedTime
• Optional requestedTime: null | $Properties
The time when cancellation was requested.
state
• state: NexusOperationCancellationState
NexusOperationExecutionCancellationInfo state.
Methods
toJSON
▸ toJSON(): Object
Converts this NexusOperationExecutionCancellationInfo to JSON.
Returns
Object
JSON object
create
▸ create(properties?): NexusOperationExecutionCancellationInfo & $Shape
Creates a new NexusOperationExecutionCancellationInfo instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Shape | Properties to set |
Returns
NexusOperationExecutionCancellationInfo & $Shape
NexusOperationExecutionCancellationInfo instance
▸ create(properties?): NexusOperationExecutionCancellationInfo
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
NexusOperationExecutionCancellationInfo
decode
▸ decode(reader, length?): NexusOperationExecutionCancellationInfo & $Shape
Decodes a NexusOperationExecutionCancellationInfo 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
NexusOperationExecutionCancellationInfo & $Shape
NexusOperationExecutionCancellationInfo
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): NexusOperationExecutionCancellationInfo & $Shape
Decodes a NexusOperationExecutionCancellationInfo message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
NexusOperationExecutionCancellationInfo & $Shape
NexusOperationExecutionCancellationInfo
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 NexusOperationExecutionCancellationInfo message. Does not implicitly temporal.api.nexus.v1.NexusOperationExecutionCancellationInfo.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | NexusOperationExecutionCancellationInfo message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified NexusOperationExecutionCancellationInfo message, length delimited. Does not implicitly temporal.api.nexus.v1.NexusOperationExecutionCancellationInfo.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | NexusOperationExecutionCancellationInfo message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): NexusOperationExecutionCancellationInfo
Creates a NexusOperationExecutionCancellationInfo message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
NexusOperationExecutionCancellationInfo
NexusOperationExecutionCancellationInfo
toObject
▸ toObject(message, options?): Object
Creates a plain object from a NexusOperationExecutionCancellationInfo message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | NexusOperationExecutionCancellationInfo | NexusOperationExecutionCancellationInfo |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object