Class: PendingActivityInfo

workflow.v1.PendingActivityInfo

Represents a PendingActivityInfo.

Implements

• IPendingActivityInfo

Constructors

constructor

• new PendingActivityInfo(properties?): PendingActivityInfo

Constructs a new PendingActivityInfo.

Parameters

Name	Type	Description
properties?	IPendingActivityInfo	Properties to set

Returns

PendingActivityInfo

Properties

activityId

• activityId: string

PendingActivityInfo activityId.

Implementation of

IPendingActivityInfo.activityId

---

activityOptions

• Optional activityOptions: null | IActivityOptions

Current activity options. May be different from the one used to start the activity.

Implementation of

IPendingActivityInfo.activityOptions

---

activityType

• Optional activityType: null | IActivityType

PendingActivityInfo activityType.

Implementation of

IPendingActivityInfo.activityType

---

assignedBuildId

• Optional assignedBuildId: "useWorkflowBuildId" | "lastIndependentlyAssignedBuildId"

Absence of assigned_build_id generally means this task is on an "unversioned" task queue. In rare cases, it can also mean that the task queue is versioned but we failed to write activity's independently-assigned build ID to the database. This case heals automatically once the task is dispatched. Deprecated. This field should be cleaned up when versioning-2 API is removed. [cleanup-experimental-wv]

---

attempt

• attempt: number

PendingActivityInfo attempt.

Implementation of

IPendingActivityInfo.attempt

---

currentRetryInterval

• Optional currentRetryInterval: null | IDuration

The time activity will wait until the next retry. If activity is currently running it will be next retry interval if activity failed. If activity is currently waiting it will be current retry interval. If there will be no retry it will be null.

Implementation of

IPendingActivityInfo.currentRetryInterval

---

expirationTime

• Optional expirationTime: null | ITimestamp

PendingActivityInfo expirationTime.

Implementation of

IPendingActivityInfo.expirationTime

---

heartbeatDetails

• Optional heartbeatDetails: null | IPayloads

PendingActivityInfo heartbeatDetails.

Implementation of

IPendingActivityInfo.heartbeatDetails

---

lastAttemptCompleteTime

• Optional lastAttemptCompleteTime: null | ITimestamp

The time when the last activity attempt was completed. If activity has not been completed yet then it will be null.

Implementation of

IPendingActivityInfo.lastAttemptCompleteTime

---

lastDeployment

• Optional lastDeployment: null | IDeployment

The deployment this activity was dispatched to most recently. Present only if the activity was dispatched to a versioned worker. Deprecated. Use last_deployment_version.

Implementation of

IPendingActivityInfo.lastDeployment

---

lastDeploymentVersion

• Optional lastDeploymentVersion: null | IWorkerDeploymentVersion

The Worker Deployment Version this activity was dispatched to most recently. If nil, the activity has not yet been dispatched or was last dispatched to an unversioned worker.

Implementation of

IPendingActivityInfo.lastDeploymentVersion

---

lastFailure

• Optional lastFailure: null | IFailure

PendingActivityInfo lastFailure.

Implementation of

IPendingActivityInfo.lastFailure

---

lastHeartbeatTime

• Optional lastHeartbeatTime: null | ITimestamp

PendingActivityInfo lastHeartbeatTime.

Implementation of

IPendingActivityInfo.lastHeartbeatTime

---

lastIndependentlyAssignedBuildId

• Optional lastIndependentlyAssignedBuildId: null | string

Deprecated. This means the activity is independently versioned and not bound to the build ID of its workflow. The activity will use the build id in this field instead. If the task fails and is scheduled again, the assigned build ID may change according to the latest versioning rules.

Implementation of

IPendingActivityInfo.lastIndependentlyAssignedBuildId

---

lastStartedTime

• Optional lastStartedTime: null | ITimestamp

PendingActivityInfo lastStartedTime.

Implementation of

IPendingActivityInfo.lastStartedTime

---

lastWorkerDeploymentVersion

• lastWorkerDeploymentVersion: string

The Worker Deployment Version this activity was dispatched to most recently. Deprecated. Use last_deployment_version.

Implementation of

IPendingActivityInfo.lastWorkerDeploymentVersion

---

lastWorkerIdentity

• lastWorkerIdentity: string

PendingActivityInfo lastWorkerIdentity.

Implementation of

IPendingActivityInfo.lastWorkerIdentity

---

lastWorkerVersionStamp

• Optional lastWorkerVersionStamp: null | IWorkerVersionStamp

Deprecated. The version stamp of the worker to whom this activity was most recently dispatched This field should be cleaned up when versioning-2 API is removed. [cleanup-experimental-wv]

Implementation of

IPendingActivityInfo.lastWorkerVersionStamp

---

maximumAttempts

• maximumAttempts: number

PendingActivityInfo maximumAttempts.

Implementation of

IPendingActivityInfo.maximumAttempts

---

nextAttemptScheduleTime

• Optional nextAttemptScheduleTime: null | ITimestamp

Next time when activity will be scheduled. If activity is currently scheduled or started it will be null.

Implementation of

IPendingActivityInfo.nextAttemptScheduleTime

---

pauseInfo

• Optional pauseInfo: null | IPauseInfo

PendingActivityInfo pauseInfo.

Implementation of

IPendingActivityInfo.pauseInfo

---

paused

• paused: boolean

Indicates if activity is paused.

Implementation of

IPendingActivityInfo.paused

---

priority

• Optional priority: null | IPriority

Priority metadata

Implementation of

IPendingActivityInfo.priority

---

scheduledTime

• Optional scheduledTime: null | ITimestamp

PendingActivityInfo scheduledTime.

Implementation of

IPendingActivityInfo.scheduledTime

---

state

• state: PendingActivityState

PendingActivityInfo state.

Implementation of

IPendingActivityInfo.state

---

useWorkflowBuildId

• Optional useWorkflowBuildId: null | IEmpty

Deprecated. When present, it means this activity is assigned to the build ID of its workflow.

Implementation of

IPendingActivityInfo.useWorkflowBuildId

Methods

toJSON

▸ toJSON(): Object

Converts this PendingActivityInfo to JSON.

Returns

Object

JSON object

---

create

▸ create(properties?): PendingActivityInfo

Creates a new PendingActivityInfo instance using the specified properties.

Parameters

Name	Type	Description
properties?	IPendingActivityInfo	Properties to set

Returns

PendingActivityInfo

PendingActivityInfo instance

---

decode

▸ decode(reader, length?): PendingActivityInfo

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

PendingActivityInfo

PendingActivityInfo

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited

▸ decodeDelimited(reader): PendingActivityInfo

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

Parameters

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

Returns

PendingActivityInfo

PendingActivityInfo

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

Parameters

Name	Type	Description
message	IPendingActivityInfo	PendingActivityInfo message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

encodeDelimited

▸ encodeDelimited(message, writer?): Writer

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

Parameters

Name	Type	Description
message	IPendingActivityInfo	PendingActivityInfo message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

fromObject

▸ fromObject(object): PendingActivityInfo

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

Parameters

Name	Type	Description
object	Object	Plain object

Returns

PendingActivityInfo

PendingActivityInfo

---

getTypeUrl

▸ getTypeUrl(typeUrlPrefix?): string

Gets the default type url for PendingActivityInfo

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

Parameters

Name	Type	Description
message	PendingActivityInfo	PendingActivityInfo
options?	IConversionOptions	Conversion options

Returns

Object

Plain object