Skip to main content

Class: CompatibleVersionSet

Used by the worker versioning APIs, represents an unordered set of one or more versions which are considered to be compatible with each other. Currently the versions are always worker build IDs.

Properties​

buildIds​

buildIds: string[]

All the compatible versions, unordered, except for the last element, which is considered the set "default".

Methods​

toJSON()​

toJSON(): object

Converts this CompatibleVersionSet to JSON.

Returns​

object

JSON object


create()​

Call Signature​

static create(properties?): CompatibleVersionSet & $Properties

Creates a new CompatibleVersionSet instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

CompatibleVersionSet & $Properties

CompatibleVersionSet instance

Call Signature​

static create(properties?): CompatibleVersionSet

Creates a new CompatibleVersionSet instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

CompatibleVersionSet

CompatibleVersionSet instance


decode()​

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

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

CompatibleVersionSet & $Properties

CompatibleVersionSet

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing


decodeDelimited()​

static decodeDelimited(reader): CompatibleVersionSet & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

CompatibleVersionSet & $Properties

CompatibleVersionSet

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

Parameters​

message​

$Properties

CompatibleVersionSet message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer


encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

CompatibleVersionSet message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer


fromObject()​

static fromObject(object): CompatibleVersionSet

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

Parameters​

object​

Plain object

Returns​

CompatibleVersionSet

CompatibleVersionSet


toObject()​

static toObject(message, options?): object

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

Parameters​

message​

CompatibleVersionSet

CompatibleVersionSet

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object