Skip to main content

Class: CompatibleBuildIdRedirectRule

These rules apply to tasks assigned to a particular Build ID (source_build_id) to redirect them to another compatible Build ID (target_build_id).

It is user's responsibility to ensure that the target Build ID is compatible with the source Build ID (e.g. by using the Patching API).

Most deployments are not expected to need these rules, however following situations can greatly benefit from redirects:

  • Need to move long-running Workflow Executions from an old Build ID to a newer one.
  • Need to hotfix some broken or stuck Workflow Executions.

In steady state, redirect rules are beneficial when dealing with old Executions ran on now-decommissioned Build IDs:

  • To redirecting the Workflow Queries to the current (compatible) Build ID.
  • To be able to Reset an old Execution so it can run on the current (compatible) Build ID.

Redirect rules can be chained.

Properties​

sourceBuildId​

sourceBuildId: string

CompatibleBuildIdRedirectRule sourceBuildId.

targetBuildId​

targetBuildId: string

Target Build ID must be compatible with the Source Build ID; that is it must be able to process event histories made by the Source Build ID by using Patching or other means.

Methods​

toJSON()​

toJSON(): object

Converts this CompatibleBuildIdRedirectRule to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): CompatibleBuildIdRedirectRule & $Properties

Creates a new CompatibleBuildIdRedirectRule instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

CompatibleBuildIdRedirectRule & $Properties

CompatibleBuildIdRedirectRule instance

Call Signature​

static create(properties?): CompatibleBuildIdRedirectRule

Creates a new CompatibleBuildIdRedirectRule instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

CompatibleBuildIdRedirectRule

CompatibleBuildIdRedirectRule instance

decode()​

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

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

CompatibleBuildIdRedirectRule & $Properties

CompatibleBuildIdRedirectRule

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): CompatibleBuildIdRedirectRule & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

CompatibleBuildIdRedirectRule & $Properties

CompatibleBuildIdRedirectRule

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 CompatibleBuildIdRedirectRule message. Does not implicitly temporal.api.taskqueue.v1.CompatibleBuildIdRedirectRule.verify|verify messages.

Parameters​

message​

$Properties

CompatibleBuildIdRedirectRule message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

CompatibleBuildIdRedirectRule message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): CompatibleBuildIdRedirectRule

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

Parameters​

object​

Plain object

Returns​

CompatibleBuildIdRedirectRule

CompatibleBuildIdRedirectRule

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

CompatibleBuildIdRedirectRule

CompatibleBuildIdRedirectRule

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object