Class: UpdateWorkerBuildIdCompatibilityRequest

[cleanup-wv-pre-release]

Properties

addNewBuildIdInNewDefaultSet?

optional addNewBuildIdInNewDefaultSet?: string | null

A new build id. This operation will create a new set which will be the new overall default version for the queue, with this id as its only member. This new set is incompatible with all previous sets/versions.

(-- api-linter: core::0140::prepositions=disabled aip.dev/not-precedent: In makes perfect sense here. --)

---

addNewCompatibleBuildId?

optional addNewCompatibleBuildId?: $Properties | null

Adds a new id to an existing compatible set, see sub-message definition for more.

---

mergeSets?

optional mergeSets?: $Properties | null

Merge two existing sets together, thus declaring all build IDs in both sets compatible with one another. The primary set's default will become the default for the merged set. This is useful if you've accidentally declared a new ID as incompatible you meant to declare as compatible. The unusual case of incomplete replication during failover could also result in a split set, which this operation can repair.

---

namespace

namespace: string

UpdateWorkerBuildIdCompatibilityRequest namespace.

---

operation?

optional operation?: "addNewBuildIdInNewDefaultSet" | "addNewCompatibleBuildId" | "promoteSetByBuildId" | "promoteBuildIdWithinSet" | "mergeSets"

UpdateWorkerBuildIdCompatibilityRequest operation.

---

promoteBuildIdWithinSet?

optional promoteBuildIdWithinSet?: string | null

Promote an existing build id within some set to be the current default for that set.

(-- api-linter: core::0140::prepositions=disabled aip.dev/not-precedent: Within makes perfect sense here. --)

---

promoteSetByBuildId?

optional promoteSetByBuildId?: string | null

Promote an existing set to be the current default (if it isn't already) by targeting an existing build id within it. This field's value is the extant build id.

(-- api-linter: core::0140::prepositions=disabled aip.dev/not-precedent: Names are hard. --)

---

taskQueue

taskQueue: string

Must be set, the task queue to apply changes to. Because all workers on a given task queue must have the same set of workflow & activity implementations, there is no reason to specify a task queue type here.

Methods

toJSON()

toJSON(): object

Converts this UpdateWorkerBuildIdCompatibilityRequest to JSON.

Returns

object

JSON object

---

create()

Call Signature

static create(properties?): UpdateWorkerBuildIdCompatibilityRequest & $Shape

Creates a new UpdateWorkerBuildIdCompatibilityRequest instance using the specified properties.

Parameters

properties?

$Shape

Properties to set

Returns

UpdateWorkerBuildIdCompatibilityRequest & $Shape

UpdateWorkerBuildIdCompatibilityRequest instance

Call Signature

static create(properties?): UpdateWorkerBuildIdCompatibilityRequest

Creates a new UpdateWorkerBuildIdCompatibilityRequest instance using the specified properties.

Parameters

properties?

$Properties

Properties to set

Returns

UpdateWorkerBuildIdCompatibilityRequest

UpdateWorkerBuildIdCompatibilityRequest instance

---

decode()

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

Decodes an UpdateWorkerBuildIdCompatibilityRequest 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

UpdateWorkerBuildIdCompatibilityRequest & $Shape

UpdateWorkerBuildIdCompatibilityRequest

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited()

static decodeDelimited(reader): UpdateWorkerBuildIdCompatibilityRequest & $Shape

Decodes an UpdateWorkerBuildIdCompatibilityRequest message from the specified reader or buffer, length delimited.

Parameters

reader

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns

UpdateWorkerBuildIdCompatibilityRequest & $Shape

UpdateWorkerBuildIdCompatibilityRequest

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

Parameters

message

$Properties

UpdateWorkerBuildIdCompatibilityRequest message or plain object to encode

writer?

Writer

Writer to encode to

Returns

Writer

Writer

---

encodeDelimited()

static encodeDelimited(message, writer?): Writer

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

Parameters

message

$Properties

UpdateWorkerBuildIdCompatibilityRequest message or plain object to encode

writer?

Writer

Writer to encode to

Returns

Writer

Writer

---

fromObject()

static fromObject(object): UpdateWorkerBuildIdCompatibilityRequest

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

Parameters

object

Plain object

Returns

UpdateWorkerBuildIdCompatibilityRequest

UpdateWorkerBuildIdCompatibilityRequest

---

toObject()

static toObject(message, options?): object

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

Parameters

message

UpdateWorkerBuildIdCompatibilityRequest

UpdateWorkerBuildIdCompatibilityRequest

options?

IConversionOptions

Conversion options

Returns

object

Plain object