@temporalio/proto 1.10.3 → 1.11.1

package/protos/root.d.ts

@@ -9351,7 +9351,8 @@ export namespace temporal {
                     RESOURCE_EXHAUSTED_CAUSE_SYSTEM_OVERLOADED = 3,
                     RESOURCE_EXHAUSTED_CAUSE_PERSISTENCE_LIMIT = 4,
                     RESOURCE_EXHAUSTED_CAUSE_BUSY_WORKFLOW = 5,
-                    RESOURCE_EXHAUSTED_CAUSE_APS_LIMIT = 6
+                    RESOURCE_EXHAUSTED_CAUSE_APS_LIMIT = 6,
+                    RESOURCE_EXHAUSTED_CAUSE_PERSISTENCE_STORAGE_LIMIT = 7
                 }
 
                 /** ResourceExhaustedScope enum. */
@@ -9446,8 +9447,13 @@ export namespace temporal {
 
                 /**
                  * 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.
@@ -12826,7 +12832,26 @@ export namespace temporal {
                     public getWorkerBuildIdCompatibility(request: temporal.api.workflowservice.v1.IGetWorkerBuildIdCompatibilityRequest): Promise<temporal.api.workflowservice.v1.GetWorkerBuildIdCompatibilityResponse>;
 
                     /**
-                     * Allows updating the Build ID assignment and redirect rules for a given Task Queue.
+                     * Use this API to manage Worker Versioning Rules for a given Task Queue. There are two types of
+                     * rules: Build ID Assignment rules and Compatible Build ID Redirect rules.
+                     *
+                     * Assignment rules are used to assign a Build ID for a new execution when it starts. Its primary
+                     * use case is to specify the latest Build ID but it has powerful features for gradual rollout
+                     * of a new Build ID.
+                     *
+                     * Once a Build ID is assigned to a workflow execution and it completes its first Workflow Task,
+                     * the workflow stays on the assigned Build ID regardless of changes in assignment rules. This
+                     * eliminates the need for compatibility between versions when you only care about using the new
+                     * version for new workflows and let existing workflows finish in their own version.
+                     *
+                     * Activities, Child Workflows and Continue-as-New executions have the option to inherit their
+                     * parent/previous workflow or use the latest assigment rules to independently select a Build ID.
+                     *
+                     * Redirect rules should only be used when you want to move workflows and activities assigned to
+                     * one Build ID (source) to another compatible Build ID (target). You are responsible to make sure
+                     * the target Build ID of a redirect rule is able to process event histories made by the source
+                     * Build ID by using [Patching](https://docs.temporal.io/workflows#patching) or other means.
+                     *
                      * WARNING: Worker Versioning is not yet stable and the API and behavior may change incompatibly.
                      * (-- api-linter: core::0127::http-annotation=disabled
                      * aip.dev/not-precedent: We do yet expose versioning API to HTTP. --)
@@ -12836,7 +12861,26 @@ export namespace temporal {
                     public updateWorkerVersioningRules(request: temporal.api.workflowservice.v1.IUpdateWorkerVersioningRulesRequest, callback: temporal.api.workflowservice.v1.WorkflowService.UpdateWorkerVersioningRulesCallback): void;
 
                     /**
-                     * Allows updating the Build ID assignment and redirect rules for a given Task Queue.
+                     * Use this API to manage Worker Versioning Rules for a given Task Queue. There are two types of
+                     * rules: Build ID Assignment rules and Compatible Build ID Redirect rules.
+                     *
+                     * Assignment rules are used to assign a Build ID for a new execution when it starts. Its primary
+                     * use case is to specify the latest Build ID but it has powerful features for gradual rollout
+                     * of a new Build ID.
+                     *
+                     * Once a Build ID is assigned to a workflow execution and it completes its first Workflow Task,
+                     * the workflow stays on the assigned Build ID regardless of changes in assignment rules. This
+                     * eliminates the need for compatibility between versions when you only care about using the new
+                     * version for new workflows and let existing workflows finish in their own version.
+                     *
+                     * Activities, Child Workflows and Continue-as-New executions have the option to inherit their
+                     * parent/previous workflow or use the latest assigment rules to independently select a Build ID.
+                     *
+                     * Redirect rules should only be used when you want to move workflows and activities assigned to
+                     * one Build ID (source) to another compatible Build ID (target). You are responsible to make sure
+                     * the target Build ID of a redirect rule is able to process event histories made by the source
+                     * Build ID by using [Patching](https://docs.temporal.io/workflows#patching) or other means.
+                     *
                      * WARNING: Worker Versioning is not yet stable and the API and behavior may change incompatibly.
                      * (-- api-linter: core::0127::http-annotation=disabled
                      * aip.dev/not-precedent: We do yet expose versioning API to HTTP. --)
@@ -14678,6 +14722,13 @@ export namespace temporal {
                      * Callback addresses must be whitelisted in the server's dynamic configuration.
                      */
                     completionCallbacks?: (temporal.api.common.v1.ICallback[]|null);
+
+                    /**
+                     * 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.
+                     */
+                    userMetadata?: (temporal.api.sdk.v1.IUserMetadata|null);
                 }
 
                 /** Represents a StartWorkflowExecutionRequest. */
