Skip to main content

Class: TaskQueueVersionSelection

Used for specifying versions the caller is interested in.

Properties​

allActive​

allActive: boolean

Include all active versions. A version is considered active if, in the last few minutes, it has had new tasks or polls, or it has been the subject of certain task queue API calls.

buildIds​

buildIds: string[]

Include specific Build IDs.

unversioned​

unversioned: boolean

Include the unversioned queue.

Methods​

toJSON()​

toJSON(): object

Converts this TaskQueueVersionSelection to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): TaskQueueVersionSelection & $Properties

Creates a new TaskQueueVersionSelection instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

TaskQueueVersionSelection & $Properties

TaskQueueVersionSelection instance

Call Signature​

static create(properties?): TaskQueueVersionSelection

Creates a new TaskQueueVersionSelection instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

TaskQueueVersionSelection

TaskQueueVersionSelection instance

decode()​

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

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

TaskQueueVersionSelection & $Properties

TaskQueueVersionSelection

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): TaskQueueVersionSelection & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

TaskQueueVersionSelection & $Properties

TaskQueueVersionSelection

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

Parameters​

message​

$Properties

TaskQueueVersionSelection message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

TaskQueueVersionSelection message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): TaskQueueVersionSelection

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

Parameters​

object​

{[k: string]: any; }

Plain object

Returns​

TaskQueueVersionSelection

TaskQueueVersionSelection

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

TaskQueueVersionSelection

TaskQueueVersionSelection

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object