Class: VersionTaskQueue

(-- api-linter: core::0123::resource-annotation=disabled --)

Properties

name

name: string

VersionTaskQueue name.

---

stats?

optional stats?: $Properties | null

Only set if report_task_queue_stats is set on the request.

---

statsByPriorityKey

statsByPriorityKey: object

Task queue stats breakdown by priority key. Only contains actively used priority keys. Only set if report_task_queue_stats is set to true in the request. (-- api-linter: core::0140::prepositions=disabled aip.dev/not-precedent: "by" is used to clarify the key. --)

Index Signature

[k: string]: $Properties

---

type

type: TaskQueueType

VersionTaskQueue type.

Methods

toJSON()

toJSON(): object

Converts this VersionTaskQueue to JSON.

Returns

object

JSON object

---

create()

Call Signature

static create(properties?): VersionTaskQueue & $Properties

Creates a new VersionTaskQueue instance using the specified properties.

Parameters

properties?

$Properties

Properties to set

Returns

VersionTaskQueue & $Properties

VersionTaskQueue instance

Call Signature

static create(properties?): VersionTaskQueue

Creates a new VersionTaskQueue instance using the specified properties.

Parameters

properties?

$Properties

Properties to set

Returns

VersionTaskQueue

VersionTaskQueue instance

---

decode()

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

Decodes a VersionTaskQueue 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

VersionTaskQueue & $Properties

VersionTaskQueue

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited()

static decodeDelimited(reader): VersionTaskQueue & $Properties

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

Parameters

reader

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns

VersionTaskQueue & $Properties

VersionTaskQueue

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

Parameters

message

$Properties

VersionTaskQueue message or plain object to encode

writer?

Writer

Writer to encode to

Returns

Writer

Writer

---

encodeDelimited()

static encodeDelimited(message, writer?): Writer

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

Parameters

message

$Properties

VersionTaskQueue message or plain object to encode

writer?

Writer

Writer to encode to

Returns

Writer

Writer

---

fromObject()

static fromObject(object): VersionTaskQueue

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

Parameters

object

Plain object

Returns

VersionTaskQueue

VersionTaskQueue

---

toObject()

static toObject(message, options?): object

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

Parameters

message

VersionTaskQueue

VersionTaskQueue

options?

IConversionOptions

Conversion options

Returns

object

Plain object