diff --git a/openapi/openapiv2.json b/openapi/openapiv2.json index 2a2e82793..6e910f7be 100644 --- a/openapi/openapiv2.json +++ b/openapi/openapiv2.json @@ -13604,10 +13604,11 @@ "ACTIVITY_EXECUTION_STATUS_FAILED", "ACTIVITY_EXECUTION_STATUS_CANCELED", "ACTIVITY_EXECUTION_STATUS_TERMINATED", - "ACTIVITY_EXECUTION_STATUS_TIMED_OUT" + "ACTIVITY_EXECUTION_STATUS_TIMED_OUT", + "ACTIVITY_EXECUTION_STATUS_PAUSED" ], "default": "ACTIVITY_EXECUTION_STATUS_UNSPECIFIED", - "description": "Status of a standalone activity.\nThe status is updated once, when the activity is originally scheduled, and again when the activity reaches a terminal\nstatus.\n\n - ACTIVITY_EXECUTION_STATUS_RUNNING: The activity has not reached a terminal status. See PendingActivityState for the run state\n(SCHEDULED, STARTED, or CANCEL_REQUESTED).\n - ACTIVITY_EXECUTION_STATUS_COMPLETED: The activity completed successfully. An activity can complete even after cancellation is\nrequested if the worker calls RespondActivityTaskCompleted before acknowledging cancellation.\n - ACTIVITY_EXECUTION_STATUS_FAILED: The activity failed. Causes:\n- Worker returned a non-retryable failure\n- RetryPolicy.maximum_attempts exhausted\n- Attempt failed after cancellation was requested (retries blocked)\n - ACTIVITY_EXECUTION_STATUS_CANCELED: The activity was canceled. Reached when:\n- Cancellation requested while SCHEDULED (immediate), or\n- Cancellation requested while STARTED and worker called RespondActivityTaskCanceled.\n\nWorkers discover cancellation requests via heartbeat responses (cancel_requested=true).\nActivities that do not heartbeat will not learn of cancellation and may complete, fail, or\ntime out normally. CANCELED requires explicit worker acknowledgment or immediate cancellation\nof a SCHEDULED activity.\n - ACTIVITY_EXECUTION_STATUS_TERMINATED: The activity was terminated. Immediate; does not wait for worker acknowledgment.\n - ACTIVITY_EXECUTION_STATUS_TIMED_OUT: The activity timed out. See TimeoutType for the specific timeout.\n- SCHEDULE_TO_START and SCHEDULE_TO_CLOSE timeouts always result in TIMED_OUT.\n- START_TO_CLOSE and HEARTBEAT may retry if RetryPolicy permits; TIMED_OUT is\n reached when retry is blocked (RetryPolicy.maximum_attempts exhausted,\n SCHEDULE_TO_CLOSE would be exceeded, or cancellation has been requested)." + "description": "Status of a standalone activity.\nThe status is updated once, when the activity is originally scheduled, and again when the activity reaches a terminal\nstatus.\n\n - ACTIVITY_EXECUTION_STATUS_RUNNING: The activity has not reached a terminal status. See PendingActivityState for the run state\n(SCHEDULED, STARTED, or CANCEL_REQUESTED).\n - ACTIVITY_EXECUTION_STATUS_COMPLETED: The activity completed successfully. An activity can complete even after cancellation is\nrequested if the worker calls RespondActivityTaskCompleted before acknowledging cancellation.\n - ACTIVITY_EXECUTION_STATUS_FAILED: The activity failed. Causes:\n- Worker returned a non-retryable failure\n- RetryPolicy.maximum_attempts exhausted\n- Attempt failed after cancellation was requested (retries blocked)\n - ACTIVITY_EXECUTION_STATUS_CANCELED: The activity was canceled. Reached when:\n- Cancellation requested while SCHEDULED (immediate), or\n- Cancellation requested while STARTED and worker called RespondActivityTaskCanceled.\n\nWorkers discover cancellation requests via heartbeat responses (cancel_requested=true).\nActivities that do not heartbeat will not learn of cancellation and may complete, fail, or\ntime out normally. CANCELED requires explicit worker acknowledgment or immediate cancellation\nof a SCHEDULED activity.\n - ACTIVITY_EXECUTION_STATUS_TERMINATED: The activity was terminated. Immediate; does not wait for worker acknowledgment.\n - ACTIVITY_EXECUTION_STATUS_TIMED_OUT: The activity timed out. See TimeoutType for the specific timeout.\n- SCHEDULE_TO_START and SCHEDULE_TO_CLOSE timeouts always result in TIMED_OUT.\n- START_TO_CLOSE and HEARTBEAT may retry if RetryPolicy permits; TIMED_OUT is\n reached when retry is blocked (RetryPolicy.maximum_attempts exhausted,\n SCHEDULE_TO_CLOSE would be exceeded, or cancellation has been requested).\n - ACTIVITY_EXECUTION_STATUS_PAUSED: The activity is paused. Paused state is only reachable after calling\nPauseActivityExecution on a standalone activity." }, "v1ActivityFailureInfo": { "type": "object", diff --git a/openapi/openapiv3.yaml b/openapi/openapiv3.yaml index fed5a15db..f89a8cb5c 100644 --- a/openapi/openapiv3.yaml +++ b/openapi/openapiv3.yaml @@ -9689,6 +9689,7 @@ components: - ACTIVITY_EXECUTION_STATUS_CANCELED - ACTIVITY_EXECUTION_STATUS_TERMINATED - ACTIVITY_EXECUTION_STATUS_TIMED_OUT + - ACTIVITY_EXECUTION_STATUS_PAUSED type: string description: A general status for this activity, indicates whether it is currently running or in one of the terminal statuses. format: enum @@ -9889,6 +9890,7 @@ components: - ACTIVITY_EXECUTION_STATUS_CANCELED - ACTIVITY_EXECUTION_STATUS_TERMINATED - ACTIVITY_EXECUTION_STATUS_TIMED_OUT + - ACTIVITY_EXECUTION_STATUS_PAUSED type: string description: |- Only scheduled and terminal statuses appear here. More detailed information in PendingActivityInfo but not diff --git a/temporal/api/enums/v1/activity.proto b/temporal/api/enums/v1/activity.proto index 6754b5688..7799cc176 100644 --- a/temporal/api/enums/v1/activity.proto +++ b/temporal/api/enums/v1/activity.proto @@ -50,6 +50,10 @@ enum ActivityExecutionStatus { // reached when retry is blocked (RetryPolicy.maximum_attempts exhausted, // SCHEDULE_TO_CLOSE would be exceeded, or cancellation has been requested). ACTIVITY_EXECUTION_STATUS_TIMED_OUT = 6; + + // The activity is paused. Paused state is only reachable after calling + // PauseActivityExecution on a standalone activity. + ACTIVITY_EXECUTION_STATUS_PAUSED = 7; } // Defines whether to allow re-using an activity ID from a previously *closed* activity.