@@ -14783,6 +14834,13 @@ export namespace temporal {
                      */
                     public completionCallbacks: temporal.api.common.v1.ICallback[];
 
+                    /**
+                     * 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.
+                     */
+                    public userMetadata?: (temporal.api.sdk.v1.IUserMetadata|null);
+
                     /**
                      * Creates a new StartWorkflowExecutionRequest instance using the specified properties.
                      * @param [properties] Properties to set
@@ -15584,8 +15642,16 @@ export namespace temporal {
                     attempt?: (number|null);
 
                     /**
-                     * 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.
                      */
                     backlogCountHint?: (Long|null);
 
@@ -15668,8 +15734,16 @@ export namespace temporal {
                     public attempt: number;
 
                     /**
-                     * 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.
                      */
                     public backlogCountHint: Long;
 
@@ -18894,6 +18968,13 @@ export namespace temporal {
 
                     /** Indicates that a new workflow task should not be generated when this signal is received. */
                     skipGenerateWorkflowTask?: (boolean|null);
+
+                    /**
+                     * 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.
+                     */
+                    userMetadata?: (temporal.api.sdk.v1.IUserMetadata|null);
                 }
 
                 /** Represents a SignalWithStartWorkflowExecutionRequest. */
@@ -18989,6 +19070,13 @@ export namespace temporal {
                     /** Indicates that a new workflow task should not be generated when this signal is received. */
                     public skipGenerateWorkflowTask: boolean;
 
+                    /**
+                     * 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.
+                     */
+                    public userMetadata?: (temporal.api.sdk.v1.IUserMetadata|null);
+
                     /**
                      * Creates a new SignalWithStartWorkflowExecutionRequest instance using the specified properties.
                      * @param [properties] Properties to set
@@ -22157,11 +22245,10 @@ export namespace temporal {
                     /** Task queue types to report info about. If not specified, all types are considered. */
                     taskQueueTypes?: (temporal.api.enums.v1.TaskQueueType[]|null);
 
-                    /**
-                     * Report backlog info for the requested task queue types and versions
-                     * bool report_backlog_info = 8;
-                     * Report list of pollers for requested task queue types and versions
-                     */
+                    /** Report stats for the requested task queue types and versions */
+                    reportStats?: (boolean|null);
+
+                    /** Report list of pollers for requested task queue types and versions */
                     reportPollers?: (boolean|null);
 
                     /**
@@ -22212,11 +22299,10 @@ export namespace temporal {
                     /** Task queue types to report info about. If not specified, all types are considered. */
                     public taskQueueTypes: temporal.api.enums.v1.TaskQueueType[];
 
-                    /**
-                     * Report backlog info for the requested task queue types and versions
-                     * bool report_backlog_info = 8;
-                     * Report list of pollers for requested task queue types and versions
-                     */
+                    /** Report stats for the requested task queue types and versions */
+                    public reportStats: boolean;
+
+                    /** Report list of pollers for requested task queue types and versions */
                     public reportPollers: boolean;
 
                     /**
@@ -36203,6 +36289,18 @@ export namespace temporal {
                      */
                     workerMayIgnore?: (boolean|null);
 
+                    /**
+                     * 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.
+                     */
+                    userMetadata?: (temporal.api.sdk.v1.IUserMetadata|null);
+
                     /** HistoryEvent workflowExecutionStartedEventAttributes */
                     workflowExecutionStartedEventAttributes?: (temporal.api.history.v1.IWorkflowExecutionStartedEventAttributes|null);
 
@@ -36401,6 +36499,18 @@ export namespace temporal {
                      */
                     public workerMayIgnore: boolean;
 
+                    /**
+                     * 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.
+                     */
+                    public userMetadata?: (temporal.api.sdk.v1.IUserMetadata|null);
+
                     /** HistoryEvent workflowExecutionStartedEventAttributes. */
                     public workflowExecutionStartedEventAttributes?: (temporal.api.history.v1.IWorkflowExecutionStartedEventAttributes|null);
 
@@ -37047,7 +37157,17 @@ export namespace temporal {
                     /** Task Queue info per Task Type. Key is the numerical value of the temporal.api.enums.v1.TaskQueueType enum. */
                     typesInfo?: ({ [k: string]: temporal.api.taskqueue.v1.ITaskQueueTypeInfo }|null);
 
-                    /** TaskQueueVersionInfo taskReachability */
+                    /**
+                     * 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.
+                     */
                     taskReachability?: (temporal.api.enums.v1.BuildIdTaskReachability|null);
                 }
 
@@ -37063,7 +37183,17 @@ export namespace temporal {
                     /** Task Queue info per Task Type. Key is the numerical value of the temporal.api.enums.v1.TaskQueueType enum. */
                     public typesInfo: { [k: string]: temporal.api.taskqueue.v1.ITaskQueueTypeInfo };
 
-                    /** TaskQueueVersionInfo taskReachability. */
+                    /**
+                     * 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.
+                     */
                     public taskReachability: temporal.api.enums.v1.BuildIdTaskReachability;
 
                     /**
@@ -37142,6 +37272,9 @@ export namespace temporal {
 
                     /** Unversioned workers (with `useVersioning=false`) are reported in unversioned result even if they set a Build ID. */
                     pollers?: (temporal.api.taskqueue.v1.IPollerInfo[]|null);
+
+                    /** TaskQueueTypeInfo stats */
+                    stats?: (temporal.api.taskqueue.v1.ITaskQueueStats|null);
                 }
 
                 /** Represents a TaskQueueTypeInfo. */
@@ -37156,6 +37289,9 @@ export namespace temporal {
                     /** Unversioned workers (with `useVersioning=false`) are reported in unversioned result even if they set a Build ID. */
                     public pollers: temporal.api.taskqueue.v1.IPollerInfo[];
 
+                    /** TaskQueueTypeInfo stats. */
+                    public stats?: (temporal.api.taskqueue.v1.ITaskQueueStats|null);
+
                     /**
                      * Creates a new TaskQueueTypeInfo instance using the specified properties.
                      * @param [properties] Properties to set
@@ -37227,6 +37363,136 @@ export namespace temporal {
                     public static getTypeUrl(typeUrlPrefix?: string): string;
                 }
 
+                /** Properties of a TaskQueueStats. */
+                interface ITaskQueueStats {
+
+                    /**
+                     * The approximate number of tasks backlogged in this task queue. May count expired tasks but eventually converges
+                     * to the right value.
+                     */
+                    approximateBacklogCount?: (Long|null);
+
+                    /** Approximate age of the oldest task in the backlog based on the create timestamp of the task at the head of the queue. */
+                    approximateBacklogAge?: (google.protobuf.IDuration|null);
+
+                    /**
+                     * Approximate tasks per second added to the task queue based on activity within a fixed window. This includes both backlogged and
+                     * sync-matched tasks.
+                     */
+                    tasksAddRate?: (number|null);
+
+                    /**
+                     * Approximate tasks per second dispatched to workers based on activity within a fixed window. This includes both backlogged and
+                     * sync-matched tasks.
+                     */
+                    tasksDispatchRate?: (number|null);
+                }
+
+                /**
+                 * 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.
+                 */
+                class TaskQueueStats implements ITaskQueueStats {
+
+                    /**
+                     * Constructs a new TaskQueueStats.
+                     * @param [properties] Properties to set
+                     */
+                    constructor(properties?: temporal.api.taskqueue.v1.ITaskQueueStats);
+
+                    /**
+                     * The approximate number of tasks backlogged in this task queue. May count expired tasks but eventually converges
+                     * to the right value.
+                     */
+                    public approximateBacklogCount: Long;
+
+                    /** Approximate age of the oldest task in the backlog based on the create timestamp of the task at the head of the queue. */
+                    public approximateBacklogAge?: (google.protobuf.IDuration|null);
+
+                    /**
+                     * Approximate tasks per second added to the task queue based on activity within a fixed window. This includes both backlogged and
+                     * sync-matched tasks.
+                     */
+                    public tasksAddRate: number;
+
+                    /**
+                     * Approximate tasks per second dispatched to workers based on activity within a fixed window. This includes both backlogged and
+                     * sync-matched tasks.
+                     */
+                    public tasksDispatchRate: number;
+
+                    /**
+                     * Creates a new TaskQueueStats instance using the specified properties.
+                     * @param [properties] Properties to set
+                     * @returns TaskQueueStats instance
+                     */
+                    public static create(properties?: temporal.api.taskqueue.v1.ITaskQueueStats): temporal.api.taskqueue.v1.TaskQueueStats;
+
+                    /**
+                     * Encodes the specified TaskQueueStats message. Does not implicitly {@link temporal.api.taskqueue.v1.TaskQueueStats.verify|verify} messages.
+                     * @param message TaskQueueStats message or plain object to encode
+                     * @param [writer] Writer to encode to
+                     * @returns Writer
+                     */
+                    public static encode(message: temporal.api.taskqueue.v1.ITaskQueueStats, writer?: $protobuf.Writer): $protobuf.Writer;
+
+                    /**
+                     * Encodes the specified TaskQueueStats message, length delimited. Does not implicitly {@link temporal.api.taskqueue.v1.TaskQueueStats.verify|verify} messages.
+                     * @param message TaskQueueStats message or plain object to encode
+                     * @param [writer] Writer to encode to
+                     * @returns Writer
+                     */
+                    public static encodeDelimited(message: temporal.api.taskqueue.v1.ITaskQueueStats, writer?: $protobuf.Writer): $protobuf.Writer;
+
+                    /**
+                     * Decodes a TaskQueueStats message from the specified reader or buffer.
+                     * @param reader Reader or buffer to decode from
+                     * @param [length] Message length if known beforehand
+                     * @returns TaskQueueStats
+                     * @throws {Error} If the payload is not a reader or valid buffer
+                     * @throws {$protobuf.util.ProtocolError} If required fields are missing
+                     */
+                    public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): temporal.api.taskqueue.v1.TaskQueueStats;
+
+                    /**
+                     * Decodes a TaskQueueStats message from the specified reader or buffer, length delimited.
+                     * @param reader Reader or buffer to decode from
+                     * @returns TaskQueueStats
+                     * @throws {Error} If the payload is not a reader or valid buffer
+                     * @throws {$protobuf.util.ProtocolError} If required fields are missing
+                     */
+                    public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): temporal.api.taskqueue.v1.TaskQueueStats;
+
+                    /**
+                     * Creates a TaskQueueStats message from a plain object. Also converts values to their respective internal types.
+                     * @param object Plain object
+                     * @returns TaskQueueStats
+                     */
+                    public static fromObject(object: { [k: string]: any }): temporal.api.taskqueue.v1.TaskQueueStats;
+
+                    /**
+                     * Creates a plain object from a TaskQueueStats message. Also converts values to other types if specified.
+                     * @param message TaskQueueStats
+                     * @param [options] Conversion options
+                     * @returns Plain object
+                     */
+                    public static toObject(message: temporal.api.taskqueue.v1.TaskQueueStats, options?: $protobuf.IConversionOptions): { [k: string]: any };
+
+                    /**
+                     * Converts this TaskQueueStats to JSON.
+                     * @returns JSON object
+                     */
+                    public toJSON(): { [k: string]: any };
+
+                    /**
+                     * Gets the default type url for TaskQueueStats
+                     * @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
+                     * @returns The default type url
+                     */
+                    public static getTypeUrl(typeUrlPrefix?: string): string;
+                }
+
                 /** Properties of a TaskQueueStatus. */
                 interface ITaskQueueStatus {
 
@@ -38147,29 +38413,31 @@ export namespace temporal {
                 }
 
                 /**
-                 * 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.
                  *
-                 * 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
+                 * 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 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
@@ -38180,10 +38448,8 @@ export namespace temporal {
                  * 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.
                  */
                 class BuildIdAssignmentRule implements IBuildIdAssignmentRule {
 
@@ -38288,7 +38554,12 @@ export namespace temporal {
                     /** CompatibleBuildIdRedirectRule sourceBuildId */
                     sourceBuildId?: (string|null);
 
-                    /** CompatibleBuildIdRedirectRule targetBuildId */
+                    /**
+                     * 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.
+                     */
                     targetBuildId?: (string|null);
                 }
 
@@ -38312,8 +38583,7 @@ export namespace temporal {
                  * - 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.
                  */
                 class CompatibleBuildIdRedirectRule implements ICompatibleBuildIdRedirectRule {
 
@@ -38326,7 +38596,12 @@ export namespace temporal {
                     /** CompatibleBuildIdRedirectRule sourceBuildId. */
                     public sourceBuildId: string;
 
-                    /** CompatibleBuildIdRedirectRule targetBuildId. */
+                    /**
+                     * 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.
+                     */
                     public targetBuildId: string;
 
                     /**
@@ -38880,6 +39155,9 @@ export namespace temporal {
 
                     /** WorkflowExecutionConfig defaultWorkflowTaskTimeout */
                     defaultWorkflowTaskTimeout?: (google.protobuf.IDuration|null);
+
+                    /** User metadata provided on start workflow. */
+                    userMetadata?: (temporal.api.sdk.v1.IUserMetadata|null);
                 }
 
                 /** Represents a WorkflowExecutionConfig. */
@@ -38903,6 +39181,9 @@ export namespace temporal {
                     /** WorkflowExecutionConfig defaultWorkflowTaskTimeout. */
                     public defaultWorkflowTaskTimeout?: (google.protobuf.IDuration|null);
 
+                    /** User metadata provided on start workflow. */
+                    public userMetadata?: (temporal.api.sdk.v1.IUserMetadata|null);
+
                     /**
                      * Creates a new WorkflowExecutionConfig instance using the specified properties.
                      * @param [properties] Properties to set
@@ -39672,6 +39953,13 @@ export namespace temporal {
 
                     /** NewWorkflowExecutionInfo header */
                     header?: (temporal.api.common.v1.IHeader|null);
+
+                    /**
+                     * 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.
+                     */
+                    userMetadata?: (temporal.api.sdk.v1.IUserMetadata|null);
                 }
 
                 /**
@@ -39725,6 +40013,13 @@ export namespace temporal {
                     /** NewWorkflowExecutionInfo header. */
                     public header?: (temporal.api.common.v1.IHeader|null);
 
+                    /**
+                     * 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.
+                     */
+                    public userMetadata?: (temporal.api.sdk.v1.IUserMetadata|null);
+
                     /**
                      * Creates a new NewWorkflowExecutionInfo instance using the specified properties.
                      * @param [properties] Properties to set
@@ -40426,6 +40721,120 @@ export namespace temporal {
             /** Namespace v1. */
             namespace v1 {
 
+                /** Properties of a UserMetadata. */
+                interface IUserMetadata {
+
+                    /**
+                     * 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.
+                     */
+                    summary?: (temporal.api.common.v1.IPayload|null);
+
+                    /**
+                     * 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.
+                     */
+                    details?: (temporal.api.common.v1.IPayload|null);
+                }
+
+                /** Information a user can set, often for use by user interfaces. */
+                class UserMetadata implements IUserMetadata {
+
+                    /**
+                     * Constructs a new UserMetadata.
+                     * @param [properties] Properties to set
+                     */
+                    constructor(properties?: temporal.api.sdk.v1.IUserMetadata);
+
+                    /**
+                     * 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.
+                     */
+                    public summary?: (temporal.api.common.v1.IPayload|null);
+
+                    /**
+                     * 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.
+                     */
+                    public details?: (temporal.api.common.v1.IPayload|null);
+
+                    /**
+                     * Creates a new UserMetadata instance using the specified properties.
+                     * @param [properties] Properties to set
+                     * @returns UserMetadata instance
+                     */
+                    public static create(properties?: temporal.api.sdk.v1.IUserMetadata): temporal.api.sdk.v1.UserMetadata;
+
+                    /**
+                     * Encodes the specified UserMetadata message. Does not implicitly {@link temporal.api.sdk.v1.UserMetadata.verify|verify} messages.
+                     * @param message UserMetadata message or plain object to encode
+                     * @param [writer] Writer to encode to
+                     * @returns Writer
+                     */
+                    public static encode(message: temporal.api.sdk.v1.IUserMetadata, writer?: $protobuf.Writer): $protobuf.Writer;
+
+                    /**
+                     * Encodes the specified UserMetadata message, length delimited. Does not implicitly {@link temporal.api.sdk.v1.UserMetadata.verify|verify} messages.
+                     * @param message UserMetadata message or plain object to encode
+                     * @param [writer] Writer to encode to
+                     * @returns Writer
+                     */
+                    public static encodeDelimited(message: temporal.api.sdk.v1.IUserMetadata, writer?: $protobuf.Writer): $protobuf.Writer;
+
+                    /**
+                     * Decodes a UserMetadata message from the specified reader or buffer.
+                     * @param reader Reader or buffer to decode from
+                     * @param [length] Message length if known beforehand
+                     * @returns UserMetadata
+                     * @throws {Error} If the payload is not a reader or valid buffer
+                     * @throws {$protobuf.util.ProtocolError} If required fields are missing
+                     */
+                    public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): temporal.api.sdk.v1.UserMetadata;
+
+                    /**
+                     * Decodes a UserMetadata message from the specified reader or buffer, length delimited.
+                     * @param reader Reader or buffer to decode from
+                     * @returns UserMetadata
+                     * @throws {Error} If the payload is not a reader or valid buffer
+                     * @throws {$protobuf.util.ProtocolError} If required fields are missing
+                     */
+                    public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): temporal.api.sdk.v1.UserMetadata;
+
+                    /**
+                     * Creates a UserMetadata message from a plain object. Also converts values to their respective internal types.
+                     * @param object Plain object
+                     * @returns UserMetadata
+                     */
+                    public static fromObject(object: { [k: string]: any }): temporal.api.sdk.v1.UserMetadata;
+
+                    /**
+                     * Creates a plain object from a UserMetadata message. Also converts values to other types if specified.
+                     * @param message UserMetadata
+                     * @param [options] Conversion options
+                     * @returns Plain object
+                     */
+                    public static toObject(message: temporal.api.sdk.v1.UserMetadata, options?: $protobuf.IConversionOptions): { [k: string]: any };
+
+                    /**
+                     * Converts this UserMetadata to JSON.
+                     * @returns JSON object
+                     */
+                    public toJSON(): { [k: string]: any };
+
+                    /**
+                     * Gets the default type url for UserMetadata
+                     * @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
+                     * @returns The default type url
+                     */
+                    public static getTypeUrl(typeUrlPrefix?: string): string;
+                }
+
                 /** Properties of a WorkflowTaskCompletedMetadata. */
                 interface IWorkflowTaskCompletedMetadata {
 
@@ -40615,6 +41024,12 @@ export namespace temporal {
 
                     /** Metadata provided at declaration or creation time. */
                     definition?: (temporal.api.sdk.v1.IWorkflowDefinition|null);
+
+                    /**
+                     * 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.
+                     */
+                    currentDetails?: (string|null);
                 }
 
                 /** The name of the query to retrieve this information is `__temporal_workflow_metadata`. */
@@ -40629,6 +41044,12 @@ export namespace temporal {
                     /** Metadata provided at declaration or creation time. */
                     public definition?: (temporal.api.sdk.v1.IWorkflowDefinition|null);
 
+                    /**
+                     * 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.
+                     */
+                    public currentDetails: string;
+
                     /**
                      * Creates a new WorkflowMetadata instance using the specified properties.
                      * @param [properties] Properties to set
@@ -40709,13 +41130,6 @@ export namespace temporal {
                      */
                     type?: (string|null);
 
-                    /**
-                     * 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.
-                     */
-                    description?: (string|null);
-
                     /** WorkflowDefinition queryDefinitions */
                     queryDefinitions?: (temporal.api.sdk.v1.IWorkflowInteractionDefinition[]|null);
 
@@ -40741,13 +41155,6 @@ export namespace temporal {
                      */
                     public type: string;
 
-                    /**
-                     * 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.
-                     */
-                    public description: string;
-
                     /** WorkflowDefinition queryDefinitions. */
                     public queryDefinitions: temporal.api.sdk.v1.IWorkflowInteractionDefinition[];
 
@@ -43022,6 +43429,20 @@ export namespace temporal {
                     /** Command commandType */
                     commandType?: (temporal.api.enums.v1.CommandType|null);
 
+                    /**
+                     * 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.
+                     */
+                    userMetadata?: (temporal.api.sdk.v1.IUserMetadata|null);
+
                     /** Command scheduleActivityTaskCommandAttributes */
                     scheduleActivityTaskCommandAttributes?: (temporal.api.command.v1.IScheduleActivityTaskCommandAttributes|null);
 
@@ -43086,6 +43507,20 @@ export namespace temporal {
                     /** Command commandType. */
                     public commandType: temporal.api.enums.v1.CommandType;
 
+                    /**
+                     * 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.
+                     */
+                    public userMetadata?: (temporal.api.sdk.v1.IUserMetadata|null);
+
                     /** Command scheduleActivityTaskCommandAttributes. */
                     public scheduleActivityTaskCommandAttributes?: (temporal.api.command.v1.IScheduleActivityTaskCommandAttributes|null);
 
@@ -43137,7 +43572,7 @@ export namespace temporal {
                     /** Command requestCancelNexusOperationCommandAttributes. */
                     public requestCancelNexusOperationCommandAttributes?: (temporal.api.command.v1.IRequestCancelNexusOperationCommandAttributes|null);
 
-                    /** Command attributes. */
+                    /** The command details. The type must match that in `command_type`. */
                     public attributes?: ("scheduleActivityTaskCommandAttributes"|"startTimerCommandAttributes"|"completeWorkflowExecutionCommandAttributes"|"failWorkflowExecutionCommandAttributes"|"requestCancelActivityTaskCommandAttributes"|"cancelTimerCommandAttributes"|"cancelWorkflowExecutionCommandAttributes"|"requestCancelExternalWorkflowExecutionCommandAttributes"|"recordMarkerCommandAttributes"|"continueAsNewWorkflowExecutionCommandAttributes"|"startChildWorkflowExecutionCommandAttributes"|"signalExternalWorkflowExecutionCommandAttributes"|"upsertWorkflowSearchAttributesCommandAttributes"|"protocolMessageCommandAttributes"|"modifyWorkflowPropertiesCommandAttributes"|"scheduleNexusOperationCommandAttributes"|"requestCancelNexusOperationCommandAttributes");
 
                     /**
@@ -49501,11 +49936,8 @@ export namespace temporal {
                      */
                     name?: (string|null);
 
-                    /**
-                     * 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.
-                     */
-                    description?: (temporal.api.common.v1.IPayload|null);
+                    /** EndpointSpec metadata */
+                    metadata?: (temporal.api.sdk.v1.IUserMetadata|null);
 
                     /** Target to route requests to. */
                     target?: (temporal.api.nexus.v1.IEndpointTarget|null);
@@ -49526,11 +49958,8 @@ export namespace temporal {
                      */
                     public name: string;
 
-                    /**
-                     * 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.
-                     */
-                    public description?: (temporal.api.common.v1.IPayload|null);
+                    /** EndpointSpec metadata. */
+                    public metadata?: (temporal.api.sdk.v1.IUserMetadata|null);
 
                     /** Target to route requests to. */
                     public target?: (temporal.api.nexus.v1.IEndpointTarget|null);