Class: PendingWorkflowTaskInfo

workflow.v1.PendingWorkflowTaskInfo

Represents a PendingWorkflowTaskInfo.

Implements

• IPendingWorkflowTaskInfo

Constructors

constructor

• new PendingWorkflowTaskInfo(properties?): PendingWorkflowTaskInfo

Constructs a new PendingWorkflowTaskInfo.

Parameters

Name	Type	Description
properties?	IPendingWorkflowTaskInfo	Properties to set

Returns

PendingWorkflowTaskInfo

Properties

attempt

• attempt: number

PendingWorkflowTaskInfo attempt.

Implementation of

IPendingWorkflowTaskInfo.attempt

---

originalScheduledTime

• Optional originalScheduledTime: null | ITimestamp

original_scheduled_time is the scheduled time of the first workflow task during workflow task heartbeat. Heartbeat workflow task is done by RespondWorkflowTaskComplete with ForceCreateNewWorkflowTask == true and no command In this case, OriginalScheduledTime won't change. Then when current time - original_scheduled_time exceeds some threshold, the workflow task will be forced timeout.

Implementation of

IPendingWorkflowTaskInfo.originalScheduledTime

---

scheduledTime

• Optional scheduledTime: null | ITimestamp

PendingWorkflowTaskInfo scheduledTime.

Implementation of

IPendingWorkflowTaskInfo.scheduledTime

---

startedTime

• Optional startedTime: null | ITimestamp

PendingWorkflowTaskInfo startedTime.

Implementation of

IPendingWorkflowTaskInfo.startedTime

---

state

• state: PendingWorkflowTaskState

PendingWorkflowTaskInfo state.

Implementation of

IPendingWorkflowTaskInfo.state

Methods

toJSON

▸ toJSON(): Object

Converts this PendingWorkflowTaskInfo to JSON.

Returns

Object

JSON object

---

create

▸ create(properties?): PendingWorkflowTaskInfo

Creates a new PendingWorkflowTaskInfo instance using the specified properties.

Parameters

Name	Type	Description
properties?	IPendingWorkflowTaskInfo	Properties to set

Returns

PendingWorkflowTaskInfo

PendingWorkflowTaskInfo instance

---

decode

▸ decode(reader, length?): PendingWorkflowTaskInfo

Decodes a PendingWorkflowTaskInfo 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

PendingWorkflowTaskInfo

PendingWorkflowTaskInfo

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited

▸ decodeDelimited(reader): PendingWorkflowTaskInfo

Decodes a PendingWorkflowTaskInfo message from the specified reader or buffer, length delimited.

Parameters

Name	Type	Description
reader	Uint8Array | Reader	Reader or buffer to decode from

Returns

PendingWorkflowTaskInfo

PendingWorkflowTaskInfo

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 PendingWorkflowTaskInfo message. Does not implicitly temporal.api.workflow.v1.PendingWorkflowTaskInfo.verify|verify messages.

Parameters

Name	Type	Description
message	IPendingWorkflowTaskInfo	PendingWorkflowTaskInfo message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

encodeDelimited

▸ encodeDelimited(message, writer?): Writer

Encodes the specified PendingWorkflowTaskInfo message, length delimited. Does not implicitly temporal.api.workflow.v1.PendingWorkflowTaskInfo.verify|verify messages.

Parameters

Name	Type	Description
message	IPendingWorkflowTaskInfo	PendingWorkflowTaskInfo message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

fromObject

▸ fromObject(object): PendingWorkflowTaskInfo

Creates a PendingWorkflowTaskInfo message from a plain object. Also converts values to their respective internal types.

Parameters

Name	Type	Description
object	Object	Plain object

Returns

PendingWorkflowTaskInfo

PendingWorkflowTaskInfo

---

getTypeUrl

▸ getTypeUrl(typeUrlPrefix?): string

Gets the default type url for PendingWorkflowTaskInfo

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 PendingWorkflowTaskInfo message. Also converts values to other types if specified.

Parameters

Name	Type	Description
message	PendingWorkflowTaskInfo	PendingWorkflowTaskInfo
options?	IConversionOptions	Conversion options

Returns

Object

Plain object