Skip to main content

Class: DescribeTaskQueueResponse

Represents a DescribeTaskQueueResponse.

Properties​

config?​

optional config?: $Properties | null

Only populated if report_task_queue_config is set to true.

effectiveRateLimit?​

optional effectiveRateLimit?: $Properties | null

DescribeTaskQueueResponse effectiveRateLimit.

pollers​

pollers: $Properties[]

DescribeTaskQueueResponse pollers.

stats?​

optional stats?: $Properties | null

Statistics for the task queue. Only set if report_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_stats is set on the request. (-- api-linter: core::0140::prepositions=disabled aip.dev/not-precedent: "by" is used to clarify the keys and values. --)

Index Signature​

[k: string]: $Properties

taskQueueStatus?​

optional taskQueueStatus?: $Properties | null

Deprecated. Status of the task queue. Only populated when include_task_queue_status is set to true in the request.

versioningInfo?​

optional versioningInfo?: $Properties | null

Specifies which Worker Deployment Version(s) Server routes this Task Queue's tasks to. When not present, it means the tasks are routed to Unversioned workers (workers with UNVERSIONED or unspecified WorkerVersioningMode.) Task Queue Versioning info is updated indirectly by calling SetWorkerDeploymentCurrentVersion and SetWorkerDeploymentRampingVersion on Worker Deployments. Note: This information is not relevant to Pinned workflow executions and their activities as they are always routed to their Pinned Deployment Version. However, new workflow executions are typically not Pinned until they complete their first task (unless they are started with a Pinned VersioningOverride or are Child Workflows of a Pinned parent).

versionsInfo​

versionsInfo: object

Deprecated. Only returned in ENHANCED mode. This map contains Task Queue information for each Build ID. Empty string as key value means unversioned.

Index Signature​

[k: string]: $Properties

Methods​

toJSON()​

toJSON(): object

Converts this DescribeTaskQueueResponse to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): DescribeTaskQueueResponse & $Properties

Creates a new DescribeTaskQueueResponse instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

DescribeTaskQueueResponse & $Properties

DescribeTaskQueueResponse instance

Call Signature​

static create(properties?): DescribeTaskQueueResponse

Creates a new DescribeTaskQueueResponse instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

DescribeTaskQueueResponse

DescribeTaskQueueResponse instance

decode()​

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

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

DescribeTaskQueueResponse & $Properties

DescribeTaskQueueResponse

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): DescribeTaskQueueResponse & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

DescribeTaskQueueResponse & $Properties

DescribeTaskQueueResponse

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

Parameters​

message​

$Properties

DescribeTaskQueueResponse message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

DescribeTaskQueueResponse message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): DescribeTaskQueueResponse

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

Parameters​

object​

Plain object

Returns​

DescribeTaskQueueResponse

DescribeTaskQueueResponse

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

DescribeTaskQueueResponse

DescribeTaskQueueResponse

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object