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

Properties

autoUpgrade?

optional autoUpgrade?: boolean | null

Override the workflow to have AutoUpgrade behavior.

---

behavior

behavior: VersioningBehavior

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

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

Methods

toJSON()

toJSON(): object

Converts this VersioningOverride to JSON.

Returns

object

JSON object

---

create()

Call Signature

static create(properties?): VersioningOverride & $Shape

Creates a new VersioningOverride instance using the specified properties.

Parameters

properties?

$Shape

Properties to set

Returns

VersioningOverride & $Shape

VersioningOverride instance

Call Signature

static create(properties?): VersioningOverride

Creates a new VersioningOverride instance using the specified properties.

Parameters

properties?

$Properties

Properties to set

Returns

VersioningOverride

VersioningOverride instance

---

decode()

static decode(reader, length?): VersioningOverride & $Shape

Decodes a VersioningOverride message from the specified reader or buffer.

Parameters

reader

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

length?

number

Message length if known beforehand

Returns

VersioningOverride & $Shape

VersioningOverride

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited()

static decodeDelimited(reader): VersioningOverride & $Shape

Decodes a VersioningOverride message from the specified reader or buffer, length delimited.

Parameters

reader

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns

VersioningOverride & $Shape

VersioningOverride

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

encode()

static encode(message, writer?): Writer

Encodes the specified VersioningOverride message. Does not implicitly temporal.api.workflow.v1.VersioningOverride.verify|verify messages.

Parameters

message

$Properties

VersioningOverride message or plain object to encode

writer?

Writer

Writer to encode to

Returns

Writer

Writer

---

encodeDelimited()

static encodeDelimited(message, writer?): Writer

Encodes the specified VersioningOverride message, length delimited. Does not implicitly temporal.api.workflow.v1.VersioningOverride.verify|verify messages.

Parameters

message

$Properties

VersioningOverride message or plain object to encode

writer?

Writer

Writer to encode to

Returns

Writer

Writer

---

fromObject()

static fromObject(object): VersioningOverride

Creates a VersioningOverride message from a plain object. Also converts values to their respective internal types.

Parameters

object

Plain object

Returns

VersioningOverride

VersioningOverride

---

toObject()

static toObject(message, options?): object

Creates a plain object from a VersioningOverride message. Also converts values to other types if specified.

Parameters

message

VersioningOverride

VersioningOverride

options?

IConversionOptions

Conversion options

Returns

object

Plain object