Namespace Temporalio.Api.Workflow.V1

Classes

CallbackInfo: CallbackInfo contains the state of an attached workflow callback.

CallbackInfo.Types: Container for nested types declared in the CallbackInfo message type.

CallbackInfo.Types.Trigger

CallbackInfo.Types.UpdateWorkflowExecutionCompleted: Trigger for when a workflow update is completed.

CallbackInfo.Types.WorkflowClosed: Trigger for when the workflow is closed.

DeploymentTransition: Holds information about ongoing transition of a workflow execution from one deployment to another. Deprecated. Use DeploymentVersionTransition.

DeploymentVersionTransition: Holds information about ongoing transition of a workflow execution from one worker deployment version to another. Experimental. Might change in the future.

MessageReflection: Holder for reflection information generated from temporal/api/workflow/v1/message.proto

NewWorkflowExecutionInfo: NewWorkflowExecutionInfo is a shared message that encapsulates all the required arguments to starting a workflow in different contexts.

NexusOperationCancellationInfo: NexusOperationCancellationInfo contains the state of a nexus operation cancellation.

OnConflictOptions: 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.

PendingActivityInfo

PendingActivityInfo.Types: Container for nested types declared in the PendingActivityInfo message type.

PendingActivityInfo.Types.PauseInfo

PendingActivityInfo.Types.PauseInfo.Types: Container for nested types declared in the PauseInfo message type.

PendingActivityInfo.Types.PauseInfo.Types.Manual

PendingActivityInfo.Types.PauseInfo.Types.Rule

PendingChildExecutionInfo

PendingNexusOperationInfo: PendingNexusOperationInfo contains the state of a pending Nexus operation.

PendingWorkflowTaskInfo

PostResetOperation: PostResetOperation represents an operation to be performed on the new workflow execution after a workflow reset.

PostResetOperation.Types: Container for nested types declared in the PostResetOperation message type.

PostResetOperation.Types.SignalWorkflow: SignalWorkflow represents sending a signal after a workflow reset. Keep the parameter in sync with temporal.api.workflowservice.v1.SignalWorkflowExecutionRequest.

PostResetOperation.Types.UpdateWorkflowOptions: UpdateWorkflowOptions represents updating workflow execution options after a workflow reset. Keep the parameters in sync with temporal.api.workflowservice.v1.UpdateWorkflowExecutionOptionsRequest.

RequestIdInfo: RequestIdInfo contains details of a request ID.

ResetPointInfo: ResetPointInfo records the workflow event id that is the first one processed by a given build id or binary checksum. A new reset point will be created if either build id or binary checksum changes (although in general only one or the other will be used at a time).

ResetPoints

VersioningOverride

Used to override the versioning behavior (and pinned deployment version, if applicable) of a specific workflow execution. If set, this override takes precedence over 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.

Pinned behavior overrides are automatically inherited by child workflows, workflow retries, continue-as-new workflows, and cron workflows.

VersioningOverride.Types: Container for nested types declared in the VersioningOverride message type.

VersioningOverride.Types.OneTimeOverride

Routes Workflow Tasks for this execution to target_deployment_version until a Workflow Task completes on that version, then clears the override.

This does not force the workflow's normal Versioning Behavior to become Pinned. After the Workflow Task completes on target_deployment_version, the workflow execution's normal Versioning Behavior and Deployment Version are taken from the worker's completion response.

Example: if an execution is one-time moved from version X to version Y, and version Z later becomes current:

if worker Y reports Pinned, the execution stays on Y;
if worker Y reports AutoUpgrade, the execution routes to Z on a future Workflow Task;
if worker Y reports Pinned and the workflow uses upgrade-on-continue-as-new, the current run stays on Y and the execution can route to Z after continue-as-new.

If no Workflow Task completes on target_deployment_version, this override remains pending.

VersioningOverride.Types.PinnedOverride

WorkflowExecutionConfig

WorkflowExecutionExtendedInfo: Holds all the extra information about workflow execution that is not part of Visibility.

WorkflowExecutionInfo: Hold basic information about a workflow execution. This structure is a part of visibility, and thus contain a limited subset of information.

WorkflowExecutionOptions

WorkflowExecutionPauseInfo: WorkflowExecutionPauseInfo contains the information about a workflow execution pause.

WorkflowExecutionVersioningInfo: Holds all the information about worker versioning for a particular workflow execution. Experimental. Versioning info is experimental and might change in the future.

Enums

CallbackInfo.Types.Trigger.VariantOneofCase: Enum of possible cases for the "variant" oneof.

PendingActivityInfo.AssignedBuildIdOneofCase: Enum of possible cases for the "assigned_build_id" oneof.

PendingActivityInfo.Types.PauseInfo.PausedByOneofCase: Enum of possible cases for the "paused_by" oneof.

PostResetOperation.VariantOneofCase: Enum of possible cases for the "variant" oneof.

VersioningOverride.OverrideOneofCase: Enum of possible cases for the "override" oneof.

VersioningOverride.Types.PinnedOverrideBehavior

Table of Contents

Namespace Temporalio.Api.Workflow.V1

Classes

Enums