@temporalio/core-bridge 1.8.5 → 1.9.0-rc.0

package/sdk-core/{protos → sdk-core-protos/protos}/api_upstream/temporal/api/workflowservice/v1/request_response.proto

@@ -39,6 +39,7 @@ import "temporal/api/enums/v1/common.proto";
 import "temporal/api/enums/v1/query.proto";
 import "temporal/api/enums/v1/reset.proto";
 import "temporal/api/enums/v1/task_queue.proto";
+import "temporal/api/enums/v1/update.proto";
 import "temporal/api/common/v1/message.proto";
 import "temporal/api/history/v1/message.proto";
 import "temporal/api/workflow/v1/message.proto";
@@ -59,13 +60,11 @@ import "temporal/api/sdk/v1/task_complete_metadata.proto";
 import "google/protobuf/duration.proto";
 import "google/protobuf/timestamp.proto";
 
-import "dependencies/gogoproto/gogo.proto";
-
 message RegisterNamespaceRequest {
     string namespace = 1;
     string description = 2;
     string owner_email = 3;
-    google.protobuf.Duration workflow_execution_retention_period = 4 [(gogoproto.stdduration) = true];
+    google.protobuf.Duration workflow_execution_retention_period = 4;
     repeated temporal.api.replication.v1.ClusterReplicationConfig clusters = 5;
     string active_cluster_name = 6;
     // A key-value map for any customized purpose.
@@ -151,11 +150,11 @@ message StartWorkflowExecutionRequest {
     // Serialized arguments to the workflow. These are passed as arguments to the workflow function.
     temporal.api.common.v1.Payloads input = 5;
     // Total workflow execution timeout including retries and continue as new.
-    google.protobuf.Duration workflow_execution_timeout = 6 [(gogoproto.stdduration) = true];
+    google.protobuf.Duration workflow_execution_timeout = 6;
     // Timeout of a single workflow run.
-    google.protobuf.Duration workflow_run_timeout = 7 [(gogoproto.stdduration) = true];
+    google.protobuf.Duration workflow_run_timeout = 7;
     // Timeout of a single workflow task.
-    google.protobuf.Duration workflow_task_timeout = 8 [(gogoproto.stdduration) = true];
+    google.protobuf.Duration workflow_task_timeout = 8;
     // The identity of the client who initiated this request
     string identity = 9;
     // A unique identifier for this start request. Typically UUIDv4.
@@ -183,7 +182,7 @@ message StartWorkflowExecutionRequest {
     // Time to wait before dispatching the first workflow task. Cannot be used with `cron_schedule`.
     // If the workflow gets a signal before the delay, a workflow task will be dispatched and the rest
     // of the delay will be ignored.
-    google.protobuf.Duration workflow_start_delay = 20 [(gogoproto.stdduration) = true];
+    google.protobuf.Duration workflow_start_delay = 20;
 }
 
 message StartWorkflowExecutionResponse {
@@ -256,7 +255,9 @@ message PollWorkflowTaskQueueResponse {
     // Will be zero if no task has ever started.
     int64 previous_started_event_id = 4;
     // The id of the most recent workflow task started event, which will have been generated as a
-    // result of this poll request being served.
+    // result of this poll request being served. Will be zero if the task
+    // does not contain any events which would advance history (no new WFT started).
+    // Currently this can happen for queries.
     int64 started_event_id = 5;
     // Starting at 1, the number of attempts to complete this task by any worker.
     int32 attempt = 6;
@@ -279,9 +280,9 @@ message PollWorkflowTaskQueueResponse {
     // for the queue, even if this response came from polling a sticky queue.
     temporal.api.taskqueue.v1.TaskQueue workflow_execution_task_queue = 11;
     // When this task was scheduled by the server
-    google.protobuf.Timestamp scheduled_time = 12 [(gogoproto.stdtime) = true];
+    google.protobuf.Timestamp scheduled_time = 12;
     // When the current workflow task started event was generated, meaning the current attempt.
-    google.protobuf.Timestamp started_time = 13 [(gogoproto.stdtime) = true];
+    google.protobuf.Timestamp started_time = 13;
     // Queries that should be executed after applying the history in this task. Responses should be
     // attached to `RespondWorkflowTaskCompletedRequest::query_results`
     map<string, temporal.api.query.v1.WorkflowQuery> queries = 14;
@@ -394,25 +395,25 @@ message PollActivityTaskQueueResponse {
     // was delivered.
     temporal.api.common.v1.Payloads heartbeat_details = 9;
     // When was this task first scheduled
-    google.protobuf.Timestamp scheduled_time = 10 [(gogoproto.stdtime) = true];
+    google.protobuf.Timestamp scheduled_time = 10;
     // When was this task attempt scheduled
-    google.protobuf.Timestamp current_attempt_scheduled_time = 11 [(gogoproto.stdtime) = true];
+    google.protobuf.Timestamp current_attempt_scheduled_time = 11;
     // When was this task started (this attempt)
-    google.protobuf.Timestamp started_time = 12 [(gogoproto.stdtime) = true];
+    google.protobuf.Timestamp started_time = 12;
     // Starting at 1, the number of attempts to perform this activity
     int32 attempt = 13;
     // First scheduled -> final result reported timeout
     //
     // (-- api-linter: core::0140::prepositions=disabled
     //     aip.dev/not-precedent: "to" is used to indicate interval. --)
-    google.protobuf.Duration schedule_to_close_timeout = 14 [(gogoproto.stdduration) = true];
+    google.protobuf.Duration schedule_to_close_timeout = 14;
     // Current attempt start -> final result reported timeout
     //
     // (-- api-linter: core::0140::prepositions=disabled
     //     aip.dev/not-precedent: "to" is used to indicate interval. --)
-    google.protobuf.Duration start_to_close_timeout = 15 [(gogoproto.stdduration) = true];
+    google.protobuf.Duration start_to_close_timeout = 15;
     // Window within which the activity must report a heartbeat, or be timed out.
-    google.protobuf.Duration heartbeat_timeout = 16 [(gogoproto.stdduration) = true];
+    google.protobuf.Duration heartbeat_timeout = 16;
     // This is the retry policy the service uses which may be different from the one provided
     // (or not) during activity scheduling. The service can override the provided one if some
     // values are not specified or exceed configured system limits.
@@ -621,11 +622,11 @@ message SignalWithStartWorkflowExecutionRequest {
     // Serialized arguments to the workflow. These are passed as arguments to the workflow function.
     temporal.api.common.v1.Payloads input = 5;
     // Total workflow execution timeout including retries and continue as new
-    google.protobuf.Duration workflow_execution_timeout = 6 [(gogoproto.stdduration) = true];
+    google.protobuf.Duration workflow_execution_timeout = 6;
     // Timeout of a single workflow run
-    google.protobuf.Duration workflow_run_timeout = 7 [(gogoproto.stdduration) = true];
+    google.protobuf.Duration workflow_run_timeout = 7;
     // Timeout of a single workflow task
-    google.protobuf.Duration workflow_task_timeout = 8 [(gogoproto.stdduration) = true];
+    google.protobuf.Duration workflow_task_timeout = 8;
     // The identity of the worker/client
     string identity = 9;
     // Used to de-dupe signal w/ start requests
@@ -650,7 +651,7 @@ message SignalWithStartWorkflowExecutionRequest {
     // or not set, a workflow task will be dispatched immediately and the rest of the delay period
     // will be ignored, even if that request also had a delay. Signal via SignalWorkflowExecution
     // will not unblock the workflow.
-    google.protobuf.Duration workflow_start_delay = 20 [(gogoproto.stdduration) = true];
+    google.protobuf.Duration workflow_start_delay = 20;
     // Indicates that a new workflow task should not be generated when this signal is received.
     bool skip_generate_workflow_task = 21;
 }
@@ -668,7 +669,7 @@ message ResetWorkflowExecutionRequest {
     int64 workflow_task_finish_event_id = 4;
     // Used to de-dupe reset requests
     string request_id = 5;
-    // Reset reapplay(replay) options.
+    // Reset reapply (replay) options.
     temporal.api.enums.v1.ResetReapplyType reset_reapply_type = 6;
 }
 
@@ -781,7 +782,21 @@ message CountWorkflowExecutionsRequest {
 }
 
 message CountWorkflowExecutionsResponse {
+    // If `query` is not grouping by any field, the count is an approximate number
+    // of workflows that matches the query.
+    // If `query` is grouping by a field, the count is simply the sum of the counts
+    // of the groups returned in the response. This number can be smaller than the
+    // total number of workflows matching the query.
     int64 count = 1;
+
+    // `groups` contains the groups if the request is grouping by a field.
+    // The list might not be complete, and the counts of each group is approximate.
+    repeated AggregationGroup groups = 2;
+
+    message AggregationGroup {
+        repeated temporal.api.common.v1.Payload group_values = 1;
+        int64 count = 2;
+    }
 }
 
 message GetSearchAttributesRequest {
@@ -841,6 +856,7 @@ message DescribeWorkflowExecutionResponse {
 message DescribeTaskQueueRequest {
     string namespace = 1;
     temporal.api.taskqueue.v1.TaskQueue task_queue = 2;
+    // If unspecified (TASK_QUEUE_TYPE_UNSPECIFIED), then default value (TASK_QUEUE_TYPE_WORKFLOW) will be used.
     temporal.api.enums.v1.TaskQueueType task_queue_type = 3;
     bool include_task_queue_status = 4;
 }
@@ -912,6 +928,10 @@ message GetSystemInfoResponse {
         // True if the server knows about the sdk metadata field on WFT completions and will record
         // it in history
         bool sdk_metadata = 9;
+
+        // True if the server supports count group by execution status
+        // (-- api-linter: core::0140::prepositions=disabled --)
+        bool count_group_by_execution_status = 10;
     }
 }
 
@@ -1028,12 +1048,12 @@ message ListScheduleMatchingTimesRequest {
     // The id of the schedule to query.
     string schedule_id = 2;
     // Time range to query.
-    google.protobuf.Timestamp start_time = 3 [(gogoproto.stdtime) = true];
-    google.protobuf.Timestamp end_time = 4 [(gogoproto.stdtime) = true];
+    google.protobuf.Timestamp start_time = 3;
+    google.protobuf.Timestamp end_time = 4;
 }
 
 message ListScheduleMatchingTimesResponse {
-    repeated google.protobuf.Timestamp start_time = 1 [(gogoproto.stdtime) = true];
+    repeated google.protobuf.Timestamp start_time = 1;
 }
 
 // (-- api-linter: core::0135::request-name-required=disabled
@@ -1126,9 +1146,8 @@ message UpdateWorkerBuildIdCompatibilityRequest {
     }
 }
 message UpdateWorkerBuildIdCompatibilityResponse {
-    // The id of the compatible set that the updated version was added to, or exists in. Users don't
-    // need to understand or care about this value, but it has value for debugging purposes.
-    string version_set_id = 1;
+    reserved 1;
+    reserved "version_set_id";
 }
 
 // (-- api-linter: core::0134::request-resource-required=disabled
@@ -1218,21 +1237,40 @@ message UpdateWorkflowExecutionResponse {
     // has completed. If this response is being returned before the update has
     // completed then this field will not be set.
     temporal.api.update.v1.Outcome outcome = 2;
+
+    // The most advanced lifecycle stage that the Update is known to have
+    // reached, where lifecycle stages are ordered
+    // UPDATE_WORKFLOW_EXECUTION_LIFECYCLE_STAGE_UNSPECIFIED <
+    // UPDATE_WORKFLOW_EXECUTION_LIFECYCLE_STAGE_ADMITTED <
+    // UPDATE_WORKFLOW_EXECUTION_LIFECYCLE_STAGE_ACCEPTED <
+    // UPDATE_WORKFLOW_EXECUTION_LIFECYCLE_STAGE_COMPLETED.
+    // UNSPECIFIED will be returned if and only if the server's maximum wait
+    // time was reached before the Update reached the stage specified in the
+    // request WaitPolicy, and before the context deadline expired; clients may
+    // may then retry the call as needed.
+    temporal.api.enums.v1.UpdateWorkflowExecutionLifecycleStage stage = 3;
 }
 
 message StartBatchOperationRequest {
     // Namespace that contains the batch operation
     string namespace = 1;
     // Visibility query defines the the group of workflow to apply the batch operation
-    // This field and Executions are mutually exclusive
+    // This field and `executions` are mutually exclusive
     string visibility_query = 2;
     // Job ID defines the unique ID for the batch job
     string job_id = 3;
     // Reason to perform the batch operation
     string reason = 4;
     // Executions to apply the batch operation
-    // This field and VisibilityQuery are mutually exclusive
+    // This field and `visibility_query` are mutually exclusive
     repeated temporal.api.common.v1.WorkflowExecution executions = 5;
+    // Limit for the number of operations processed per second within this batch.
+    // Its purpose is to reduce the stress on the system caused by batch operations, which helps to prevent system
+    // overload and minimize potential delays in executing ongoing tasks for user workers.
+    // Note that when no explicit limit is provided, the server will operate according to its limit defined by the
+    // dynamic configuration key `worker.batcherRPS`. This also applies if the value in this field exceeds the
+    // server's configured limit.
+    float max_operations_per_second = 6;
     // Operation input
     oneof operation {
         temporal.api.batch.v1.BatchOperationTermination termination_operation = 10;
@@ -1275,9 +1313,9 @@ message DescribeBatchOperationResponse {
     // Batch operation state
     temporal.api.enums.v1.BatchOperationState state = 3;
     // Batch operation start time
-    google.protobuf.Timestamp start_time = 4 [(gogoproto.stdtime) = true];
+    google.protobuf.Timestamp start_time = 4;
     // Batch operation close time
-    google.protobuf.Timestamp close_time = 5 [(gogoproto.stdtime) = true];
+    google.protobuf.Timestamp close_time = 5;
     // Total operation count
     int64 total_operation_count = 6;
     // Complete operation count
@@ -1314,7 +1352,8 @@ message PollWorkflowExecutionUpdateRequest {
     temporal.api.update.v1.UpdateRef update_ref = 2;
     // The identity of the worker/client who is polling this update outcome
     string identity = 3;
-    // Describes when this poll request should return a response
+    // Describes when this poll request should return a response.
+    // Omit to request a non-blocking poll.
     temporal.api.update.v1.WaitPolicy wait_policy = 4;
 }
 
@@ -1325,4 +1364,17 @@ message PollWorkflowExecutionUpdateResponse {
     // UPDATE_WORKFLOW_EXECUTION_LIFECYCLE_STAGE_ACCEPTED) then this field will
     // not be set.
     temporal.api.update.v1.Outcome outcome = 1;
+    // The most advanced lifecycle stage that the Update is known to have
+    // reached, where lifecycle stages are ordered
+    // UPDATE_WORKFLOW_EXECUTION_LIFECYCLE_STAGE_UNSPECIFIED <
+    // UPDATE_WORKFLOW_EXECUTION_LIFECYCLE_STAGE_ADMITTED <
+    // UPDATE_WORKFLOW_EXECUTION_LIFECYCLE_STAGE_ACCEPTED <
+    // UPDATE_WORKFLOW_EXECUTION_LIFECYCLE_STAGE_COMPLETED.
+    // UNSPECIFIED will be returned if and only if the server's maximum wait
+    // time was reached before the Update reached the stage specified in the
+    // request WaitPolicy, and before the context deadline expired; clients may
+    // may then retry the call as needed.
+    temporal.api.enums.v1.UpdateWorkflowExecutionLifecycleStage stage = 2;
+    // Sufficient information to address this update.
+    temporal.api.update.v1.UpdateRef update_ref = 3;
 }