Skip to main content

Interface: $Properties

Properties of a VersioningOverride.

Extended by​

Properties​

autoUpgrade?​

optional autoUpgrade?: boolean | null

Override the workflow to have AutoUpgrade behavior.


behavior?​

optional behavior?: VersioningBehavior | null

Required. Deprecated. Use override.


deployment?​

optional deployment?: $Properties | null

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?: $Properties | null

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


override?​

optional override?: "pinned" | "autoUpgrade" | "oneTime"

Indicates whether to override the workflow to be AutoUpgrade or Pinned.


pinned?​

optional pinned?: $Properties | null

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?: string | null

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.