Skip to main content

Interface: IDescribeTaskQueueRequest

Properties of a DescribeTaskQueueRequest.

Extends​

Properties​

apiMode?​

optional apiMode?: DescribeTaskQueueMode | null

Deprecated. ENHANCED mode is also being deprecated. Select the API mode to use for this request: DEFAULT mode (if unset) or ENHANCED mode. Consult the documentation for each field to understand which mode it is supported in.

Inherited from​

$Properties.apiMode

includeTaskQueueStatus?​

optional includeTaskQueueStatus?: boolean | null

Deprecated, use report_stats instead. If true, the task queue status will be included in the response.

Inherited from​

$Properties.includeTaskQueueStatus

namespace?​

optional namespace?: string | null

DescribeTaskQueueRequest namespace

Inherited from​

$Properties.namespace

reportConfig?​

optional reportConfig?: boolean | null

Report Task Queue Config

Inherited from​

$Properties.reportConfig

reportPollers?​

optional reportPollers?: boolean | null

Deprecated (as part of the ENHANCED mode deprecation). Report list of pollers for requested task queue types and versions.

Inherited from​

$Properties.reportPollers

reportStats?​

optional reportStats?: boolean | null

Report stats for the requested task queue type(s).

Inherited from​

$Properties.reportStats

reportTaskReachability?​

optional reportTaskReachability?: boolean | null

Deprecated (as part of the ENHANCED mode deprecation). Report task reachability for the requested versions and all task types (task reachability is not reported per task type).

Inherited from​

$Properties.reportTaskReachability

taskQueue?​

optional taskQueue?: $Properties | null

Sticky queues are not supported in deprecated ENHANCED mode.

Inherited from​

$Properties.taskQueue

taskQueueType?​

optional taskQueueType?: TaskQueueType | null

If unspecified (TASK_QUEUE_TYPE_UNSPECIFIED), then default value (TASK_QUEUE_TYPE_WORKFLOW) will be used. Only supported in default mode (use task_queue_types in ENHANCED mode instead).

Inherited from​

$Properties.taskQueueType

taskQueueTypes?​

optional taskQueueTypes?: TaskQueueType[] | null

Deprecated (as part of the ENHANCED mode deprecation). Task queue types to report info about. If not specified, all types are considered.

Inherited from​

$Properties.taskQueueTypes

versions?​

optional versions?: $Properties | null

Deprecated (as part of the ENHANCED mode deprecation). Optional. If not provided, the result for the default Build ID will be returned. The default Build ID is the one mentioned in the first unconditional Assignment Rule. If there is no default Build ID, the result for the unversioned queue will be returned. (-- api-linter: core::0140::prepositions --)

Inherited from​

$Properties.versions