Skip to main content

Class: OneTimeOverride

Routes Workflow Tasks for this execution to target_deployment_version until a Workflow Task completes on that version, then clears the override.

This does not force the workflow's normal Versioning Behavior to become Pinned. After the Workflow Task completes on target_deployment_version, the workflow execution's normal Versioning Behavior and Deployment Version are taken from the worker's completion response.

Example: if an execution is one-time moved from version X to version Y, and version Z later becomes current:

  • if worker Y reports Pinned, the execution stays on Y;
  • if worker Y reports AutoUpgrade, the execution routes to Z on a future Workflow Task;
  • if worker Y reports Pinned and the workflow uses upgrade-on-continue-as-new, the current run stays on Y and the execution can route to Z after continue-as-new.

If no Workflow Task completes on target_deployment_version, this override remains pending.

Properties​

targetDeploymentVersion?​

optional targetDeploymentVersion?: $Properties | null

Required. Worker Deployment Version to receive the one-time Workflow Task.

Methods​

toJSON()​

toJSON(): object

Converts this OneTimeOverride to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): OneTimeOverride & $Properties

Creates a new OneTimeOverride instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

OneTimeOverride & $Properties

OneTimeOverride instance

Call Signature​

static create(properties?): OneTimeOverride

Creates a new OneTimeOverride instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

OneTimeOverride

OneTimeOverride instance

decode()​

static decode(reader, length?): OneTimeOverride & $Properties

Decodes a OneTimeOverride 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​

OneTimeOverride & $Properties

OneTimeOverride

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): OneTimeOverride & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

OneTimeOverride & $Properties

OneTimeOverride

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 OneTimeOverride message. Does not implicitly temporal.api.workflow.v1.VersioningOverride.OneTimeOverride.verify|verify messages.

Parameters​

message​

$Properties

OneTimeOverride message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

OneTimeOverride message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): OneTimeOverride

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

Parameters​

object​

Plain object

Returns​

OneTimeOverride

OneTimeOverride

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

OneTimeOverride

OneTimeOverride

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object