Skip to main content

Class: ActivityExecutionInfo

Information about a standalone activity.

Properties​

activityId​

activityId: string

Unique identifier of this activity within its namespace along with run ID (below).

activityType?​

optional activityType?: $Properties | null

The type of the activity, a string that maps to a registered activity on a worker.

attempt​

attempt: number

The attempt this activity is currently on. Incremented each time a new attempt is scheduled.

canceledReason​

canceledReason: string

Set if activity cancelation was requested.

closeTime?​

optional closeTime?: $Properties | null

Time when the activity transitioned to a closed state.

currentRetryInterval?​

optional currentRetryInterval?: $Properties | null

Time from the last attempt failure to the next activity retry. If the activity is currently running, this represents the next retry interval in case the attempt fails. If activity is currently backing off between attempt, this represents the current retry interval. If there is no next retry allowed, this field will be null. This interval is typically calculated from the specified retry policy, but may be modified if an activity fails with a retryable application failure specifying a retry delay.

eagerExecutionAccepted​

eagerExecutionAccepted: boolean

Indicates whether eager execution was requested for this activity and accepted by the server for its first task.

executionDuration?​

optional executionDuration?: $Properties | null

How long this activity has been running for, including all attempts and backoff between attempts.

executionTime?​

optional executionTime?: $Properties | null

The time at which the first activity task is made available for dispatch, computed as schedule_time + start_delay. Same as schedule_time if start_delay is not set.

expirationTime?​

optional expirationTime?: $Properties | null

The time at which the activity's Schedule-to-Close timeout expires. Calculated as schedule_time + start_delay + schedule_to_close_timeout.

optional header?: $Properties | null

ActivityExecutionInfo header.

heartbeatDetails?​

optional heartbeatDetails?: $Properties | null

Details provided in the last recorded activity heartbeat. DescribeActivityExecution does not set this field unless include_heartbeat_details was true in the request.

heartbeatTimeout?​

optional heartbeatTimeout?: $Properties | null

Maximum permitted time between successful worker heartbeats.

lastAttemptCompleteTime?​

optional lastAttemptCompleteTime?: $Properties | null

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

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

Failure details from the last failed attempt. DescribeActivityExecution does not set this field unless include_last_failure was true in the request.

lastHeartbeatTime?​

optional lastHeartbeatTime?: $Properties | null

Time the last heartbeat was recorded.

lastStartedTime?​

optional lastStartedTime?: $Properties | null

Time the last attempt was started.

lastWorkerIdentity​

lastWorkerIdentity: string

ActivityExecutionInfo lastWorkerIdentity.

links: $Properties[]

Links to related entities, such as the entity that started this activity.

nextAttemptScheduleTime?​

optional nextAttemptScheduleTime?: $Properties | null

The time when the next activity attempt will be scheduled. If activity is currently scheduled or started, this field will be null.

priority?​

optional priority?: $Properties | null

Priority metadata.

propagatedNexusSerializationContext?​

optional propagatedNexusSerializationContext?: $Properties | null

Serialization context propagated from the Nexus caller that started this activity.

retryPolicy?​

optional retryPolicy?: $Properties | null

The retry policy for the activity. Will never exceed schedule_to_close_timeout.

runId​

runId: string

ActivityExecutionInfo runId.

runState​

runState: PendingActivityState

More detailed breakdown of ACTIVITY_EXECUTION_STATUS_RUNNING.

scheduleTime?​

optional scheduleTime?: $Properties | null

Time the activity was originally scheduled via a StartActivityExecution request.

scheduleToCloseTimeout?​

optional scheduleToCloseTimeout?: $Properties | null

Indicates how long the caller is willing to wait for an activity completion. Limits how long retries will be attempted.

(-- api-linter: core::0140::prepositions=disabled aip.dev/not-precedent: "to" is used to indicate interval. --)

scheduleToStartTimeout?​

optional scheduleToStartTimeout?: $Properties | null

Limits time an activity task can stay in a task queue before a worker picks it up. This timeout is always non retryable, as all a retry would achieve is to put it back into the same queue. Defaults to schedule_to_close_timeout.

(-- api-linter: core::0140::prepositions=disabled aip.dev/not-precedent: "to" is used to indicate interval. --)

sdkName​

sdkName: string

The name of the SDK of the worker that most recently picked up an attempt of this activity. Overwritten on each new attempt. Empty if unknown.

sdkVersion​

sdkVersion: string

The version of the SDK of the worker that most recently picked up an attempt of this activity. Overwritten on each new attempt. Empty if unknown.

searchAttributes?​

optional searchAttributes?: $Properties | null

ActivityExecutionInfo searchAttributes.

startDelay?​

optional startDelay?: $Properties | null

Time to wait before making the first activity task available for dispatch. This delay is not applied to retry attempts.

startToCloseTimeout?​

optional startToCloseTimeout?: $Properties | null

Maximum time a single activity attempt is allowed to execute after being picked up by a worker. This timeout is always retryable.

(-- api-linter: core::0140::prepositions=disabled aip.dev/not-precedent: "to" is used to indicate interval. --)

stateSizeBytes​

stateSizeBytes: Long

Updated once on scheduled and once on terminal status.

stateTransitionCount​

stateTransitionCount: Long

Incremented each time the activity's state is mutated in persistence.

status​

status: ActivityExecutionStatus

A general status for this activity, indicates whether it is currently running or in one of the terminal statuses.

taskQueue​

taskQueue: string

ActivityExecutionInfo taskQueue.

totalHeartbeatCount​

totalHeartbeatCount: Long

Total number of heartbeats recorded across all attempts of this activity, including retries.

userMetadata?​

optional userMetadata?: $Properties | null

Metadata for use by user interfaces to display the fixed as-of-start summary and details of the activity.

Methods​

toJSON()​

toJSON(): object

Converts this ActivityExecutionInfo to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): ActivityExecutionInfo & $Shape

Creates a new ActivityExecutionInfo instance using the specified properties.

Parameters​
properties?​

$Shape

Properties to set

Returns​

ActivityExecutionInfo & $Shape

ActivityExecutionInfo instance

Call Signature​

static create(properties?): ActivityExecutionInfo

Creates a new ActivityExecutionInfo instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

ActivityExecutionInfo

ActivityExecutionInfo instance

decode()​

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

Decodes an ActivityExecutionInfo 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​

ActivityExecutionInfo & $Shape

ActivityExecutionInfo

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): ActivityExecutionInfo & $Shape

Decodes an ActivityExecutionInfo message from the specified reader or buffer, length delimited.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

ActivityExecutionInfo & $Shape

ActivityExecutionInfo

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

Parameters​

message​

$Properties

ActivityExecutionInfo message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

ActivityExecutionInfo message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): ActivityExecutionInfo

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

Parameters​

object​

Plain object

Returns​

ActivityExecutionInfo

ActivityExecutionInfo

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

ActivityExecutionInfo

ActivityExecutionInfo

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object