Class: AddNewCompatibleVersion

Represents an AddNewCompatibleVersion.

Properties

existingCompatibleBuildId

existingCompatibleBuildId: string

A build id which must already exist in the version sets known by the task queue. The new id will be stored in the set containing this id, marking it as compatible with the versions within.

---

makeSetDefault

makeSetDefault: boolean

When set, establishes the compatible set being targeted as the overall default for the queue. If a different set was the current default, the targeted set will replace it as the new default.

---

newBuildId

newBuildId: string

A new id to be added to an existing compatible set.

Methods

toJSON()

toJSON(): object

Converts this AddNewCompatibleVersion to JSON.

Returns

object

JSON object

---

create()

Call Signature

static create(properties?): AddNewCompatibleVersion & $Properties

Creates a new AddNewCompatibleVersion instance using the specified properties.

Parameters

properties?

$Properties

Properties to set

Returns

AddNewCompatibleVersion & $Properties

AddNewCompatibleVersion instance

Call Signature

static create(properties?): AddNewCompatibleVersion

Creates a new AddNewCompatibleVersion instance using the specified properties.

Parameters

properties?

$Properties

Properties to set

Returns

AddNewCompatibleVersion

AddNewCompatibleVersion instance

---

decode()

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

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

AddNewCompatibleVersion & $Properties

AddNewCompatibleVersion

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited()

static decodeDelimited(reader): AddNewCompatibleVersion & $Properties

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

Parameters

reader

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns

AddNewCompatibleVersion & $Properties

AddNewCompatibleVersion

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

Parameters

message

$Properties

AddNewCompatibleVersion message or plain object to encode

writer?

Writer

Writer to encode to

Returns

Writer

Writer

---

encodeDelimited()

static encodeDelimited(message, writer?): Writer

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

Parameters

message

$Properties

AddNewCompatibleVersion message or plain object to encode

writer?

Writer

Writer to encode to

Returns

Writer

Writer

---

fromObject()

static fromObject(object): AddNewCompatibleVersion

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

Parameters

object

Plain object

Returns

AddNewCompatibleVersion

AddNewCompatibleVersion

---

toObject()

static toObject(message, options?): object

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

Parameters

message

AddNewCompatibleVersion

AddNewCompatibleVersion

options?

IConversionOptions

Conversion options

Returns

object

Plain object