@temporalio/core-bridge 1.14.2-canary-release-testing.0 → 1.16.0

package/sdk-core/crates/common/protos/api_upstream/temporal/api/workflowservice/v1/request_response.proto

@@ -19,6 +19,7 @@ import "temporal/api/enums/v1/reset.proto";
 import "temporal/api/enums/v1/task_queue.proto";
 import "temporal/api/enums/v1/deployment.proto";
 import "temporal/api/enums/v1/update.proto";
+import "temporal/api/enums/v1/activity.proto";
 import "temporal/api/activity/v1/message.proto";
 import "temporal/api/common/v1/message.proto";
 import "temporal/api/history/v1/message.proto";
@@ -258,6 +259,9 @@ message PollWorkflowTaskQueueRequest {
     temporal.api.taskqueue.v1.TaskQueue task_queue = 2;
     // The identity of the worker/client who is polling this task queue
     string identity = 3;
+    // A unique key for this worker instance, used for tracking worker lifecycle.
+    // This is guaranteed to be unique, whereas identity is not guaranteed to be unique.
+    string worker_instance_key = 8;
     // Deprecated. Use deployment_options instead.
     // Each worker process should provide an ID unique to the specific set of code it is running
     // "checksum" in this field name isn't very accurate, it should be though of as an id.
@@ -270,8 +274,9 @@ message PollWorkflowTaskQueueRequest {
     // Experimental. Worker Deployments are experimental and might significantly change in the future.
     temporal.api.deployment.v1.WorkerDeploymentOptions deployment_options = 6;
 
-    // Worker info to be sent to the server.
-    temporal.api.worker.v1.WorkerHeartbeat worker_heartbeat = 7;
+    // Removed in 1.55.0; was temporal.api.worker.v1.WorkerHeartbeat worker_heartbeat
+    reserved 7; 
+    reserved "worker_heartbeat";
 }
 
 message PollWorkflowTaskQueueResponse {
@@ -436,6 +441,9 @@ message PollActivityTaskQueueRequest {
     temporal.api.taskqueue.v1.TaskQueue task_queue = 2;
     // The identity of the worker/client
     string identity = 3;
+    // A unique key for this worker instance, used for tracking worker lifecycle.
+    // This is guaranteed to be unique, whereas identity is not guaranteed to be unique.
+    string worker_instance_key = 8;
     temporal.api.taskqueue.v1.TaskQueueMetadata task_queue_metadata = 4;
     // Information about this worker's build identifier and if it is choosing to use the versioning
     // feature. See the `WorkerVersionCapabilities` docstring for more.
@@ -444,24 +452,27 @@ message PollActivityTaskQueueRequest {
     // Worker deployment options that user has set in the worker.
     temporal.api.deployment.v1.WorkerDeploymentOptions deployment_options = 6;
 
-    // Worker info to be sent to the server.
-    temporal.api.worker.v1.WorkerHeartbeat worker_heartbeat = 7;
-
+    // Removed in 1.55.0; was temporal.api.worker.v1.WorkerHeartbeat worker_heartbeat
+    reserved 7; 
+    reserved "worker_heartbeat";
 }
 
 message PollActivityTaskQueueResponse {
     // A unique identifier for this task
     bytes task_token = 1;
-    // The namespace the workflow which requested this activity lives in
+    // The namespace of the activity. If this is a workflow activity then this is the namespace of
+    // the workflow also. If this is a standalone activity then the name of this field is
+    // misleading, but retained for compatibility with workflow activities.
     string workflow_namespace = 2;
-    // Type of the requesting workflow
+    // Type of the requesting workflow (if this is a workflow activity).
     temporal.api.common.v1.WorkflowType workflow_type = 3;
-    // Execution info of the requesting workflow
+    // Execution info of the requesting workflow (if this is a workflow activity)
     temporal.api.common.v1.WorkflowExecution workflow_execution = 4;
     temporal.api.common.v1.ActivityType activity_type = 5;
     // The autogenerated or user specified identifier of this activity. Can be used to complete the
     // activity via `RespondActivityTaskCompletedById`. May be re-used as long as the last usage
     // has resolved, but unique IDs for every activity invocation is a good idea.
+    // Note that only a workflow activity ID may be autogenerated.
     string activity_id = 6;
     // Headers specified by the scheduling workflow. Commonly used to propagate contextual info
     // from the workflow to its activities. For example, tracing contexts.
@@ -499,6 +510,8 @@ message PollActivityTaskQueueResponse {
     temporal.api.taskqueue.v1.PollerScalingDecision poller_scaling_decision = 18;
     // Priority metadata
     temporal.api.common.v1.Priority priority = 19;
+    // The run ID of the activity execution, only set for standalone activities.
+    string activity_run_id = 20;
 }
 
 message RecordActivityTaskHeartbeatRequest {
@@ -527,9 +540,10 @@ message RecordActivityTaskHeartbeatResponse {
 message RecordActivityTaskHeartbeatByIdRequest {
     // Namespace of the workflow which scheduled this activity
     string namespace = 1;
-    // Id of the workflow which scheduled this activity
+    // Id of the workflow which scheduled this activity, leave empty to target a standalone activity
     string workflow_id = 2;
-    // Run Id of the workflow which scheduled this activity
+    // For a workflow activity - the run ID of the workflow which scheduled this activity.
+    // For a standalone activity - the run ID of the activity.
     string run_id = 3;
     // Id of the activity we're heartbeating
     string activity_id = 4;
@@ -579,9 +593,10 @@ message RespondActivityTaskCompletedResponse {
 message RespondActivityTaskCompletedByIdRequest {
     // Namespace of the workflow which scheduled this activity
     string namespace = 1;
-    // Id of the workflow which scheduled this activity
+    // Id of the workflow which scheduled this activity, leave empty to target a standalone activity
     string workflow_id = 2;
-    // Run Id of the workflow which scheduled this activity
+    // For a workflow activity - the run ID of the workflow which scheduled this activity.
+    // For a standalone activity - the run ID of the activity.
     string run_id = 3;
     // Id of the activity to complete
     string activity_id = 4;
@@ -626,9 +641,10 @@ message RespondActivityTaskFailedResponse {
 message RespondActivityTaskFailedByIdRequest {
     // Namespace of the workflow which scheduled this activity
     string namespace = 1;
-    // Id of the workflow which scheduled this activity
+    // Id of the workflow which scheduled this activity, leave empty to target a standalone activity
     string workflow_id = 2;
-    // Run Id of the workflow which scheduled this activity
+    // For a workflow activity - the run ID of the workflow which scheduled this activity.
+    // For a standalone activity - the run ID of the activity.
     string run_id = 3;
     // Id of the activity to fail
     string activity_id = 4;
@@ -673,9 +689,10 @@ message RespondActivityTaskCanceledResponse {
 message RespondActivityTaskCanceledByIdRequest {
     // Namespace of the workflow which scheduled this activity
     string namespace = 1;
-    // Id of the workflow which scheduled this activity
+    // Id of the workflow which scheduled this activity, leave empty to target a standalone activity
     string workflow_id = 2;
-    // Run Id of the workflow which scheduled this activity
+    // For a workflow activity - the run ID of the workflow which scheduled this activity.
+    // For a standalone activity - the run ID of the activity.
     string run_id = 3;
     // Id of the activity to confirm is cancelled
     string activity_id = 4;
@@ -1006,11 +1023,24 @@ message ResetStickyTaskQueueResponse {
 
 message ShutdownWorkerRequest {
     string namespace = 1;
+    // sticky_task_queue may not always be populated. We want to ensure all workers
+    // send a shutdown request to update worker state for heartbeating, as well
+    // as cancel pending poll calls early, instead of waiting for timeouts.
     string sticky_task_queue = 2;
     string identity = 3;
     string reason = 4;
-
     temporal.api.worker.v1.WorkerHeartbeat worker_heartbeat = 5;
+    // Technically this is also sent in the WorkerHeartbeat, but
+    // since worker heartbeating can be turned off, this needs
+    // to be a separate, top-level field.
+    string worker_instance_key = 6;
+    // Task queue name the worker is polling on. This allows server to cancel
+    // all outstanding poll RPC calls from SDK. This avoids a race condition that
+    // can lead to tasks being lost.
+    string task_queue = 7;
+    // Task queue types that help server cancel outstanding poll RPC
+    // calls from SDK. This avoids a race condition that can lead to tasks being lost.
+    repeated temporal.api.enums.v1.TaskQueueType task_queue_types = 8;
 }
 
 message ShutdownWorkerResponse {
@@ -1367,6 +1397,30 @@ message ListSchedulesResponse {
     bytes next_page_token = 2;
 }
 
+message CountSchedulesRequest {
+    string namespace = 1;
+    // Visibility query, see https://docs.temporal.io/list-filter for the syntax.
+    string query = 2;
+}
+
+message CountSchedulesResponse {
+    // If `query` is not grouping by any field, the count is an approximate number
+    // of schedules that match 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 schedules matching the query.
+    int64 count = 1;
+
+    // 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;
+    }
+}
+
 // [cleanup-wv-pre-release]
 message UpdateWorkerBuildIdCompatibilityRequest {
     message AddNewCompatibleVersion {
@@ -1796,6 +1850,9 @@ message PollNexusTaskQueueRequest {
     string namespace = 1;
     // The identity of the client who initiated this request.
     string identity = 2;
+    // A unique key for this worker instance, used for tracking worker lifecycle.
+    // This is guaranteed to be unique, whereas identity is not guaranteed to be unique.
+    string worker_instance_key = 8;
     temporal.api.taskqueue.v1.TaskQueue task_queue = 3;
     // Information about this worker's build identifier and if it is choosing to use the versioning
     // feature. See the `WorkerVersionCapabilities` docstring for more.
@@ -1836,8 +1893,10 @@ message RespondNexusTaskFailedRequest {
     string identity = 2;
     // A unique identifier for this task.
     bytes task_token = 3;
-    // The error the handler failed with.
-    temporal.api.nexus.v1.HandlerError error = 4;
+    // Deprecated. Use the failure field instead.
+    temporal.api.nexus.v1.HandlerError error = 4 [deprecated = true];
+    // The error the handler failed with. Must contain a NexusHandlerFailureInfo object.
+    temporal.api.failure.v1.Failure failure = 5;
 }
 
 message RespondNexusTaskFailedResponse {
@@ -2043,6 +2102,9 @@ message UpdateWorkflowExecutionOptionsRequest {
     // Controls which fields from `workflow_execution_options` will be applied.
     // To unset a field, set it to null and use the update mask to indicate that it should be mutated.
     google.protobuf.FieldMask update_mask = 4;
+
+    // Optional. The identity of the client who initiated this request.
+    string identity = 5;
 }
 
 message UpdateWorkflowExecutionOptionsResponse {
@@ -2182,7 +2244,11 @@ message SetWorkerDeploymentCurrentVersionResponse {
     // Deprecated. Use `previous_deployment_version`.
     string previous_version = 2 [deprecated = true];
     // The version that was current before executing this operation.
-    temporal.api.deployment.v1.WorkerDeploymentVersion previous_deployment_version = 3;
+    // Deprecated in favor of idempotency of the API. Use `DescribeWorkerDeployment` to get the
+    // Current version info before calling this API. By passing the `conflict_token` got from the
+    // `DescribeWorkerDeployment` call to this API you can ensure there is no interfering changes
+    // between the two calls.
+    temporal.api.deployment.v1.WorkerDeploymentVersion previous_deployment_version = 3 [deprecated = true];
 }
 
 // Set/unset the Ramping Version of a Worker Deployment and its ramp percentage.
@@ -2238,9 +2304,17 @@ message SetWorkerDeploymentRampingVersionResponse {
     // Deprecated. Use `previous_deployment_version`.
     string previous_version = 2 [deprecated = true];
     // The version that was ramping before executing this operation.
-    temporal.api.deployment.v1.WorkerDeploymentVersion previous_deployment_version = 4;
+    // Deprecated in favor of idempotency of the API. Use `DescribeWorkerDeployment` to get the
+    // Ramping version info before calling this API. By passing the `conflict_token` got from the
+    // `DescribeWorkerDeployment` call to this API you can ensure there is no interfering changes
+    // between the two calls.
+    temporal.api.deployment.v1.WorkerDeploymentVersion previous_deployment_version = 4 [deprecated = true];
     // The ramping version percentage before executing this operation.
-    float previous_percentage = 3;
+    // Deprecated in favor of idempotency of the API. Use `DescribeWorkerDeployment` to get the
+    // Ramping version info before calling this API. By passing the `conflict_token` got from the
+    // `DescribeWorkerDeployment` call to this API you can ensure there is no interfering changes
+    // between the two calls.
+    float previous_percentage = 3 [deprecated = true];
 }
 
 message ListWorkerDeploymentsRequest {
@@ -2353,7 +2427,11 @@ message SetWorkerDeploymentManagerResponse {
     bytes conflict_token = 1;
 
     // What the `manager_identity` field was before this change.
-    string previous_manager_identity = 2;
+    // Deprecated in favor of idempotency of the API. Use `DescribeWorkerDeployment` to get the
+    // manager identity before calling this API. By passing the `conflict_token` got from the
+    // `DescribeWorkerDeployment` call to this API you can ensure there is no interfering changes
+    // between the two calls.
+    string previous_manager_identity = 2 [deprecated = true];
 }
 
 // Returns the Current Deployment of a deployment series.
@@ -2528,6 +2606,13 @@ message UpdateTaskQueueConfigRequest {
     // If not set, this configuration is unchanged.
     // If the `rate_limit` field in the `RateLimitUpdate` is missing, remove the existing rate limit.
     RateLimitUpdate update_fairness_key_rate_limit_default = 6;
+    // If set, overrides the fairness weight for each specified fairness key.
+    // Fairness keys not listed in this map will keep their existing overrides (if any).
+    map<string, float> set_fairness_weight_overrides = 7;
+    // If set, removes any existing fairness weight overrides for each specified fairness key.
+    // Fairness weights for corresponding keys fall back to the values set during task creation (if any),
+    // or to the default weight of 1.0.
+    repeated string unset_fairness_weight_overrides = 8;
 }
 
 message UpdateTaskQueueConfigResponse {
@@ -2595,3 +2680,242 @@ message DescribeWorkerRequest {
 message DescribeWorkerResponse {
     temporal.api.worker.v1.WorkerInfo worker_info = 1;
 }
+
+// Request to pause a workflow execution.
+message PauseWorkflowExecutionRequest {
+    // Namespace of the workflow to pause.
+    string namespace = 1;
+    // ID of the workflow execution to be paused. Required.
+    string workflow_id = 2;
+    // Run ID of the workflow execution to be paused. Optional. If not provided, the current run of the workflow will be paused.
+    string run_id = 3;
+    // The identity of the client who initiated this request.
+    string identity = 4;
+    // Reason to pause the workflow execution.
+    string reason = 5;
+    // A unique identifier for this pause request for idempotence. Typically UUIDv4.
+    string request_id = 6;
+}
+
+// Response to a successful PauseWorkflowExecution request.
+message PauseWorkflowExecutionResponse { }
+
+message UnpauseWorkflowExecutionRequest {
+    // Namespace of the workflow to unpause.
+    string namespace = 1;
+    // ID of the workflow execution to be paused. Required.
+    string workflow_id = 2;
+    // Run ID of the workflow execution to be paused. Optional. If not provided, the current run of the workflow will be paused.
+    string run_id = 3;
+    // The identity of the client who initiated this request.
+    string identity = 4;
+    // Reason to unpause the workflow execution.
+    string reason = 5;
+    // A unique identifier for this unpause request for idempotence. Typically UUIDv4.
+    string request_id = 6;
+}
+
+// Response to a successful UnpauseWorkflowExecution request.
+message UnpauseWorkflowExecutionResponse { }
+
+message StartActivityExecutionRequest {
+    string namespace = 1;
+    // The identity of the client who initiated this request
+    string identity = 2;
+    // A unique identifier for this start request. Typically UUIDv4.
+    string request_id = 3;
+
+    // Identifier for this activity. Required. This identifier should be meaningful in the user's
+    // own system. It must be unique among activities in the same namespace, subject to the rules
+    // imposed by id_reuse_policy and id_conflict_policy.
+    string activity_id = 4;
+
+    // The type of the activity, a string that corresponds to a registered activity on a worker.
+    temporal.api.common.v1.ActivityType activity_type = 5;
+
+    // Task queue to schedule this activity on.
+    temporal.api.taskqueue.v1.TaskQueue task_queue = 6;
+    // 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. --)
+    google.protobuf.Duration schedule_to_close_timeout = 7;
+    // 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` if not specified.
+    //
+    // (-- api-linter: core::0140::prepositions=disabled
+    //     aip.dev/not-precedent: "to" is used to indicate interval. --)
+    google.protobuf.Duration schedule_to_start_timeout = 8;
+    // 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. --)
+    google.protobuf.Duration start_to_close_timeout = 9;
+    // Maximum permitted time between successful worker heartbeats.
+    google.protobuf.Duration heartbeat_timeout = 10;
+    // The retry policy for the activity. Will never exceed `schedule_to_close_timeout`.
+    temporal.api.common.v1.RetryPolicy retry_policy = 11;
+
+    // Serialized arguments to the activity. These are passed as arguments to the activity function.
+    temporal.api.common.v1.Payloads input = 12;
+
+    // Defines whether to allow re-using the activity id from a previously *closed* activity.
+    // The default policy is ACTIVITY_ID_REUSE_POLICY_ALLOW_DUPLICATE.
+    temporal.api.enums.v1.ActivityIdReusePolicy id_reuse_policy = 13;
+    // Defines how to resolve an activity id conflict with a *running* activity.
+    // The default policy is ACTIVITY_ID_CONFLICT_POLICY_FAIL.
+    temporal.api.enums.v1.ActivityIdConflictPolicy id_conflict_policy = 14;
+
+    // Search attributes for indexing.
+    temporal.api.common.v1.SearchAttributes search_attributes = 15;
+    // Header for context propagation and tracing purposes.
+    temporal.api.common.v1.Header header = 16;
+    // Metadata for use by user interfaces to display the fixed as-of-start summary and details of the activity.
+    temporal.api.sdk.v1.UserMetadata user_metadata = 17;
+    // Priority metadata.
+    temporal.api.common.v1.Priority priority = 18;
+}
+
+message StartActivityExecutionResponse {
+    // The run ID of the activity that was started - or used (via ACTIVITY_ID_CONFLICT_POLICY_USE_EXISTING).
+    string run_id = 1;
+    // If true, a new activity was started.
+    bool started = 2;
+}
+
+message DescribeActivityExecutionRequest {
+    string namespace = 1;
+    string activity_id = 2;
+    // Activity run ID. If empty the request targets the latest run.
+    string run_id = 3;
+    // Include the input field in the response.
+    bool include_input = 4;
+    // Include the outcome (result/failure) in the response if the activity has completed.
+    bool include_outcome = 5;
+    // Token from a previous DescribeActivityExecutionResponse. If present, long-poll until activity
+    // state changes from the state encoded in this token. If absent, return current state immediately.
+    // If present, run_id must also be present.
+    // Note that activity state may change multiple times between requests, therefore it is not
+    // guaranteed that a client making a sequence of long-poll requests will see a complete
+    // sequence of state changes.
+    bytes long_poll_token = 6;
+}
+
+message DescribeActivityExecutionResponse {
+    // The run ID of the activity, useful when run_id was not specified in the request.
+    string run_id = 1;
+
+    // Information about the activity execution.
+    temporal.api.activity.v1.ActivityExecutionInfo info = 2;
+
+    // Serialized activity input, passed as arguments to the activity function.
+    // Only set if include_input was true in the request.
+    temporal.api.common.v1.Payloads input = 3;
+
+    // Only set if the activity is completed and include_outcome was true in the request.
+    temporal.api.activity.v1.ActivityExecutionOutcome outcome = 4;
+
+    // Token for follow-on long-poll requests. Absent only if the activity is complete.
+    bytes long_poll_token = 5;
+}
+
+message PollActivityExecutionRequest {
+    string namespace = 1;
+    string activity_id = 2;
+    // Activity run ID. If empty the request targets the latest run.
+    string run_id = 3;
+}
+
+message PollActivityExecutionResponse {
+    // The run ID of the activity, useful when run_id was not specified in the request.
+    string run_id = 1;
+
+    temporal.api.activity.v1.ActivityExecutionOutcome outcome = 2;
+}
+
+message ListActivityExecutionsRequest {
+    string namespace = 1;
+    // Max number of executions to return per page.
+    int32 page_size = 2;
+    // Token returned in ListActivityExecutionsResponse.
+    bytes next_page_token = 3;
+    // Visibility query, see https://docs.temporal.io/list-filter for the syntax.
+    string query = 4;
+}
+
+message ListActivityExecutionsResponse {
+    repeated temporal.api.activity.v1.ActivityExecutionListInfo executions = 1;
+    // Token to use to fetch the next page. If empty, there is no next page.
+    bytes next_page_token = 2;
+}
+
+message CountActivityExecutionsRequest {
+    string namespace = 1;
+    // Visibility query, see https://docs.temporal.io/list-filter for the syntax.
+    string query = 2;
+}
+
+message CountActivityExecutionsResponse {
+    // If `query` is not grouping by any field, the count is an approximate number
+    // of activities that match 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 activities matching the query.
+    int64 count = 1;
+
+    // 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 RequestCancelActivityExecutionRequest {
+    string namespace = 1;
+    string activity_id = 2;
+    // Activity run ID, targets the latest run if run_id is empty.
+    string run_id = 3;
+    // The identity of the worker/client.
+    string identity = 4;
+    // Used to de-dupe cancellation requests.
+    string request_id = 5;
+    // Reason for requesting the cancellation, recorded and available via the PollActivityExecution API.
+    // Not propagated to a worker if an activity attempt is currently running.
+    string reason = 6;
+}
+
+message RequestCancelActivityExecutionResponse {
+}
+
+message TerminateActivityExecutionRequest {
+    string namespace = 1;
+    string activity_id = 2;
+    // Activity run ID, targets the latest run if run_id is empty.
+    string run_id = 3;
+    // The identity of the worker/client.
+    string identity = 4;
+    // Used to de-dupe termination requests.
+    string request_id = 5;
+    // Reason for requesting the termination, recorded in in the activity's result failure outcome.
+    string reason = 6;
+}
+
+message TerminateActivityExecutionResponse {
+}
+
+message DeleteActivityExecutionRequest {
+    string namespace = 1;
+    string activity_id = 2;
+    // Activity run ID, targets the latest run if run_id is empty.
+    string run_id = 3;
+}
+
+message DeleteActivityExecutionResponse {
+}