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.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.Types
Container for nested types declared in the PendingActivityInfo message type.
- PendingActivityInfo.Types.PauseInfo.Types
Container for nested types declared in the PauseInfo message type.
- PendingNexusOperationInfo
PendingNexusOperationInfo contains the state of a pending Nexus operation.
- 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).
- TimeSkippingConfig
Configuration for time skipping during a workflow execution. When enabled, virtual time advances automatically whenever there is no in-flight work. In-flight work includes activities, child workflows, Nexus operations, signal/cancel external workflow operations, and possibly other features added in the future. User timers are not classified as in-flight work and will be skipped over. When time advances, it skips to the earlier of the next user timer or the configured bound, if either exists.
Propagation behavior of time skipping: The enabled flag, bound fields, and accumulated skipped duration are propagated to related executions as follows: (1) Child workflows and continue-as-new: both the configuration and the accumulated skipped duration are inherited from the current execution. The configured bound is shared between the inherited skipped duration and any additional duration skipped by the new run. (2) Retry and cron: the configuration and accumulated skipped duration are inherited as recorded when the current workflow started; the accumulated skipped duration of the current run is not propagated. (3) Reset: the new run retains the time-skipping configuration of the current execution. Because reset replays all events up to the reset point and re-applies any UpdateWorkflowExecutionOptions changes made after that point, the resulting run ends up with the same final time-skipping configuration as the previous run.
- 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.VersioningInfofor more information.To remove the override, call
UpdateWorkflowExecutionOptionswith a nullVersioningOverride, and use theupdate_maskto 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.
- 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.
- 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.
- TimeSkippingConfig.BoundOneofCase
Enum of possible cases for the "bound" oneof.
- VersioningOverride.OverrideOneofCase
Enum of possible cases for the "override" oneof.