Class: NexusOperationCancellationInfo
workflow.v1.NexusOperationCancellationInfo
NexusOperationCancellationInfo contains the state of a nexus operation cancellation.
Implements
Constructors
constructor
• new NexusOperationCancellationInfo(properties?): NexusOperationCancellationInfo
Constructs a new NexusOperationCancellationInfo.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | INexusOperationCancellationInfo | Properties to set |
Returns
NexusOperationCancellationInfo
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.
Implementation of
INexusOperationCancellationInfo.attempt
blockedReason
• blockedReason: string
If the state is BLOCKED, blocked reason provides additional information.
Implementation of
INexusOperationCancellationInfo.blockedReason
lastAttemptCompleteTime
• Optional lastAttemptCompleteTime: null | ITimestamp
The time when the last attempt completed.
Implementation of
INexusOperationCancellationInfo.lastAttemptCompleteTime
lastAttemptFailure
• Optional lastAttemptFailure: null | IFailure
The last attempt's failure, if any.
Implementation of
INexusOperationCancellationInfo.lastAttemptFailure
nextAttemptScheduleTime
• Optional nextAttemptScheduleTime: null | ITimestamp
The time when the next attempt is scheduled.
Implementation of
INexusOperationCancellationInfo.nextAttemptScheduleTime
requestedTime
• Optional requestedTime: null | ITimestamp
The time when cancellation was requested.
Implementation of
INexusOperationCancellationInfo.requestedTime
state
• state: NexusOperationCancellationState
NexusOperationCancellationInfo state.
Implementation of
INexusOperationCancellationInfo.state
Methods
toJSON
▸ toJSON(): Object
Converts this NexusOperationCancellationInfo to JSON.
Returns
Object
JSON object
create
▸ create(properties?): NexusOperationCancellationInfo
Creates a new NexusOperationCancellationInfo instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | INexusOperationCancellationInfo | Properties to set |
Returns
NexusOperationCancellationInfo
NexusOperationCancellationInfo instance
decode
▸ decode(reader, length?): NexusOperationCancellationInfo
Decodes a NexusOperationCancellationInfo 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
NexusOperationCancellationInfo
NexusOperationCancellationInfo
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): NexusOperationCancellationInfo
Decodes a NexusOperationCancellationInfo message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
NexusOperationCancellationInfo
NexusOperationCancellationInfo
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 NexusOperationCancellationInfo message. Does not implicitly temporal.api.workflow.v1.NexusOperationCancellationInfo.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | INexusOperationCancellationInfo | NexusOperationCancellationInfo message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified NexusOperationCancellationInfo message, length delimited. Does not implicitly temporal.api.workflow.v1.NexusOperationCancellationInfo.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | INexusOperationCancellationInfo | NexusOperationCancellationInfo message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): NexusOperationCancellationInfo
Creates a NexusOperationCancellationInfo message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
NexusOperationCancellationInfo
NexusOperationCancellationInfo
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for NexusOperationCancellationInfo
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 NexusOperationCancellationInfo message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | NexusOperationCancellationInfo | NexusOperationCancellationInfo |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object