@temporalio/core-bridge 1.10.3 → 1.11.0

package/sdk-core/sdk-core-protos/protos/api_upstream/temporal/api/command/v1/message.proto

@@ -38,6 +38,7 @@ import "temporal/api/enums/v1/command_type.proto";
 import "temporal/api/common/v1/message.proto";
 import "temporal/api/failure/v1/message.proto";
 import "temporal/api/taskqueue/v1/message.proto";
+import "temporal/api/sdk/v1/user_metadata.proto";
 
 message ScheduleActivityTaskCommandAttributes {
     string activity_id = 1;
@@ -267,6 +268,18 @@ message RequestCancelNexusOperationCommandAttributes {
 
 message Command {
     temporal.api.enums.v1.CommandType command_type = 1;
+    // Metadata on the command. This is sometimes carried over to the history event if one is
+    // created as a result of the command. Most commands won't have this information, and how this
+    // information is used is dependent upon the interface that reads it.
+    //
+    // Current well-known uses:
+    //  * start_child_workflow_execution_command_attributes - populates
+    //    temporal.api.workflow.v1.WorkflowExecutionInfo.user_metadata where the summary and details
+    //    are used by user interfaces to show fixed as-of-start workflow summary and details.
+    //  * start_timer_command_attributes - populates temporal.api.history.v1.HistoryEvent for timer
+    //    started where the summary is used to identify the timer.
+    temporal.api.sdk.v1.UserMetadata user_metadata = 301;
+    // The command details. The type must match that in `command_type`.
     oneof attributes {
         ScheduleActivityTaskCommandAttributes schedule_activity_task_command_attributes = 2;
         StartTimerCommandAttributes start_timer_command_attributes = 3;

package/sdk-core/sdk-core-protos/protos/api_upstream/temporal/api/enums/v1/failed_cause.proto

@@ -137,6 +137,8 @@ enum ResourceExhaustedCause {
     RESOURCE_EXHAUSTED_CAUSE_BUSY_WORKFLOW = 5;
     // Caller exceeds action per second limit.
     RESOURCE_EXHAUSTED_CAUSE_APS_LIMIT = 6;
+    // Persistence storage limit exceeded.
+    RESOURCE_EXHAUSTED_CAUSE_PERSISTENCE_STORAGE_LIMIT = 7;
 }
 
 enum ResourceExhaustedScope {

package/sdk-core/sdk-core-protos/protos/api_upstream/temporal/api/enums/v1/task_queue.proto

@@ -80,16 +80,21 @@ enum TaskReachability {
 }
 
 // Specifies which category of tasks may reach a versioned worker of a certain Build ID.
+//
+// Task Reachability is eventually consistent; there may be a delay until it converges to the most
+// accurate value but it is designed in a way to take the more conservative side until it converges.
+// For example REACHABLE is more conservative than CLOSED_WORKFLOWS_ONLY.
+//
 // Note: future activities who inherit their workflow's Build ID but not its Task Queue will not be
-// accounted for reachability as server cannot not know if they'll happen as they do not use
+// accounted for reachability as server cannot know if they'll happen as they do not use
 // assignment rules of their Task Queue. Same goes for Child Workflows or Continue-As-New Workflows
 // who inherit the parent/previous workflow's Build ID but not its Task Queue. In those cases, make
 // sure to query reachability for the parent/previous workflow's Task Queue as well.
 enum BuildIdTaskReachability {
     // Task reachability is not reported
     BUILD_ID_TASK_REACHABILITY_UNSPECIFIED = 0;
-    // Build ID may be used by new workflows or activities (base on versioning rules), or there are
-    // open workflows or backlogged activities assigned to it.
+    // Build ID may be used by new workflows or activities (base on versioning rules), or there MAY
+    // be open workflows or backlogged activities assigned to it.
     BUILD_ID_TASK_REACHABILITY_REACHABLE = 1;
     // Build ID does not have open workflows and is not reachable by new workflows,
     // but MAY have closed workflows within the namespace retention period.

package/sdk-core/sdk-core-protos/protos/api_upstream/temporal/api/history/v1/message.proto

@@ -44,6 +44,7 @@ import "temporal/api/taskqueue/v1/message.proto";
 import "temporal/api/update/v1/message.proto";
 import "temporal/api/workflow/v1/message.proto";
 import "temporal/api/sdk/v1/task_complete_metadata.proto";
+import "temporal/api/sdk/v1/user_metadata.proto";
 
 // Always the first event in workflow history
 message WorkflowExecutionStartedEventAttributes {
@@ -892,6 +893,15 @@ message HistoryEvent {
     // type which it does not understand, it must error unless this is true. If it is true, it's
     // acceptable for the event type and/or attributes to be uninterpretable.
     bool worker_may_ignore = 300;
+    // Metadata on the event. This is often carried over from commands and client calls. Most events
+    // won't have this information, and how this information is used is dependent upon the interface
+    // that reads it.
+    //
+    // Current well-known uses:
+    //  * workflow_execution_started_event_attributes - summary and details from start workflow.
+    //  * timer_started_event_attributes - summary represents an identifier for the timer for use by
+    //    user interfaces.
+    temporal.api.sdk.v1.UserMetadata user_metadata = 301;
     // The event details. The type must match that in `event_type`.
     oneof attributes {
         WorkflowExecutionStartedEventAttributes workflow_execution_started_event_attributes = 6;

package/sdk-core/sdk-core-protos/protos/api_upstream/temporal/api/nexus/v1/message.proto

@@ -31,6 +31,7 @@ option csharp_namespace = "Temporalio.Api.Nexus.V1";
 
 import "google/protobuf/timestamp.proto";
 import "temporal/api/common/v1/message.proto";
+import "temporal/api/sdk/v1/user_metadata.proto";
 
 // A general purpose failure message.
 // See: https://github.com/nexus-rpc/api/blob/main/SPEC.md#failure
@@ -160,9 +161,8 @@ message EndpointSpec {
     // Endpoint name, unique for this cluster. Must match `[a-zA-Z_][a-zA-Z0-9_]*`.
     // Renaming an endpoint breaks all workflow callers that reference this endpoint, causing operations to fail.
     string name = 1;
-    // Markdown description serialized as a single JSON string.
-    // If the Payload is encrypted, the UI and CLI may decrypt with the configured codec server endpoint.
-    temporal.api.common.v1.Payload description = 2;
+
+    temporal.api.sdk.v1.UserMetadata metadata = 2;
 
     // Target to route requests to.
     EndpointTarget target = 3;

package/sdk-core/sdk-core-protos/protos/api_upstream/temporal/api/operatorservice/v1/service.proto

@@ -58,7 +58,7 @@ service OperatorService {
     // ListSearchAttributes returns comprehensive information about search attributes.
     rpc ListSearchAttributes (ListSearchAttributesRequest) returns (ListSearchAttributesResponse) {
         option (google.api.http) = {
-            get: "/api/v1/namespaces/{namespace}/search-attributes",
+            get: "/namespaces/{namespace}/search-attributes",
         };
     }
 
@@ -81,7 +81,7 @@ service OperatorService {
     // Get a registered Nexus endpoint by ID. The returned version can be used for optimistic updates.
     rpc GetNexusEndpoint(GetNexusEndpointRequest) returns (GetNexusEndpointResponse) {
         option (google.api.http) = {
-            get: "/api/v1/nexus/endpoints/{id}"
+            get: "/nexus/endpoints/{id}"
         };
     }
 
@@ -90,7 +90,7 @@ service OperatorService {
     // Returns the created endpoint with its initial version. You may use this version for subsequent updates.
     rpc CreateNexusEndpoint(CreateNexusEndpointRequest) returns (CreateNexusEndpointResponse) {
         option (google.api.http) = {
-            post: "/api/v1/nexus/endpoints"
+            post: "/nexus/endpoints"
             body: "*"
         };
     }
@@ -102,7 +102,7 @@ service OperatorService {
     // need to increment the version yourself. The server will increment the version for you after each update.
     rpc UpdateNexusEndpoint(UpdateNexusEndpointRequest) returns (UpdateNexusEndpointResponse) {
         option (google.api.http) = {
-            post: "/api/v1/nexus/endpoints/{id}/update"
+            post: "/nexus/endpoints/{id}/update"
             body: "*"
         };
     }
@@ -110,7 +110,7 @@ service OperatorService {
     // Delete an incoming Nexus service by ID.
     rpc DeleteNexusEndpoint(DeleteNexusEndpointRequest) returns (DeleteNexusEndpointResponse) {
         option (google.api.http) = {
-            delete: "/api/v1/nexus/endpoints/{id}"
+            delete: "/nexus/endpoints/{id}"
         };
     }
 
@@ -120,7 +120,7 @@ service OperatorService {
     // earlier than the previous page's last endpoint's ID may be missed.
     rpc ListNexusEndpoints(ListNexusEndpointsRequest) returns (ListNexusEndpointsResponse) {
         option (google.api.http) = {
-            get: "/api/v1/nexus/endpoints"
+            get: "/nexus/endpoints"
         };
     }
 }

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

@@ -0,0 +1,96 @@
+// The MIT License
+//
+// Copyright (c) 2024 Temporal Technologies Inc.  All rights reserved.
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in
+// all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+// THE SOFTWARE.
+
+syntax = "proto3";
+
+package temporal.api.sdk.v1;
+
+option go_package = "go.temporal.io/api/sdk/v1;sdk";
+option java_package = "io.temporal.api.sdk.v1";
+option java_multiple_files = true;
+option java_outer_classname = "EnhancedStackTraceProto";
+option ruby_package = "Temporalio::Api::Sdk::V1";
+option csharp_namespace = "Temporalio.Api.Sdk.V1";
+
+// Internal structure used to create worker stack traces with references to code.
+message EnhancedStackTrace {
+    // Information pertaining to the SDK that the trace has been captured from.
+    StackTraceSDKInfo sdk = 1;
+
+    // Mapping of file path to file contents.
+    map<string, StackTraceFileSlice> sources = 2;
+
+    // Collection of stacks captured.
+    repeated StackTrace stacks = 3;
+}
+
+// Information pertaining to the SDK that the trace has been captured from.
+// (-- api-linter: core::0123::resource-annotation=disabled
+//     aip.dev/not-precedent: Naming SDK version is optional. --)
+message StackTraceSDKInfo {
+    // Name of the SDK
+    string name = 1;
+
+    // Version string of the SDK
+    string version = 2;
+}
+
+// "Slice" of a file starting at line_offset -- a line offset and code fragment corresponding to the worker's stack.
+message StackTraceFileSlice {
+    // Only used (possibly) to trim the file without breaking syntax highlighting. This is not optional, unlike
+    // the `line` property of a `StackTraceFileLocation`.
+    // (-- api-linter: core::0141::forbidden-types=disabled
+    //     aip.dev/not-precedent: These really shouldn't have negative values. --)
+    uint32 line_offset = 1;
+
+    // Slice of a file with the respective OS-specific line terminator.
+    string content = 2;
+}
+
+// More specific location details of a file: its path, precise line and column numbers if applicable, and function name if available.
+// In essence, a pointer to a location in a file
+message StackTraceFileLocation {
+    // Path to source file (absolute or relative).
+    // If the paths are relative, ensure that they are all relative to the same root.
+    string file_path = 1;
+
+    // Optional; If possible, SDK should send this -- this is required for displaying the code location.
+    // If not provided, set to -1.
+    int32 line = 2;
+
+    // Optional; if possible, SDK should send this.
+    // If not provided, set to -1.
+    int32 column = 3;
+
+    // Function name this line belongs to, if applicable.
+    // Used for falling back to stack trace view.
+    string function_name = 4;
+    
+    // Flag to communicate whether a location should be hidden by default in the stack view.
+    bool internal_code = 5;
+}
+
+// Collection of FileLocation messages from a single stack.
+message StackTrace {
+    // Collection of `FileLocation`s, each for a stack frame that comprise a stack trace.
+    repeated StackTraceFileLocation locations = 1;
+}

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

@@ -0,0 +1,49 @@
+// The MIT License
+//
+// Copyright (c) 2024 Temporal Technologies Inc.  All rights reserved.
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in
+// all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+// THE SOFTWARE.
+
+syntax = "proto3";
+
+package temporal.api.sdk.v1;
+
+option go_package = "go.temporal.io/api/sdk/v1;sdk";
+option java_package = "io.temporal.api.sdk.v1";
+option java_multiple_files = true;
+option java_outer_classname = "UserMetadataProto";
+option ruby_package = "Temporalio::Api::Sdk::V1";
+option csharp_namespace = "Temporalio.Api.Sdk.V1";
+
+
+import "temporal/api/common/v1/message.proto";
+
+// Information a user can set, often for use by user interfaces.
+message UserMetadata {
+  // Short-form text that provides a summary. This payload should be a "json/plain"-encoded payload
+  // that is a single JSON string for use in user interfaces. User interface formatting may not
+  // apply to this text when used in "title" situations. The payload data section is limited to 400
+  // bytes by default.
+  temporal.api.common.v1.Payload summary = 1;
+
+  // Long-form text that provides details. This payload should be a "json/plain"-encoded payload
+  // that is a single JSON string for use in user interfaces. User interface formatting may apply to
+  // this text in common use. The payload data section is limited to 20000 bytes by default.
+  temporal.api.common.v1.Payload details = 2;
+}

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

@@ -35,6 +35,9 @@ option csharp_namespace = "Temporalio.Api.Sdk.V1";
 message WorkflowMetadata {
   // Metadata provided at declaration or creation time.
   WorkflowDefinition definition = 1;
+  // Current long-form details of the workflow's state. This is used by user interfaces to show
+  // long-form text. This text may be formatted by the user interface.
+  string current_details = 2;
 }
 
 // (-- api-linter: core::0203::optional=disabled --)
@@ -42,13 +45,9 @@ message WorkflowDefinition {
   // A name scoped by the task queue that maps to this workflow definition.
   // If missing, this workflow is a dynamic workflow.
   string type = 1;
-  // An optional workflow description provided by the application.
-  // By convention, external tools may interpret its first part,
-  // i.e., ending with a line break, as a summary of the description.
-  string description = 2;
-  repeated WorkflowInteractionDefinition query_definitions = 3;
-  repeated WorkflowInteractionDefinition signal_definitions = 4;
-  repeated WorkflowInteractionDefinition update_definitions = 5;
+  repeated WorkflowInteractionDefinition query_definitions = 2;
+  repeated WorkflowInteractionDefinition signal_definitions = 3;
+  repeated WorkflowInteractionDefinition update_definitions = 4;
 }
 
 // (-- api-linter: core::0123::resource-annotation=disabled

package/sdk-core/sdk-core-protos/protos/api_upstream/temporal/api/taskqueue/v1/message.proto

@@ -68,12 +68,40 @@ message TaskQueueVersionSelection {
 message TaskQueueVersionInfo {
     // Task Queue info per Task Type. Key is the numerical value of the temporal.api.enums.v1.TaskQueueType enum.
     map<int32, TaskQueueTypeInfo> types_info = 1;
+
+    // Task Reachability is eventually consistent; there may be a delay until it converges to the most
+    // accurate value but it is designed in a way to take the more conservative side until it converges.
+    // For example REACHABLE is more conservative than CLOSED_WORKFLOWS_ONLY.
+    //
+    // Note: future activities who inherit their workflow's Build ID but not its Task Queue will not be
+    // accounted for reachability as server cannot know if they'll happen as they do not use
+    // assignment rules of their Task Queue. Same goes for Child Workflows or Continue-As-New Workflows
+    // who inherit the parent/previous workflow's Build ID but not its Task Queue. In those cases, make
+    // sure to query reachability for the parent/previous workflow's Task Queue as well.
     temporal.api.enums.v1.BuildIdTaskReachability task_reachability = 2;
 }
 
 message TaskQueueTypeInfo {
     // Unversioned workers (with `useVersioning=false`) are reported in unversioned result even if they set a Build ID.
     repeated PollerInfo pollers = 1;
+    TaskQueueStats stats = 2;
+}
+
+// For workflow task queues, we only report the normal queue stats, not sticky queues. This means the stats
+// reported here do not count all workflow tasks. However, because the tasks queued in sticky queues only remain
+// valid for a few seconds, the inaccuracy becomes less significant as the backlog age grows.
+message TaskQueueStats {
+    // The approximate number of tasks backlogged in this task queue. May count expired tasks but eventually converges
+    // to the right value.
+    int64 approximate_backlog_count = 1;
+    // Approximate age of the oldest task in the backlog based on the create timestamp of the task at the head of the queue.
+    google.protobuf.Duration approximate_backlog_age = 2;
+    // Approximate tasks per second added to the task queue based on activity within a fixed window. This includes both backlogged and
+    // sync-matched tasks.
+    float tasks_add_rate = 3;
+    // Approximate tasks per second dispatched to workers based on activity within a fixed window. This includes both backlogged and
+    // sync-matched tasks.
+    float tasks_dispatch_rate = 4;
 }
 
 // Deprecated. Use `InternalTaskQueueStatus`. This is kept until `DescribeTaskQueue` supports legacy behavior.
@@ -140,29 +168,31 @@ message RampByPercentage {
     float ramp_percentage = 1;
 }
 
-// These rules assign a Build ID to Unassigned Workflow Executions and
-// Activities.
+// Assignment rules are applied to *new* Workflow and Activity executions at
+// schedule time to assign them to a Build ID.
 //
-// Specifically, assignment rules are applied to the following Executions or
-// Activities when they are scheduled in a Task Queue:
-//    - Generally, any new Workflow Execution, except:
-//      - When A Child Workflow or a Continue-As-New Execution inherits the
-//        Build ID from its parent/previous execution by setting the
-//        `inherit_build_id` flag.
-//      - Workflow Executions started Eagerly are assigned to the Build ID of
-//        the Starter.
-//    - An Activity that is scheduled on a Task Queue different from the one
-//      their Workflow runs on, unless the `use_workflow_build_id` flag is set.
+// Assignment rules will not be used in the following cases:
+//    - Child Workflows or Continue-As-New Executions who inherit their
+//      parent/previous Workflow's assigned Build ID (by setting the
+//      `inherit_build_id` flag - default behavior in SDKs when the same Task Queue
+//      is used.)
+//    - An Activity that inherits the assigned Build ID of its Workflow (by
+//      setting the `use_workflow_build_id` flag - default behavior in SDKs
+//      when the same Task Queue is used.)
 //
 // In absence of (applicable) redirect rules (`CompatibleBuildIdRedirectRule`s)
 // the task will be dispatched to Workers of the Build ID determined by the
-// assignment rules. Otherwise, the final Build ID will be determined by the
-// redirect rules.
+// assignment rules (or inherited). Otherwise, the final Build ID will be
+// determined by the redirect rules.
+//
+// Once a Workflow completes its first Workflow Task in a particular Build ID it
+// stays in that Build ID regardless of changes to assignment rules. Redirect
+// rules can be used to move the workflow to another compatible Build ID.
 //
-// When using Worker Versioning, in the steady state, for a given Task Queue,
-// there should typically be exactly one assignment rule to send all Unassigned
-// tasks to the latest Build ID. Existence of at least one such "unconditional"
-// rule at all times is enforce by the system, unless the `force` flag is used
+// When using Worker Versioning on a Task Queue, in the steady state,
+// there should typically be a single assignment rule to send all new executions
+// to the latest Build ID. Existence of at least one such "unconditional"
+// rule at all times is enforces by the system, unless the `force` flag is used
 // by the user when replacing/deleting these rules (for exceptional cases).
 //
 // During a deployment, one or more additional rules can be added to assign a
@@ -173,10 +203,8 @@ message RampByPercentage {
 // applied and the rest will be ignored.
 //
 // In the event that no assignment rule is applicable on a task (or the Task
-// Queue is simply not versioned), the tasks will be sent to unversioned
-// workers, if available. Otherwise, they remain Unassigned, and will be
-// retried for assignment, or dispatch to unversioned workers, at a later time
-// depending on the availability of workers.
+// Queue is simply not versioned), the tasks will be dispatched to an
+// unversioned Worker.
 message BuildIdAssignmentRule {
     string target_build_id = 1;
 
@@ -211,10 +239,13 @@ message BuildIdAssignmentRule {
 //  - To be able to Reset an old Execution so it can run on the current
 //    (compatible) Build ID.
 //
-// Redirect rules can be chained, but only the last rule in the chain can have
-// a ramp.
+// Redirect rules can be chained.
 message CompatibleBuildIdRedirectRule {
     string source_build_id = 1;
+    // Target Build ID must be compatible with the Source Build ID; that is it
+    // must be able to process event histories made by the Source Build ID by
+    // using [Patching](https://docs.temporal.io/workflows#patching) or other
+    // means.
     string target_build_id = 2;
 }
 

package/sdk-core/sdk-core-protos/protos/api_upstream/temporal/api/workflow/v1/message.proto

@@ -40,6 +40,7 @@ import "temporal/api/enums/v1/workflow.proto";
 import "temporal/api/common/v1/message.proto";
 import "temporal/api/failure/v1/message.proto";
 import "temporal/api/taskqueue/v1/message.proto";
+import "temporal/api/sdk/v1/user_metadata.proto";
 
 message WorkflowExecutionInfo {
     temporal.api.common.v1.WorkflowExecution execution = 1;
@@ -97,6 +98,8 @@ message WorkflowExecutionConfig {
     google.protobuf.Duration workflow_execution_timeout = 2;
     google.protobuf.Duration workflow_run_timeout = 3;
     google.protobuf.Duration default_workflow_task_timeout = 4;
+    // User metadata provided on start workflow.
+    temporal.api.sdk.v1.UserMetadata user_metadata = 5;
 }
 
 message PendingActivityInfo {
@@ -197,6 +200,10 @@ message NewWorkflowExecutionInfo {
     temporal.api.common.v1.Memo memo = 11;
     temporal.api.common.v1.SearchAttributes search_attributes = 12;
     temporal.api.common.v1.Header header = 13;
+    // Metadata on the workflow if it is started. This is carried over to the WorkflowExecutionConfig
+    // for use by user interfaces to display the fixed as-of-start summary and details of the
+    // workflow.
+    temporal.api.sdk.v1.UserMetadata user_metadata = 14;
 }
 
 // CallbackInfo contains the state of an attached workflow callback.

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

@@ -56,6 +56,7 @@ import "temporal/api/update/v1/message.proto";
 import "temporal/api/version/v1/message.proto";
 import "temporal/api/batch/v1/message.proto";
 import "temporal/api/sdk/v1/task_complete_metadata.proto";
+import "temporal/api/sdk/v1/user_metadata.proto";
 import "temporal/api/nexus/v1/message.proto";
 
 import "google/protobuf/duration.proto";
@@ -192,6 +193,10 @@ message StartWorkflowExecutionRequest {
     // If the workflow continues-as-new, these callbacks will be carried over to the new execution.
     // Callback addresses must be whitelisted in the server's dynamic configuration.
     repeated temporal.api.common.v1.Callback completion_callbacks = 21;
+    // Metadata on the workflow if it is started. This is carried over to the WorkflowExecutionInfo
+    // for use by user interfaces to display the fixed as-of-start summary and details of the
+    // workflow.
+    temporal.api.sdk.v1.UserMetadata user_metadata = 23;
 }
 
 message StartWorkflowExecutionResponse {
@@ -273,8 +278,16 @@ message PollWorkflowTaskQueueResponse {
     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.
+    // A hint that there are more tasks already present in this task queue 
+    // partition. Can be used to prioritize draining a sticky queue.
+    //
+    // Specifically, the returned number is the number of tasks remaining in
+    // the in-memory buffer for this partition, which is currently capped at
+    // 1000. Because sticky queues only have one partition, this number is 
+    // more useful when draining them. Normal queues, typically having more than one 
+    // partition, will return a number representing only some portion of the 
+    // overall backlog. Subsequent RPCs may not hit the same partition as 
+    // this call.
     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
@@ -676,6 +689,10 @@ message SignalWithStartWorkflowExecutionRequest {
     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;
+    // Metadata on the workflow if it is started. This is carried over to the WorkflowExecutionInfo
+    // for use by user interfaces to display the fixed as-of-start summary and details of the
+    // workflow.
+    temporal.api.sdk.v1.UserMetadata user_metadata = 23;
 }
 
 message SignalWithStartWorkflowExecutionResponse {
@@ -902,8 +919,8 @@ message DescribeTaskQueueRequest {
 
     // Task queue types to report info about. If not specified, all types are considered.
     repeated temporal.api.enums.v1.TaskQueueType task_queue_types = 7;
-    // Report backlog info for the requested task queue types and versions
-    // bool report_backlog_info = 8;
+    // Report stats for the requested task queue types and versions
+    bool report_stats = 8;
     // Report list of pollers for requested task queue types and versions
     bool report_pollers = 9;
     // Report task reachability for the requested versions and all task types (task reachability is not reported