Skip to main content

Interface: IVersioningOverride

workflow.v1.IVersioningOverride

Properties of a VersioningOverride.

Implemented by

Properties

autoUpgrade

Optional autoUpgrade: null | boolean

Override the workflow to have AutoUpgrade behavior.


behavior

Optional behavior: null | VersioningBehavior

Required. Deprecated. Use override.


deployment

Optional deployment: null | IDeployment

Required if behavior is PINNED. Must be null if behavior is AUTO_UPGRADE. Identifies the worker deployment to pin the workflow to. Deprecated. Use override.pinned.version.


oneTime

Optional oneTime: null | IOneTimeOverride

Override Workflow Task routing to a specific Worker Deployment Version until one Workflow Task completes there. After completion, the workflow execution's Versioning Behavior and Deployment Version come from the worker's completion response. (-- api-linter: core::0142::time-field-type=disabled aip.dev/not-precedent: one_time describes one-time routing semantics, not a timestamp or duration. --)


pinned

Optional pinned: null | IPinnedOverride

Override the workflow to have Pinned behavior. This is a sticky override: Workflow Tasks continue to route according to this override until it is explicitly removed.


pinnedVersion

Optional pinnedVersion: null | string

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>". Deprecated. Use override.pinned.version.