Skip to main content

Class: PendingActivityInfo

Represents a PendingActivityInfo.

Properties​

activityId​

activityId: string

PendingActivityInfo activityId.

activityOptions?​

optional activityOptions?: $Properties | null

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

activityType?​

optional activityType?: $Properties | null

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

currentRetryInterval?​

optional currentRetryInterval?: $Properties | null

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.

expirationTime?​

optional expirationTime?: $Properties | null

PendingActivityInfo expirationTime.

heartbeatDetails?​

optional heartbeatDetails?: $Properties | null

PendingActivityInfo heartbeatDetails.

lastAttemptCompleteTime?​

optional lastAttemptCompleteTime?: $Properties | null

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

lastDeployment?​

optional lastDeployment?: $Properties | null

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.

lastDeploymentVersion?​

optional lastDeploymentVersion?: $Properties | null

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.

lastFailure?​

optional lastFailure?: $Properties | null

PendingActivityInfo lastFailure.

lastHeartbeatTime?​

optional lastHeartbeatTime?: $Properties | null

PendingActivityInfo lastHeartbeatTime.

lastIndependentlyAssignedBuildId?​

optional lastIndependentlyAssignedBuildId?: string | null

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.

lastStartedTime?​

optional lastStartedTime?: $Properties | null

PendingActivityInfo lastStartedTime.

lastWorkerDeploymentVersion​

lastWorkerDeploymentVersion: string

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

lastWorkerIdentity​

lastWorkerIdentity: string

PendingActivityInfo lastWorkerIdentity.

lastWorkerVersionStamp?​

optional lastWorkerVersionStamp?: $Properties | null

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]

maximumAttempts​

maximumAttempts: number

PendingActivityInfo maximumAttempts.

nextAttemptScheduleTime?​

optional nextAttemptScheduleTime?: $Properties | null

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

paused​

paused: boolean

Indicates if activity is paused.

pauseInfo?​

optional pauseInfo?: $Properties | null

PendingActivityInfo pauseInfo.

priority?​

optional priority?: $Properties | null

Priority metadata. If this message is not present, or any fields are not present, they inherit the values from the workflow.

scheduledTime?​

optional scheduledTime?: $Properties | null

PendingActivityInfo scheduledTime.

state​

state: PendingActivityState

PendingActivityInfo state.

useWorkflowBuildId?​

optional useWorkflowBuildId?: $Properties | null

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

Methods​

toJSON()​

toJSON(): object

Converts this PendingActivityInfo to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): PendingActivityInfo & $Shape

Creates a new PendingActivityInfo instance using the specified properties.

Parameters​
properties?​

$Shape

Properties to set

Returns​

PendingActivityInfo & $Shape

PendingActivityInfo instance

Call Signature​

static create(properties?): PendingActivityInfo

Creates a new PendingActivityInfo instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

PendingActivityInfo

PendingActivityInfo instance

decode()​

static decode(reader, length?): PendingActivityInfo & $Shape

Decodes a PendingActivityInfo message from the specified reader or buffer.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

length?​

number

Message length if known beforehand

Returns​

PendingActivityInfo & $Shape

PendingActivityInfo

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): PendingActivityInfo & $Shape

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

PendingActivityInfo & $Shape

PendingActivityInfo

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

encode()​

static encode(message, writer?): Writer

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

Parameters​

message​

$Properties

PendingActivityInfo message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

PendingActivityInfo message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): PendingActivityInfo

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

Parameters​

object​

Plain object

Returns​

PendingActivityInfo

PendingActivityInfo

toObject()​

static toObject(message, options?): object

Creates a plain object from a PendingActivityInfo message. Also converts values to other types if specified.

Parameters​

message​

PendingActivityInfo

PendingActivityInfo

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object