@temporalio/core-bridge 0.16.4 → 0.18.0

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

@@ -111,6 +111,8 @@ message UpdateNamespaceRequest {
     temporal.api.replication.v1.NamespaceReplicationConfig replication_config = 4;
     string security_token = 5;
     string delete_bad_binary = 6;
+    // promote local namespace to global namespace. Ignored if namespace is already global namespace.
+    bool promote_namespace = 7;
 }
 
 message UpdateNamespaceResponse {
@@ -121,11 +123,13 @@ message UpdateNamespaceResponse {
     bool is_global_namespace = 5;
 }
 
+// Deprecated.
 message DeprecateNamespaceRequest {
     string namespace = 1;
     string security_token = 2;
 }
 
+// Deprecated.
 message DeprecateNamespaceResponse {
 }
 
@@ -134,6 +138,7 @@ message StartWorkflowExecutionRequest {
     string workflow_id = 2;
     temporal.api.common.v1.WorkflowType workflow_type = 3;
     temporal.api.taskqueue.v1.TaskQueue task_queue = 4;
+    // 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];
@@ -141,12 +146,15 @@ message StartWorkflowExecutionRequest {
     google.protobuf.Duration workflow_run_timeout = 7 [(gogoproto.stdduration) = true];
     // Timeout of a single workflow task.
     google.protobuf.Duration workflow_task_timeout = 8 [(gogoproto.stdduration) = true];
+    // The identity of the client who initiated this request
     string identity = 9;
+    // A unique identifier for this start request. Typically UUIDv4.
     string request_id = 10;
     // Default: WORKFLOW_ID_REUSE_POLICY_ALLOW_DUPLICATE.
     temporal.api.enums.v1.WorkflowIdReusePolicy workflow_id_reuse_policy = 11;
-    // Retries up to workflow_execution_timeout_seconds.
+    // The retry policy for the workflow. Will never exceed `workflow_execution_timeout`.
     temporal.api.common.v1.RetryPolicy retry_policy = 12;
+    // See https://docs.temporal.io/docs/content/what-is-a-temporal-cron-job/
     string cron_schedule = 13;
     temporal.api.common.v1.Memo memo = 14;
     temporal.api.common.v1.SearchAttributes search_attributes = 15;
@@ -161,8 +169,13 @@ message GetWorkflowExecutionHistoryRequest {
     string namespace = 1;
     temporal.api.common.v1.WorkflowExecution execution = 2;
     int32 maximum_page_size = 3;
+    // If a `GetWorkflowExecutionHistoryResponse` or a `PollWorkflowTaskQueueResponse` had one of
+    // these, it should be passed here to fetch the next page.
     bytes next_page_token = 4;
+    // If set to true, the RPC call will not resolve until there is a new event which matches
+    // the `history_event_filter_type`, or a timeout is hit.
     bool wait_new_event = 5;
+    // Filter returned events such that they match the specified filter type.
     // Default: HISTORY_EVENT_FILTER_TYPE_ALL_EVENT.
     temporal.api.enums.v1.HistoryEventFilterType history_event_filter_type = 6;
     bool skip_archival = 7;
@@ -170,7 +183,10 @@ message GetWorkflowExecutionHistoryRequest {
 
 message GetWorkflowExecutionHistoryResponse {
     temporal.api.history.v1.History history = 1;
+    // Raw history is an alternate representation of history that may be returned if configured on
+    // the frontend. This is not supported by all SDKs. Either this or `history` will be set.
     repeated temporal.api.common.v1.DataBlob raw_history = 2;
+    // Will be set if there are more history events than were included in this response
     bytes next_page_token = 3;
     bool archived = 4;
 }
@@ -178,48 +194,93 @@ message GetWorkflowExecutionHistoryResponse {
 message PollWorkflowTaskQueueRequest {
     string namespace = 1;
     temporal.api.taskqueue.v1.TaskQueue task_queue = 2;
+    // The identity of the worker/client who is polling this task queue
     string identity = 3;
+    // Each worker process should provide an ID unique to the specific set of code it is running
     string binary_checksum = 4;
 }
 
 message PollWorkflowTaskQueueResponse {
+    // A unique identifier for this task
     bytes task_token = 1;
     temporal.api.common.v1.WorkflowExecution workflow_execution = 2;
     temporal.api.common.v1.WorkflowType workflow_type = 3;
+    // The last workflow task started event which was processed by some worker for this execution.
+    // 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.
     int64 started_event_id = 5;
+    // Starting at 1, the number of attempts to complete this task by any worker.
     int32 attempt = 6;
+    // A hint that there are more tasks already present in this task queue. Can be used to
+    // prioritize draining a sticky queue before polling from a normal queue.
     int64 backlog_count_hint = 7;
+    // The history for this workflow, which will either be complete or partial. Partial histories
+    // are sent to workers who have signaled that they are using a sticky queue when completing
+    // a workflow task.
     temporal.api.history.v1.History history = 8;
+    // Will be set if there are more history events than were included in this response. Such events
+    // should be fetched via `GetWorkflowExecutionHistory`.
     bytes next_page_token = 9;
+    // Legacy queries appear in this field. The query must be responded to via
+    // `RespondQueryTaskCompleted`. If the workflow is already closed (queries are permitted on
+    // closed workflows) then the `history` field will be populated with the entire history. It
+    // may also be populated if this task originates on a non-sticky queue.
     temporal.api.query.v1.WorkflowQuery query = 10;
+    // The task queue this task originated from, which will always be the original non-sticky name
+    // 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];
+    // When the current workflow task started event was generated, meaning the current attempt.
     google.protobuf.Timestamp started_time = 13 [(gogoproto.stdtime) = true];
+    // 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;
 }
 
 message RespondWorkflowTaskCompletedRequest {
+    // The task token as received in `PollWorkflowTaskQueueResponse`
     bytes task_token = 1;
+    // A list of commands generated when driving the workflow code in response to the new task
     repeated temporal.api.command.v1.Command commands = 2;
+    // The identity of the worker/client
     string identity = 3;
+    // May be set by workers to indicate that the worker desires future tasks to be provided with
+    // incremental history on a sticky queue.
     temporal.api.taskqueue.v1.StickyExecutionAttributes sticky_attributes = 4;
+    // If set, the worker wishes to immediately receive the next workflow task as a response to
+    // this completion. This can save on polling round-trips.
     bool return_new_workflow_task = 5;
+    // Can be used to *force* creation of a new workflow task, even if no commands have resolved or
+    // one would not otherwise have been generated. This is used when the worker knows it is doing
+    // something useful, but cannot complete it within the workflow task timeout. Local activities
+    // which run for longer than the task timeout being the prime example.
     bool force_create_new_workflow_task = 6;
+    // Worker process' unique binary id
     string binary_checksum = 7;
+    // Responses to the `queries` field in the task being responded to
     map<string, temporal.api.query.v1.WorkflowQueryResult> query_results = 8;
     string namespace = 9;
 }
 
 message RespondWorkflowTaskCompletedResponse {
+    // See `RespondWorkflowTaskCompletedResponse::return_new_workflow_task`
     PollWorkflowTaskQueueResponse workflow_task = 1;
 }
 
 message RespondWorkflowTaskFailedRequest {
+    // The task token as received in `PollWorkflowTaskQueueResponse`
     bytes task_token = 1;
+    // Why did the task fail? It's important to note that many of the variants in this enum cannot
+    // apply to worker responses. See the type's doc for more.
     temporal.api.enums.v1.WorkflowTaskFailedCause cause = 2;
+    // Failure details
     temporal.api.failure.v1.Failure failure = 3;
+    // The identity of the worker/client
     string identity = 4;
+    // Worker process' unique binary id
     string binary_checksum = 5;
     string namespace = 6;
 }
@@ -230,65 +291,102 @@ message RespondWorkflowTaskFailedResponse {
 message PollActivityTaskQueueRequest {
     string namespace = 1;
     temporal.api.taskqueue.v1.TaskQueue task_queue = 2;
+    // The identity of the worker/client
     string identity = 3;
     temporal.api.taskqueue.v1.TaskQueueMetadata task_queue_metadata = 4;
 }
 
 message PollActivityTaskQueueResponse {
+    // A unique identifier for this task
     bytes task_token = 1;
+    // The namespace the workflow which requested this activity lives in
     string workflow_namespace = 2;
+    // Type of the requesting workflow
     temporal.api.common.v1.WorkflowType workflow_type = 3;
+    // Execution info of the requesting workflow
     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.
     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.
     temporal.api.common.v1.Header header = 7;
+    // Arguments to the activity invocation
     temporal.api.common.v1.Payloads input = 8;
+    // Details of the last heartbeat that was recorded for this activity as of the time this task
+    // 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];
+    // When was this task attempt scheduled
     google.protobuf.Timestamp current_attempt_scheduled_time = 11 [(gogoproto.stdtime) = true];
+    // When was this task started (this attempt)
     google.protobuf.Timestamp started_time = 12 [(gogoproto.stdtime) = true];
+    // 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];
+    // 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];
+    // Window within which the activity must report a heartbeat, or be timed out.
     google.protobuf.Duration heartbeat_timeout = 16 [(gogoproto.stdduration) = true];
-    // This is an actual retry policy the service uses.
-    // It can be different from the one provided (or not) during activity scheduling
-    // as the service can override the provided one in case its values are not specified
-    // or exceed configured system limits.
+    // 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.
     temporal.api.common.v1.RetryPolicy retry_policy = 17;
 }
 
 message RecordActivityTaskHeartbeatRequest {
+    // The task token as received in `PollActivityTaskQueueResponse`
     bytes task_token = 1;
+    // Arbitrary data, of which the most recent call is kept, to store for this activity
     temporal.api.common.v1.Payloads details = 2;
+    // The identity of the worker/client
     string identity = 3;
     string namespace = 4;
 }
 
 message RecordActivityTaskHeartbeatResponse {
+    // Will be set to true if the activity has been asked to cancel itself. The SDK should then
+    // notify the activity of cancellation if it is still running.
     bool cancel_requested = 1;
 }
 
 message RecordActivityTaskHeartbeatByIdRequest {
+    // Namespace of the workflow which scheduled this activity
     string namespace = 1;
+    // Id of the workflow which scheduled this activity
     string workflow_id = 2;
+    // Run Id of the workflow which scheduled this activity
     string run_id = 3;
+    // Id of the activity we're heartbeating
     string activity_id = 4;
+    // Arbitrary data, of which the most recent call is kept, to store for this activity
     temporal.api.common.v1.Payloads details = 5;
+    // The identity of the worker/client
     string identity = 6;
 }
 
 message RecordActivityTaskHeartbeatByIdResponse {
+    // Will be set to true if the activity has been asked to cancel itself. The SDK should then
+    // notify the activity of cancellation if it is still running.
     bool cancel_requested = 1;
 }
 
 message RespondActivityTaskCompletedRequest {
+    // The task token as received in `PollActivityTaskQueueResponse`
     bytes task_token = 1;
+    // The result of successfully executing the activity
     temporal.api.common.v1.Payloads result = 2;
+    // The identity of the worker/client
     string identity = 3;
     string namespace = 4;
 }
@@ -297,11 +395,17 @@ message RespondActivityTaskCompletedResponse {
 }
 
 message RespondActivityTaskCompletedByIdRequest {
+    // Namespace of the workflow which scheduled this activity
     string namespace = 1;
+    // Id of the workflow which scheduled this activity
     string workflow_id = 2;
+    // Run Id of the workflow which scheduled this activity
     string run_id = 3;
+    // Id of the activity to complete
     string activity_id = 4;
+    // The serialized result of activity execution
     temporal.api.common.v1.Payloads result = 5;
+    // The identity of the worker/client
     string identity = 6;
 }
 
@@ -309,8 +413,11 @@ message RespondActivityTaskCompletedByIdResponse {
 }
 
 message RespondActivityTaskFailedRequest {
+    // The task token as received in `PollActivityTaskQueueResponse`
     bytes task_token = 1;
+    // Detailed failure information
     temporal.api.failure.v1.Failure failure = 2;
+    // The identity of the worker/client
     string identity = 3;
     string namespace = 4;
 }
@@ -319,11 +426,17 @@ message RespondActivityTaskFailedResponse {
 }
 
 message RespondActivityTaskFailedByIdRequest {
+    // Namespace of the workflow which scheduled this activity
     string namespace = 1;
+    // Id of the workflow which scheduled this activity
     string workflow_id = 2;
+    // Run Id of the workflow which scheduled this activity
     string run_id = 3;
+    // Id of the activity to fail
     string activity_id = 4;
+    // Detailed failure information
     temporal.api.failure.v1.Failure failure = 5;
+    // The identity of the worker/client
     string identity = 6;
 }
 
@@ -331,8 +444,11 @@ message RespondActivityTaskFailedByIdResponse {
 }
 
 message RespondActivityTaskCanceledRequest {
+    // The task token as received in `PollActivityTaskQueueResponse`
     bytes task_token = 1;
+    // Serialized additional information to attach to the cancellation
     temporal.api.common.v1.Payloads details = 2;
+    // The identity of the worker/client
     string identity = 3;
     string namespace = 4;
 }
@@ -341,11 +457,17 @@ message RespondActivityTaskCanceledResponse {
 }
 
 message RespondActivityTaskCanceledByIdRequest {
+    // Namespace of the workflow which scheduled this activity
     string namespace = 1;
+    // Id of the workflow which scheduled this activity
     string workflow_id = 2;
+    // Run Id of the workflow which scheduled this activity
     string run_id = 3;
+    // Id of the activity to confirm is cancelled
     string activity_id = 4;
+    // Serialized additional information to attach to the cancellation
     temporal.api.common.v1.Payloads details = 5;
+    // The identity of the worker/client
     string identity = 6;
 }
 
@@ -355,8 +477,11 @@ message RespondActivityTaskCanceledByIdResponse {
 message RequestCancelWorkflowExecutionRequest {
     string namespace = 1;
     temporal.api.common.v1.WorkflowExecution workflow_execution = 2;
+    // The identity of the worker/client
     string identity = 3;
+    // Used to de-dupe cancellation requests
     string request_id = 4;
+    // Should be removed. Appears unused.
     string first_execution_run_id = 5;
 }
 
@@ -366,11 +491,19 @@ message RequestCancelWorkflowExecutionResponse {
 message SignalWorkflowExecutionRequest {
     string namespace = 1;
     temporal.api.common.v1.WorkflowExecution workflow_execution = 2;
+    // The workflow author-defined name of the signal to send to the workflow
     string signal_name = 3;
+    // Serialized value(s) to provide with the signal
     temporal.api.common.v1.Payloads input = 4;
+    // The identity of the worker/client
     string identity = 5;
+    // Used to de-dupe sent signals
     string request_id = 6;
+    // Deprecated
     string control = 7;
+    // Headers that are passed with the signal to the processing workflow.
+    // These can include things like auth or tracing tokens.
+    temporal.api.common.v1.Header header = 8;
 }
 
 message SignalWorkflowExecutionResponse {
@@ -380,7 +513,9 @@ message SignalWithStartWorkflowExecutionRequest {
     string namespace = 1;
     string workflow_id = 2;
     temporal.api.common.v1.WorkflowType workflow_type = 3;
+    // The task queue to start this workflow on, if it will be started
     temporal.api.taskqueue.v1.TaskQueue task_queue = 4;
+    // 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];
@@ -388,14 +523,20 @@ message SignalWithStartWorkflowExecutionRequest {
     google.protobuf.Duration workflow_run_timeout = 7 [(gogoproto.stdduration) = true];
     // Timeout of a single workflow task
     google.protobuf.Duration workflow_task_timeout = 8 [(gogoproto.stdduration) = true];
+    // The identity of the worker/client
     string identity = 9;
+    // Used to de-dupe signal w/ start requests
     string request_id = 10;
     temporal.api.enums.v1.WorkflowIdReusePolicy workflow_id_reuse_policy = 11;
+    // The workflow author-defined name of the signal to send to the workflow
     string signal_name = 12;
+    // Serialized value(s) to provide with the signal
     temporal.api.common.v1.Payloads signal_input = 13;
+    // Deprecated
     string control = 14;
-    // Default: WORKFLOW_ID_REUSE_POLICY_ALLOW_DUPLICATE.
+    // Retry policy for the workflow Default: WORKFLOW_ID_REUSE_POLICY_ALLOW_DUPLICATE.
     temporal.api.common.v1.RetryPolicy retry_policy = 15;
+    // See https://docs.temporal.io/docs/content/what-is-a-temporal-cron-job/
     string cron_schedule = 16;
     temporal.api.common.v1.Memo memo = 17;
     temporal.api.common.v1.SearchAttributes search_attributes = 18;
@@ -410,8 +551,12 @@ message ResetWorkflowExecutionRequest {
     string namespace = 1;
     temporal.api.common.v1.WorkflowExecution workflow_execution = 2;
     string reason = 3;
+    // The id of a `WORKFLOW_TASK_COMPLETED`,`WORKFLOW_TASK_TIMED_OUT`, `WORKFLOW_TASK_FAILED`, or
+    // `WORKFLOW_TASK_STARTED` event to reset to.
     int64 workflow_task_finish_event_id = 4;
+    // Used to de-dupe reset requests
     string request_id = 5;
+    // Should be removed. Appears unused.
     temporal.api.enums.v1.ResetReapplyType reset_reapply_type = 6;
 }
 
@@ -423,8 +568,11 @@ message TerminateWorkflowExecutionRequest {
     string namespace = 1;
     temporal.api.common.v1.WorkflowExecution workflow_execution = 2;
     string reason = 3;
+    // Serialized additional information to attach to the termination event
     temporal.api.common.v1.Payloads details = 4;
+    // The identity of the worker/client
     string identity = 5;
+    // Should be removed. Appears unused.
     string first_execution_run_id = 6;
 }
 
@@ -516,7 +664,6 @@ message GetSearchAttributesResponse {
     map<string, temporal.api.enums.v1.IndexedValueType> keys = 1;
 }
 
-// TODO:  deprecated APIs
 message RespondQueryTaskCompletedRequest {
     bytes task_token = 1;
     temporal.api.enums.v1.QueryResultType completed_type = 2;
@@ -588,6 +735,8 @@ message GetClusterInfoResponse {
     temporal.api.version.v1.VersionInfo version_info = 4;
     string cluster_name = 5;
     int32 history_shard_count = 6;
+    string persistence_store = 7;
+    string visibility_store = 8;
 }
 
 message ListTaskQueuePartitionsRequest {