@temporalio/core-bridge 1.11.6 → 1.11.8

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

@@ -38,10 +38,14 @@ import "google/protobuf/timestamp.proto";
 import "temporal/api/enums/v1/common.proto";
 import "temporal/api/enums/v1/workflow.proto";
 import "temporal/api/common/v1/message.proto";
+import "temporal/api/deployment/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";
 
+
+// Hold basic information about a workflow execution.
+// This structure is a part of visibility, and thus contain a limited subset of information.
 message WorkflowExecutionInfo {
     temporal.api.common.v1.WorkflowExecution execution = 1;
     temporal.api.common.v1.WorkflowType type = 2;
@@ -59,6 +63,7 @@ message WorkflowExecutionInfo {
     int64 state_transition_count = 14;
     int64 history_size_bytes = 15;
     // If set, the most recent worker version stamp that appeared in a workflow task completion
+    // Deprecated. This field should be cleaned up when versioning-2 API is removed. [cleanup-experimental-wv]
     temporal.api.common.v1.WorkerVersionStamp most_recent_worker_version_stamp = 16;
     // Workflow execution duration is defined as difference between close time and execution time.
     // This field is only populated if the workflow is closed.
@@ -87,9 +92,11 @@ message WorkflowExecutionInfo {
     // again, the assigned build ID may change according to the latest versioning rules.
     // Assigned build ID can also change in the middle of a execution if Compatible Redirect Rules are applied to
     // this execution.
+    // Deprecated. This field should be cleaned up when versioning-2 API is removed. [cleanup-experimental-wv]
     string assigned_build_id = 19;
     // Build ID inherited from a previous/parent execution. If present, assigned_build_id will be set to this, instead
     // of using the assignment rules.
+    // Deprecated. This field should be cleaned up when versioning-2 API is removed. [cleanup-experimental-wv]
     string inherited_build_id = 20;
     // The first run ID in the execution chain.
     // Executions created via the following operations are considered to be in the same chain
@@ -98,6 +105,136 @@ message WorkflowExecutionInfo {
     // - Workflow Reset
     // - Cron Schedule
     string first_run_id = 21;
+
+    // Absent value means the workflow execution is not versioned. When present, the execution might
+    // be versioned or unversioned, depending on `versioning_info.behavior` and `versioning_info.versioning_override`.
+    // Experimental. Versioning info is experimental and might change in the future.
+    WorkflowExecutionVersioningInfo versioning_info = 22;
+
+    // The name of Worker Deployment that completed the most recent workflow task.
+    // Experimental. Worker Deployments are experimental and might change in the future.
+    string worker_deployment_name = 23;
+
+    // Priority metadata
+    temporal.api.common.v1.Priority priority = 24;
+}
+
+// Holds all the extra information about workflow execution that is not part of Visibility.
+message WorkflowExecutionExtendedInfo {
+    // Workflow execution expiration time is defined as workflow start time plus expiration timeout.
+    // Workflow start time may change after workflow reset.
+    google.protobuf.Timestamp execution_expiration_time = 1;
+
+    // Workflow run expiration time is defined as current workflow run start time plus workflow run timeout.
+    google.protobuf.Timestamp run_expiration_time = 2;
+
+    // indicates if the workflow received a cancel request
+    bool cancel_requested = 3;
+
+    // Last workflow reset time. Nil if the workflow was never reset.
+    google.protobuf.Timestamp last_reset_time = 4;
+
+    // Original workflow start time.
+    google.protobuf.Timestamp original_start_time = 5;
+}
+
+// Holds all the information about worker versioning for a particular workflow execution.
+// Experimental. Versioning info is experimental and might change in the future.
+message WorkflowExecutionVersioningInfo {
+    // Versioning behavior determines how the server should treat this execution when workers are
+    // upgraded. When present it means this workflow execution is versioned; UNSPECIFIED means
+    // unversioned. See the comments in `VersioningBehavior` enum for more info about different
+    // behaviors.
+    // This field is first set after an execution completes its first workflow task on a versioned
+    // worker, and set again on completion of every subsequent workflow task.
+    // For child workflows of Pinned parents, this will be set to Pinned (along with `version`) when
+    // the the child starts so that child's first workflow task goes to the same Version as the
+    // parent. After the first workflow task, it depends on the child workflow itself if it wants
+    // to stay pinned or become unpinned (according to Versioning Behavior set in the worker).
+    // Note that `behavior` is overridden by `versioning_override` if the latter is present.
+    temporal.api.enums.v1.VersioningBehavior behavior = 1;
+    // The worker deployment that completed the last workflow task of this workflow execution. Must
+    // be present if `behavior` is set. Absent value means no workflow task is completed, or the
+    // last workflow task was completed by an unversioned worker. Unversioned workers may still send
+    // a deployment value which will be stored here, so the right way to check if an execution is
+    // versioned if an execution is versioned or not is via the `behavior` field.
+    // Note that `deployment` is overridden by `versioning_override` if the latter is present.
+    // Deprecated. Use `version`.
+    temporal.api.deployment.v1.Deployment deployment = 2 [deprecated = true];
+    // The Worker Deployment Version that completed the last workflow task of this workflow
+    // execution, in the form "<deployment_name>.<build_id>".
+    // Must be present if and only if `behavior` is set. An absent value means no workflow task is
+    // completed, or the workflow is unversioned.
+    // For child workflows of Pinned parents, this will be set to parent's Pinned Version when the
+    // the child starts so that child's first workflow task goes to the same Version as the parent.
+    // Note that if `versioning_override.behavior` is PINNED then `versioning_override.pinned_version`
+    // will override this value.
+    string version = 5;
+    // Present if user has set an execution-specific versioning override. This override takes
+    // precedence over SDK-sent `behavior` (and `version` when override is PINNED). An
+    // override can be set when starting a new execution, as well as afterwards by calling the
+    // `UpdateWorkflowExecutionOptions` API.
+    // Pinned overrides are automatically inherited by child workflows.
+    VersioningOverride versioning_override = 3;
+    // When present, indicates the workflow is transitioning to a different deployment. Can
+    // indicate one of the following transitions: unversioned -> versioned, versioned -> versioned
+    // on a different deployment, or versioned -> unversioned.
+    // Not applicable to workflows with PINNED behavior.
+    // When a workflow with AUTO_UPGRADE behavior creates a new workflow task, it will automatically
+    // start a transition to the task queue's current deployment if the task queue's current
+    // deployment is different from the workflow's deployment.
+    // If the AUTO_UPGRADE workflow is stuck due to backlogged activity or workflow tasks, those
+    // tasks will be redirected to the task queue's current deployment. As soon as a poller from
+    // that deployment is available to receive the task, the workflow will automatically start a
+    // transition to that deployment and continue execution there.
+    // A deployment transition can only exist while there is a pending or started workflow task.
+    // Once the pending workflow task completes on the transition's target deployment, the
+    // transition completes and the workflow's `deployment` and `behavior` fields are updated per
+    // the worker's task completion response.
+    // Pending activities will not start new attempts during a transition. Once the transition is
+    // completed, pending activities will start their next attempt on the new deployment.
+    // Deprecated. Use version_transition.
+    DeploymentTransition deployment_transition = 4 [deprecated = true];
+    // When present, indicates the workflow is transitioning to a different deployment version
+    // (which may belong to the same deployment name or another). Can indicate one of the following
+    // transitions: unversioned -> versioned, versioned -> versioned
+    // on a different deployment version, or versioned -> unversioned.
+    // Not applicable to workflows with PINNED behavior.
+    // When a workflow with AUTO_UPGRADE behavior creates a new workflow task, it will automatically
+    // start a transition to the task queue's current version if the task queue's current version is
+    // different from the workflow's current deployment version.
+    // If the AUTO_UPGRADE workflow is stuck due to backlogged activity or workflow tasks, those
+    // tasks will be redirected to the task queue's current version. As soon as a poller from
+    // that deployment version is available to receive the task, the workflow will automatically
+    // start a transition to that version and continue execution there.
+    // A version transition can only exist while there is a pending or started workflow task.
+    // Once the pending workflow task completes on the transition's target version, the
+    // transition completes and the workflow's `behavior`, and `version` fields are updated per the
+    // worker's task completion response.
+    // Pending activities will not start new attempts during a transition. Once the transition is
+    // completed, pending activities will start their next attempt on the new version.
+    DeploymentVersionTransition version_transition = 6;
+}
+
+// Holds information about ongoing transition of a workflow execution from one deployment to another.
+// Deprecated. Use DeploymentVersionTransition.
+message DeploymentTransition {
+    // The target deployment of the transition. Null means a so-far-versioned workflow is
+    // transitioning to unversioned workers.
+    temporal.api.deployment.v1.Deployment deployment = 1;
+
+    // Later: safe transition info
+}
+
+// Holds information about ongoing transition of a workflow execution from one worker
+// deployment version to another.
+// Experimental. Might change in the future.
+message DeploymentVersionTransition {
+    // Required. The target Version of the transition. May be `__unversioned__` which means a
+    // so-far-versioned workflow is transitioning to unversioned workers.
+    string version = 1;
+
+    // Later: safe transition info
 }
 
 message WorkflowExecutionConfig {
@@ -125,6 +262,7 @@ message PendingActivityInfo {
     // Absence of `assigned_build_id` generally means this task is on an "unversioned" task queue.
     // In rare cases, it can also mean that the task queue is versioned but we failed to write activity's
     // independently-assigned build ID to the database. This case heals automatically once the task is dispatched.
+    // Deprecated. This field should be cleaned up when versioning-2 API is removed. [cleanup-experimental-wv]
     oneof assigned_build_id {
         // When present, it means this activity is assigned to the build ID of its workflow.
         google.protobuf.Empty use_workflow_build_id = 13;
@@ -135,6 +273,7 @@ message PendingActivityInfo {
         string last_independently_assigned_build_id = 14;
     }
     // The version stamp of the worker to whom this activity was most recently dispatched
+    // Deprecated. This field should be cleaned up when versioning-2 API is removed. [cleanup-experimental-wv]
     temporal.api.common.v1.WorkerVersionStamp last_worker_version_stamp = 15;
 
     // The time activity will wait until the next retry.
@@ -152,6 +291,16 @@ message PendingActivityInfo {
 
     // Indicates if activity is paused.
     bool paused = 19;
+
+    // The deployment this activity was dispatched to most recently. Present only if the activity
+    // was dispatched to a versioned worker.
+    // Deprecated. Use `last_worker_deployment_version`.
+    temporal.api.deployment.v1.Deployment last_deployment = 20 [deprecated = true];
+    // The Worker Deployment Version this activity was dispatched to most recently.
+    string last_worker_deployment_version = 21;
+
+    // Priority metadata
+    temporal.api.common.v1.Priority priority = 22;
 }
 
 message PendingChildExecutionInfo {
@@ -227,6 +376,11 @@ message NewWorkflowExecutionInfo {
     // 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;
+    // If set, takes precedence over the Versioning Behavior sent by the SDK on Workflow Task completion.
+    // To unset the override after the workflow is running, use UpdateWorkflowExecutionOptions.
+    VersioningOverride versioning_override = 15;
+    // Priority metadata
+    temporal.api.common.v1.Priority priority = 16;
 }
 
 // CallbackInfo contains the state of an attached workflow callback.
@@ -258,6 +412,9 @@ message CallbackInfo {
     temporal.api.failure.v1.Failure last_attempt_failure = 7;
     // The time when the next attempt is scheduled.
     google.protobuf.Timestamp next_attempt_schedule_time = 8;
+
+    // If the state is BLOCKED, blocked reason provides additional information.
+    string blocked_reason = 9;
 }
 
 // PendingNexusOperationInfo contains the state of a pending Nexus operation.
@@ -271,6 +428,8 @@ message PendingNexusOperationInfo {
     string operation = 3;
 
     // Operation ID. Only set for asynchronous operations after a successful StartOperation call.
+    //
+    // Deprecated: Renamed to operation_token.
     string operation_id = 4;
 
     // Schedule-to-close timeout for this operation.
@@ -300,6 +459,12 @@ message PendingNexusOperationInfo {
     // The event ID of the NexusOperationScheduled event. Can be used to correlate an operation in the
     // DescribeWorkflowExecution response with workflow history.
     int64 scheduled_event_id = 13;
+
+    // If the state is BLOCKED, blocked reason provides additional information.
+    string blocked_reason = 14;
+
+    // Operation token. Only set for asynchronous operations after a successful StartOperation call.
+    string operation_token = 15;
 }
 
 // NexusOperationCancellationInfo contains the state of a nexus operation cancellation.
@@ -319,4 +484,45 @@ message NexusOperationCancellationInfo {
     temporal.api.failure.v1.Failure last_attempt_failure = 5;
     // The time when the next attempt is scheduled.
     google.protobuf.Timestamp next_attempt_schedule_time = 6;
+
+    // If the state is BLOCKED, blocked reason provides additional information.
+    string blocked_reason = 7;
+}
+
+message WorkflowExecutionOptions {
+    // If set, takes precedence over the Versioning Behavior sent by the SDK on Workflow Task completion.
+    VersioningOverride versioning_override = 1;
+}
+
+// Used to override the versioning behavior (and pinned deployment version, if applicable) of a
+// specific workflow execution. If set, takes precedence over the worker-sent values. See
+// `WorkflowExecutionInfo.VersioningInfo` for more information. To remove the override, call
+// `UpdateWorkflowExecutionOptions` with a null `VersioningOverride`, and use the `update_mask`
+// to indicate that it should be mutated.
+message VersioningOverride {
+    // Required.
+    temporal.api.enums.v1.VersioningBehavior behavior = 1;
+
+    // Required if behavior is `PINNED`. Must be null if behavior is `AUTO_UPGRADE`.
+    // Identifies the worker deployment to pin the workflow to.
+    // Deprecated. Use `pinned_version`.
+    temporal.api.deployment.v1.Deployment deployment = 2 [deprecated = true];
+
+    // Required if behavior is `PINNED`. Must be absent if behavior is not `PINNED`.
+    // Identifies the worker deployment version to pin the workflow to, in the format
+    // "<deployment_name>.<build_id>".
+    string pinned_version = 9;
+}
+
+// When StartWorkflowExecution uses the conflict policy WORKFLOW_ID_CONFLICT_POLICY_USE_EXISTING and
+// there is already an existing running workflow, OnConflictOptions defines actions to be taken on
+// the existing running workflow. In this case, it will create a WorkflowExecutionOptionsUpdatedEvent
+// history event in the running workflow with the changes requested in this object.
+message OnConflictOptions {
+    // Attaches the request ID to the running workflow.
+    bool attach_request_id = 1;
+    // Attaches the completion callbacks to the running workflow.
+    bool attach_completion_callbacks = 2;
+    // Attaches the links to the WorkflowExecutionOptionsUpdatedEvent history event.
+    bool attach_links = 3;
 }