package temporal.api.workflow.v1

Mouse Melon logoGet desktop application:
View/edit binary Protocol Buffers messages

message CallbackInfo

message.proto:458

CallbackInfo contains the state of an attached workflow callback.

Used in: workflowservice.v1.DescribeWorkflowExecutionResponse

message CallbackInfo.Trigger

message.proto:467

Used in: CallbackInfo

message CallbackInfo.UpdateWorkflowExecutionCompleted

message.proto:463

Trigger for when a workflow update is completed.

Used in: Trigger

message CallbackInfo.WorkflowClosed

message.proto:460

Trigger for when the workflow is closed.

Used in: Trigger

(message has no fields)

message DeploymentTransition

message.proto:249

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

Used in: WorkflowExecutionVersioningInfo

message DeploymentVersionTransition

message.proto:260

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

Used in: WorkflowExecutionVersioningInfo

message NewWorkflowExecutionInfo

message.proto:425

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

Used in: schedule.v1.ScheduleAction

message NexusOperationCancellationInfo

message.proto:560

NexusOperationCancellationInfo contains the state of a nexus operation cancellation.

Used in: PendingNexusOperationInfo

message OnConflictOptions

message.proto:663

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.

Used in: workflowservice.v1.StartWorkflowExecutionRequest

message PendingActivityInfo

message.proto:280

Used in: workflowservice.v1.DescribeWorkflowExecutionResponse

message PendingActivityInfo.PauseInfo

message.proto:341

Used in: PendingActivityInfo

message PendingActivityInfo.PauseInfo.Manual

message.proto:345

Used in: PauseInfo

message PendingActivityInfo.PauseInfo.Rule

message.proto:352

Used in: PauseInfo

message PendingChildExecutionInfo

message.proto:377

Used in: workflowservice.v1.DescribeWorkflowExecutionResponse

message PendingNexusOperationInfo

message.proto:498

PendingNexusOperationInfo contains the state of a pending Nexus operation.

Used in: workflowservice.v1.DescribeWorkflowExecutionResponse

message PendingWorkflowTaskInfo

message.proto:386

Used in: workflowservice.v1.DescribeWorkflowExecutionResponse

message PostResetOperation

message.proto:686

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

Used in: batch.v1.BatchOperationReset, workflowservice.v1.ResetWorkflowExecutionRequest

message PostResetOperation.SignalWorkflow

message.proto:689

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

Used in: PostResetOperation

message PostResetOperation.UpdateWorkflowOptions

message.proto:702

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

Used in: PostResetOperation

message RequestIdInfo

message.proto:673

RequestIdInfo contains details of a request ID.

Used in: WorkflowExecutionExtendedInfo

message ResetPointInfo

message.proto:405

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).

Used in: ResetPoints

message ResetPoints

message.proto:398

Used in: history.v1.WorkflowExecutionStartedEventAttributes, WorkflowExecutionInfo

message VersioningOverride

message.proto:609

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.

Used in: history.v1.WorkflowExecutionOptionsUpdatedEventAttributes, history.v1.WorkflowExecutionStartedEventAttributes, NewWorkflowExecutionInfo, WorkflowExecutionOptions, WorkflowExecutionVersioningInfo, workflowservice.v1.SignalWithStartWorkflowExecutionRequest, workflowservice.v1.StartWorkflowExecutionRequest

message VersioningOverride.PinnedOverride

message.proto:634

Used in: VersioningOverride

enum VersioningOverride.PinnedOverrideBehavior

message.proto:650

Used in: PinnedOverride

message WorkflowExecutionConfig

message.proto:271

Used in: workflowservice.v1.DescribeWorkflowExecutionResponse

message WorkflowExecutionExtendedInfo

message.proto:109

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

Used in: workflowservice.v1.DescribeWorkflowExecutionResponse

message WorkflowExecutionInfo

message.proto:30

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

Used in: workflowservice.v1.DescribeWorkflowExecutionResponse, workflowservice.v1.ListArchivedWorkflowExecutionsResponse, workflowservice.v1.ListClosedWorkflowExecutionsResponse, workflowservice.v1.ListOpenWorkflowExecutionsResponse, workflowservice.v1.ListWorkflowExecutionsResponse, workflowservice.v1.ScanWorkflowExecutionsResponse

message WorkflowExecutionOptions

message.proto:581

Used in: batch.v1.BatchOperationUpdateWorkflowExecutionOptions, PostResetOperation.UpdateWorkflowOptions, workflowservice.v1.UpdateWorkflowExecutionOptionsRequest, workflowservice.v1.UpdateWorkflowExecutionOptionsResponse

message WorkflowExecutionPauseInfo

message.proto:717

WorkflowExecutionPauseInfo contains the information about a workflow execution pause.

Used in: WorkflowExecutionExtendedInfo

message WorkflowExecutionVersioningInfo

message.proto:141

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

Used in: WorkflowExecutionInfo