package temporal.api.activity.v1
Get desktop application:
View/edit binary Protocol Buffers messages
message
message.proto:69Information about a standalone activity.
Used in:
string activity_id = 1
Unique identifier of this activity within its namespace along with run ID (below).
string run_id = 2
optional activity_type = 3
The type of the activity, a string that maps to a registered activity on a worker.
enums.v1.ActivityExecutionStatus status = 4
A general status for this activity, indicates whether it is currently running or in one of the terminal statuses.
enums.v1.PendingActivityState run_state = 5
More detailed breakdown of ACTIVITY_EXECUTION_STATUS_RUNNING.
string task_queue = 6
optional schedule_to_close_timeout = 7
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. --)
optional schedule_to_start_timeout = 8
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. --)
optional start_to_close_timeout = 9
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. --)
optional heartbeat_timeout = 10
Maximum permitted time between successful worker heartbeats.
optional retry_policy = 11
The retry policy for the activity. Will never exceed `schedule_to_close_timeout`.
optional heartbeat_details = 12
Details provided in the last recorded activity heartbeat. DescribeActivityExecution does not set this field unless include_heartbeat_details was true in the request.
optional last_heartbeat_time = 13
Time the last heartbeat was recorded.
optional last_started_time = 14
Time the last attempt was started.
int32 attempt = 15
The attempt this activity is currently on. Incremented each time a new attempt is scheduled.
optional execution_duration = 16
How long this activity has been running for, including all attempts and backoff between attempts.
optional schedule_time = 17
Time the activity was originally scheduled via a StartActivityExecution request.
optional expiration_time = 18
Scheduled time + schedule to close timeout.
optional close_time = 19
Time when the activity transitioned to a closed state.
optional last_failure = 20
Failure details from the last failed attempt. DescribeActivityExecution does not set this field unless include_last_failure was true in the request.
string last_worker_identity = 21
optional current_retry_interval = 22
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.
optional last_attempt_complete_time = 23
The time when the last activity attempt completed. If activity has not been completed yet, it will be null.
optional next_attempt_schedule_time = 24
The time when the next activity attempt will be scheduled. If activity is currently scheduled or started, this field will be null.
optional last_deployment_version = 25
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.
optional priority = 26
Priority metadata.
int64 state_transition_count = 27
Incremented each time the activity's state is mutated in persistence.
int64 state_size_bytes = 28
Updated once on scheduled and once on terminal status.
optional search_attributes = 29
optional header = 30
optional user_metadata = 31
Metadata for use by user interfaces to display the fixed as-of-start summary and details of the activity.
string canceled_reason = 32
Set if activity cancelation was requested.
repeated links = 33
Links to related entities, such as the entity that started this activity.
int64 total_heartbeat_count = 34
Total number of heartbeats recorded across all attempts of this activity, including retries.
string sdk_name = 35
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.
string sdk_version = 36
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.
optional start_delay = 37
Time to wait before dispatching the first activity task. This delay is not applied to retry attempts.
message
message.proto:189Limited activity information returned in the list response. When adding fields here, ensure that it is also present in ActivityExecutionInfo (note that it may already be present in ActivityExecutionInfo but not at the top-level).
Used in:
string activity_id = 1
A unique identifier of this activity within its namespace along with run ID (below).
string run_id = 2
The run ID of the standalone activity.
optional activity_type = 3
The type of the activity, a string that maps to a registered activity on a worker.
optional schedule_time = 4
Time the activity was originally scheduled via a StartActivityExecution request.
optional close_time = 5
If the activity is in a terminal status, this field represents the time the activity transitioned to that status.
enums.v1.ActivityExecutionStatus status = 6
Only scheduled and terminal statuses appear here. More detailed information in PendingActivityInfo but not available in the list response.
optional search_attributes = 7
Search attributes from the start request.
string task_queue = 8
The task queue this activity was scheduled on when it was originally started, updated on activity options update.
int64 state_transition_count = 9
Updated on terminal status.
int64 state_size_bytes = 10
Updated once on scheduled and once on terminal status.
optional execution_duration = 11
The difference between close time and scheduled time. This field is only populated if the activity is closed.
message
message.proto:25The outcome of a completed activity execution: either a successful result or a failure.
Used in: ,
oneof value
result = 1
The result if the activity completed successfully.
failure = 2
The failure if the activity completed unsuccessfully.
message
message.proto:34Used in: , , , , ,
optional task_queue = 1
optional schedule_to_close_timeout = 2
Indicates how long the caller is willing to wait for an activity completion. Limits how long retries will be attempted. Either this or `start_to_close_timeout` must be specified. (-- api-linter: core::0140::prepositions=disabled aip.dev/not-precedent: "to" is used to indicate interval. --)
optional schedule_to_start_timeout = 3
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` or workflow execution timeout if not specified. (-- api-linter: core::0140::prepositions=disabled aip.dev/not-precedent: "to" is used to indicate interval. --)
optional start_to_close_timeout = 4
Maximum time an activity is allowed to execute after being picked up by a worker. This timeout is always retryable. Either this or `schedule_to_close_timeout` must be specified. (-- api-linter: core::0140::prepositions=disabled aip.dev/not-precedent: "to" is used to indicate interval. --)
optional heartbeat_timeout = 5
Maximum permitted time between successful worker heartbeats.
optional retry_policy = 6
The retry policy for the activity. Will never exceed `schedule_to_close_timeout`.
optional priority = 7
Priority metadata. If this message is not present, or any fields are not present, they inherit the values from the workflow.
message
message.proto:220CallbackInfo contains the state of an attached activity callback.
Used in:
optional trigger = 1
Trigger for this callback.
optional info = 2
Common callback info.
message
message.proto:222Trigger for when the activity is closed.
Used in:
(message has no fields)
message
message.proto:224Used in:
oneof variant
activity_closed = 1