Class: CallbackInfo

workflow.v1.CallbackInfo

CallbackInfo contains the state of an attached workflow callback.

Implements

• ICallbackInfo

Constructors

constructor

• new CallbackInfo(properties?): CallbackInfo

Constructs a new CallbackInfo.

Parameters

Name	Type	Description
properties?	ICallbackInfo	Properties to set

Returns

CallbackInfo

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.

Implementation of

ICallbackInfo.attempt

---

blockedReason

• blockedReason: string

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

Implementation of

ICallbackInfo.blockedReason

---

callback

• Optional callback: null | ICallback

Information on how this callback should be invoked (e.g. its URL and type).

Implementation of

ICallbackInfo.callback

---

lastAttemptCompleteTime

• Optional lastAttemptCompleteTime: null | ITimestamp

The time when the last attempt completed.

Implementation of

ICallbackInfo.lastAttemptCompleteTime

---

lastAttemptFailure

• Optional lastAttemptFailure: null | IFailure

The last attempt's failure, if any.

Implementation of

ICallbackInfo.lastAttemptFailure

---

nextAttemptScheduleTime

• Optional nextAttemptScheduleTime: null | ITimestamp

The time when the next attempt is scheduled.

Implementation of

ICallbackInfo.nextAttemptScheduleTime

---

registrationTime

• Optional registrationTime: null | ITimestamp

The time when the callback was registered.

Implementation of

ICallbackInfo.registrationTime

---

state

• state: CallbackState

CallbackInfo state.

Implementation of

ICallbackInfo.state

---

trigger

• Optional trigger: null | ITrigger

Trigger for this callback.

Implementation of

ICallbackInfo.trigger

Methods

toJSON

▸ toJSON(): Object

Converts this CallbackInfo to JSON.

Returns

Object

JSON object

---

create

▸ create(properties?): CallbackInfo

Creates a new CallbackInfo instance using the specified properties.

Parameters

Name	Type	Description
properties?	ICallbackInfo	Properties to set

Returns

CallbackInfo

CallbackInfo instance

---

decode

▸ decode(reader, length?): CallbackInfo

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

CallbackInfo

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited

▸ decodeDelimited(reader): CallbackInfo

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

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.workflow.v1.CallbackInfo.verify|verify messages.

Parameters

Name	Type	Description
message	ICallbackInfo	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.workflow.v1.CallbackInfo.verify|verify messages.

Parameters

Name	Type	Description
message	ICallbackInfo	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

CallbackInfo

---

getTypeUrl

▸ getTypeUrl(typeUrlPrefix?): string

Gets the default type url for CallbackInfo

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 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