Skip to main content

Class: CompatibleVersionSet

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

Implements

Constructors

constructor

new CompatibleVersionSet(properties?): CompatibleVersionSet

Constructs a new CompatibleVersionSet.

Parameters

NameTypeDescription
properties?ICompatibleVersionSetProperties to set

Returns

CompatibleVersionSet

Properties

buildIds

buildIds: string[]

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

Implementation of

ICompatibleVersionSet.buildIds

Methods

toJSON

toJSON(): Object

Converts this CompatibleVersionSet to JSON.

Returns

Object

JSON object


create

create(properties?): CompatibleVersionSet

Creates a new CompatibleVersionSet instance using the specified properties.

Parameters

NameTypeDescription
properties?ICompatibleVersionSetProperties to set

Returns

CompatibleVersionSet

CompatibleVersionSet instance


decode

decode(reader, length?): CompatibleVersionSet

Decodes a CompatibleVersionSet message from the specified reader or buffer.

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from
length?numberMessage length if known beforehand

Returns

CompatibleVersionSet

CompatibleVersionSet

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited

decodeDelimited(reader): CompatibleVersionSet

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

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns

CompatibleVersionSet

CompatibleVersionSet

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

Parameters

NameTypeDescription
messageICompatibleVersionSetCompatibleVersionSet message or plain object to encode
writer?WriterWriter to encode to

Returns

Writer

Writer


encodeDelimited

encodeDelimited(message, writer?): Writer

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

Parameters

NameTypeDescription
messageICompatibleVersionSetCompatibleVersionSet message or plain object to encode
writer?WriterWriter to encode to

Returns

Writer

Writer


fromObject

fromObject(object): CompatibleVersionSet

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

Parameters

NameTypeDescription
objectObjectPlain object

Returns

CompatibleVersionSet

CompatibleVersionSet


getTypeUrl

getTypeUrl(typeUrlPrefix?): string

Gets the default type url for CompatibleVersionSet

Parameters

NameTypeDescription
typeUrlPrefix?stringyour custom typeUrlPrefix(default "type.googleapis.com")

Returns

string

The default type url


toObject

toObject(message, options?): Object

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

Parameters

NameTypeDescription
messageCompatibleVersionSetCompatibleVersionSet
options?IConversionOptionsConversion options

Returns

Object

Plain object