Class: CompatibleBuildIdRedirectRule

taskqueue.v1.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.

Implements

• ICompatibleBuildIdRedirectRule

Constructors

constructor

• new CompatibleBuildIdRedirectRule(properties?): CompatibleBuildIdRedirectRule

Constructs a new CompatibleBuildIdRedirectRule.

Parameters

Name	Type	Description
properties?	ICompatibleBuildIdRedirectRule	Properties to set

Returns

CompatibleBuildIdRedirectRule

Properties

sourceBuildId

• sourceBuildId: string

CompatibleBuildIdRedirectRule sourceBuildId.

Implementation of

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

Implementation of

ICompatibleBuildIdRedirectRule.targetBuildId

Methods

toJSON

▸ toJSON(): Object

Converts this CompatibleBuildIdRedirectRule to JSON.

Returns

Object

JSON object

---

create

▸ create(properties?): CompatibleBuildIdRedirectRule

Creates a new CompatibleBuildIdRedirectRule instance using the specified properties.

Parameters

Name	Type	Description
properties?	ICompatibleBuildIdRedirectRule	Properties to set

Returns

CompatibleBuildIdRedirectRule

CompatibleBuildIdRedirectRule instance

---

decode

▸ decode(reader, length?): CompatibleBuildIdRedirectRule

Decodes a CompatibleBuildIdRedirectRule message from the specified reader or buffer.

Parameters

Name	Type	Description
reader	Uint8Array | Reader	Reader or buffer to decode from
length?	number	Message length if known beforehand

Returns

CompatibleBuildIdRedirectRule

CompatibleBuildIdRedirectRule

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited

▸ decodeDelimited(reader): CompatibleBuildIdRedirectRule

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

Parameters

Name	Type	Description
reader	Uint8Array | Reader	Reader or buffer to decode from

Returns

CompatibleBuildIdRedirectRule

CompatibleBuildIdRedirectRule

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

encode

▸ encode(message, writer?): Writer

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

Parameters

Name	Type	Description
message	ICompatibleBuildIdRedirectRule	CompatibleBuildIdRedirectRule message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

encodeDelimited

▸ encodeDelimited(message, writer?): Writer

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

Parameters

Name	Type	Description
message	ICompatibleBuildIdRedirectRule	CompatibleBuildIdRedirectRule message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

fromObject

▸ fromObject(object): CompatibleBuildIdRedirectRule

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

Parameters

Name	Type	Description
object	Object	Plain object

Returns

CompatibleBuildIdRedirectRule

CompatibleBuildIdRedirectRule

---

getTypeUrl

▸ getTypeUrl(typeUrlPrefix?): string

Gets the default type url for CompatibleBuildIdRedirectRule

Parameters

Name	Type	Description
typeUrlPrefix?	string	your custom typeUrlPrefix(default "type.googleapis.com")

Returns

string

The default type url

---

toObject

▸ toObject(message, options?): Object

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

Parameters

Name	Type	Description
message	CompatibleBuildIdRedirectRule	CompatibleBuildIdRedirectRule
options?	IConversionOptions	Conversion options

Returns

Object

Plain object