Interface: IActivityExecutionInfo
activity.v1.IActivityExecutionInfo
Properties of an ActivityExecutionInfo.
Hierarchy
-
↳
IActivityExecutionInfo
Properties
activityId
• Optional activityId: null | string
Unique identifier of this activity within its namespace along with run ID (below).
Inherited from
activityType
• Optional activityType: null | $Properties
The type of the activity, a string that maps to a registered activity on a worker.
Inherited from
attempt
• Optional attempt: null | number
The attempt this activity is currently on. Incremented each time a new attempt is scheduled.
Inherited from
canceledReason
• Optional canceledReason: null | string
Set if activity cancelation was requested.
Inherited from
closeTime
• Optional closeTime: null | $Properties
Time when the activity transitioned to a closed state.
Inherited from
currentRetryInterval
• Optional currentRetryInterval: null | $Properties
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
executionDuration
• Optional executionDuration: null | $Properties
How long this activity has been running for, including all attempts and backoff between attempts.
Inherited from
executionTime
• Optional executionTime: null | $Properties
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
expirationTime
• Optional expirationTime: null | $Properties
The time at which the activity's Schedule-to-Close timeout expires.
Calculated as schedule_time + start_delay + schedule_to_close_timeout.
Inherited from
header
• Optional header: null | $Properties
ActivityExecutionInfo header
Inherited from
heartbeatDetails
• Optional heartbeatDetails: null | $Properties
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
heartbeatTimeout
• Optional heartbeatTimeout: null | $Properties
Maximum permitted time between successful worker heartbeats.
Inherited from
lastAttemptCompleteTime
• Optional lastAttemptCompleteTime: null | $Properties
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: null | $Properties
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: null | $Properties
Failure details from the last failed attempt. DescribeActivityExecution does not set this field unless include_last_failure was true in the request.
Inherited from
lastHeartbeatTime
• Optional lastHeartbeatTime: null | $Properties
Time the last heartbeat was recorded.
Inherited from
lastStartedTime
• Optional lastStartedTime: null | $Properties
Time the last attempt was started.
Inherited from
lastWorkerIdentity
• Optional lastWorkerIdentity: null | string
ActivityExecutionInfo lastWorkerIdentity
Inherited from
$Properties.lastWorkerIdentity
links
• Optional links: null | $Properties[]
Links to related entities, such as the entity that started this activity.
Inherited from
nextAttemptScheduleTime
• Optional nextAttemptScheduleTime: null | $Properties
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: null | $Properties
Priority metadata.
Inherited from
retryPolicy
• Optional retryPolicy: null | $Properties
The retry policy for the activity. Will never exceed schedule_to_close_timeout.
Inherited from
runId
• Optional runId: null | string
ActivityExecutionInfo runId
Inherited from
runState
• Optional runState: null | PendingActivityState
More detailed breakdown of ACTIVITY_EXECUTION_STATUS_RUNNING.
Inherited from
scheduleTime
• Optional scheduleTime: null | $Properties
Time the activity was originally scheduled via a StartActivityExecution request.
Inherited from
scheduleToCloseTimeout
• Optional scheduleToCloseTimeout: null | $Properties
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: null | $Properties
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: null | 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.
Inherited from
sdkVersion
• Optional sdkVersion: null | 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.
Inherited from
searchAttributes
• Optional searchAttributes: null | $Properties
ActivityExecutionInfo searchAttributes
Inherited from
startDelay
• Optional startDelay: null | $Properties
Time to wait before making the first activity task available for dispatch. This delay is not applied to retry attempts.
Inherited from
startToCloseTimeout
• Optional startToCloseTimeout: null | $Properties
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: null | Long
Updated once on scheduled and once on terminal status.
Inherited from
stateTransitionCount
• Optional stateTransitionCount: null | Long
Incremented each time the activity's state is mutated in persistence.
Inherited from
$Properties.stateTransitionCount
status
• Optional status: null | ActivityExecutionStatus
A general status for this activity, indicates whether it is currently running or in one of the terminal statuses.
Inherited from
taskQueue
• Optional taskQueue: null | string
ActivityExecutionInfo taskQueue
Inherited from
totalHeartbeatCount
• Optional totalHeartbeatCount: null | Long
Total number of heartbeats recorded across all attempts of this activity, including retries.
Inherited from
$Properties.totalHeartbeatCount
userMetadata
• Optional userMetadata: null | $Properties
Metadata for use by user interfaces to display the fixed as-of-start summary and details of the activity.