Class: CallbackInfo
Common callback information. Specific CallbackInfo messages should embed this and may include additional fields.
Properties
attempt
• attempt: number
The number of attempts made to deliver the callback. This number represents a minimum bound since the attempt is incremented after the callback request completes.
blockedReason
• blockedReason: string
If the state is BLOCKED, blocked reason provides additional information.
callback
• Optional callback: null | $Properties
Information on how this callback should be invoked (e.g. its URL and type).
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.
registrationTime
• Optional registrationTime: null | $Properties
The time when the callback was registered.
requestId
• requestId: string
Server-generated request ID used as an idempotency token when invoking callbacks. It has no relation to caller-side request_id sent in operations like StartNexusOperationExecutionRequest.
state
• state: CallbackState
The current state of the callback.
Methods
toJSON
▸ toJSON(): Object
Converts this CallbackInfo to JSON.
Returns
Object
JSON object
create
▸ create(properties?): CallbackInfo & $Shape
Creates a new CallbackInfo instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Shape | Properties to set |
Returns
CallbackInfo instance
▸ create(properties?): CallbackInfo
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
decode
▸ decode(reader, length?): CallbackInfo & $Shape
Decodes a CallbackInfo 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
CallbackInfo
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): CallbackInfo & $Shape
Decodes a CallbackInfo message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
CallbackInfo
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 CallbackInfo message. Does not implicitly temporal.api.callback.v1.CallbackInfo.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | CallbackInfo message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified CallbackInfo message, length delimited. Does not implicitly temporal.api.callback.v1.CallbackInfo.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | CallbackInfo message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): CallbackInfo
Creates a CallbackInfo message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
CallbackInfo
toObject
▸ toObject(message, options?): Object
Creates a plain object from a CallbackInfo message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | CallbackInfo | CallbackInfo |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object