Skip to main content

Interface: IActivityExecutionInfo

Properties of an ActivityExecutionInfo.

Extends​

Properties​

activityId?​

optional activityId?: string | null

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

Inherited from​

$Properties.activityId

activityType?​

optional activityType?: $Properties | null

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

Inherited from​

$Properties.activityType

attempt?​

optional attempt?: number | null

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

Inherited from​

$Properties.attempt

canceledReason?​

optional canceledReason?: string | null

Set if activity cancelation was requested.

Inherited from​

$Properties.canceledReason

closedByPrincipal?​

optional closedByPrincipal?: $Properties | null

Authenticated principal by which this activity execution was closed.

(-- api-linter: core::0140::prepositions=disabled aip.dev/not-precedent: "by" identifies the authenticated actor. --)

Inherited from​

$Properties.closedByPrincipal

closeTime?​

optional closeTime?: $Properties | null

Time when the activity transitioned to a closed state.

Inherited from​

$Properties.closeTime

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.

Inherited from​

$Properties.currentRetryInterval

eagerExecutionAccepted?​

optional eagerExecutionAccepted?: boolean | null

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

Inherited from​

$Properties.eagerExecutionAccepted

executionDuration?​

optional executionDuration?: $Properties | null

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

Inherited from​

$Properties.executionDuration

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.

Inherited from​

$Properties.executionTime

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.

Inherited from​

$Properties.expirationTime

optional header?: $Properties | null

ActivityExecutionInfo header

Inherited from​

$Properties.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.

Inherited from​

$Properties.heartbeatDetails

heartbeatTimeout?​

optional heartbeatTimeout?: $Properties | null

Maximum permitted time between successful worker heartbeats.

Inherited from​

$Properties.heartbeatTimeout

lastAttemptCompleteTime?​

optional lastAttemptCompleteTime?: $Properties | null

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

Inherited from​

$Properties.lastAttemptCompleteTime

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.

Inherited from​

$Properties.lastDeploymentVersion

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.

Inherited from​

$Properties.lastFailure

lastHeartbeatTime?​

optional lastHeartbeatTime?: $Properties | null

Time the last heartbeat was recorded.

Inherited from​

$Properties.lastHeartbeatTime

lastStartedTime?​

optional lastStartedTime?: $Properties | null

Time the last attempt was started.

Inherited from​

$Properties.lastStartedTime

lastWorkerIdentity?​

optional lastWorkerIdentity?: string | null

ActivityExecutionInfo lastWorkerIdentity

Inherited from​

$Properties.lastWorkerIdentity

lastWorkerPrincipal?​

optional lastWorkerPrincipal?: $Properties | null

Authenticated principal of the worker that most recently interacted with this activity execution.

Inherited from​

$Properties.lastWorkerPrincipal

optional links?: $Properties[] | null

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

Inherited from​

$Properties.links

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.

Inherited from​

$Properties.nextAttemptScheduleTime

priority?​

optional priority?: $Properties | null

Priority metadata.

Inherited from​

$Properties.priority

propagatedNexusSerializationContext?​

optional propagatedNexusSerializationContext?: $Properties | null

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

Inherited from​

$Properties.propagatedNexusSerializationContext

retryPolicy?​

optional retryPolicy?: $Properties | null

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

Inherited from​

$Properties.retryPolicy

runId?​

optional runId?: string | null

ActivityExecutionInfo runId

Inherited from​

$Properties.runId

runState?​

optional runState?: PendingActivityState | null

More detailed breakdown of ACTIVITY_EXECUTION_STATUS_RUNNING.

Inherited from​

$Properties.runState

scheduleTime?​

optional scheduleTime?: $Properties | null

Time the activity was originally scheduled via a StartActivityExecution request.

Inherited from​

$Properties.scheduleTime

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

Inherited from​

$Properties.scheduleToCloseTimeout

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

Inherited from​

$Properties.scheduleToStartTimeout

sdkName?​

optional sdkName?: string | null

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.

Inherited from​

$Properties.sdkName

sdkVersion?​

optional sdkVersion?: string | null

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.

Inherited from​

$Properties.sdkVersion

searchAttributes?​

optional searchAttributes?: $Properties | null

ActivityExecutionInfo searchAttributes

Inherited from​

$Properties.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.

Inherited from​

$Properties.startDelay

startedByPrincipal?​

optional startedByPrincipal?: $Properties | null

Authenticated principal by which this activity execution was started.

(-- api-linter: core::0140::prepositions=disabled aip.dev/not-precedent: "by" identifies the authenticated actor. --)

Inherited from​

$Properties.startedByPrincipal

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

Inherited from​

$Properties.startToCloseTimeout

stateSizeBytes?​

optional stateSizeBytes?: Long | null

Updated once on scheduled and once on terminal status.

Inherited from​

$Properties.stateSizeBytes

stateTransitionCount?​

optional stateTransitionCount?: Long | null

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

Inherited from​

$Properties.stateTransitionCount

status?​

optional status?: ActivityExecutionStatus | null

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

Inherited from​

$Properties.status

taskQueue?​

optional taskQueue?: string | null

ActivityExecutionInfo taskQueue

Inherited from​

$Properties.taskQueue

totalHeartbeatCount?​

optional totalHeartbeatCount?: Long | null

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

Inherited from​

$Properties.totalHeartbeatCount

userMetadata?​

optional userMetadata?: $Properties | null

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

Inherited from​

$Properties.userMetadata