Skip to main content

Interface: IDescribeTaskQueueResponse

workflowservice.v1.IDescribeTaskQueueResponse

Properties of a DescribeTaskQueueResponse.

Hierarchy​

Properties​

config​

• Optional config: null | $Properties

Only populated if report_task_queue_config is set to true.

Inherited from​

$Properties.config

effectiveRateLimit​

• Optional effectiveRateLimit: null | $Properties

DescribeTaskQueueResponse effectiveRateLimit

Inherited from​

$Properties.effectiveRateLimit

pollers​

• Optional pollers: null | $Properties[]

DescribeTaskQueueResponse pollers

Inherited from​

$Properties.pollers

stats​

• Optional stats: null | $Properties

Statistics for the task queue. Only set if report_stats is set on the request.

Inherited from​

$Properties.stats

statsByPriorityKey​

• Optional statsByPriorityKey: null | { [k: string]: $Properties; }

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. --)

Inherited from​

$Properties.statsByPriorityKey

taskQueueStatus​

• Optional taskQueueStatus: null | $Properties

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

Inherited from​

$Properties.taskQueueStatus

versioningInfo​

• Optional versioningInfo: null | $Properties

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).

Inherited from​

$Properties.versioningInfo

versionsInfo​

• Optional versionsInfo: null | { [k: string]: $Properties; }

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

Inherited from​

$Properties.versionsInfo