Interface: IDescribeTaskQueueRequest

workflowservice.v1.IDescribeTaskQueueRequest

Properties of a DescribeTaskQueueRequest.

Implemented by

• DescribeTaskQueueRequest

Properties

apiMode

• Optional apiMode: null | DescribeTaskQueueMode

All options except task_queue_type and include_task_queue_status are only available in the ENHANCED mode.

---

includeTaskQueueStatus

• Optional includeTaskQueueStatus: null | boolean

Deprecated. Ignored in ENHANCED mode.

---

namespace

• Optional namespace: null | string

DescribeTaskQueueRequest namespace

---

reportPollers

• Optional reportPollers: null | boolean

Report list of pollers for requested task queue types and versions

---

reportStats

• Optional reportStats: null | boolean

Report stats for the requested task queue types and versions

---

reportTaskReachability

• Optional reportTaskReachability: null | boolean

Report task reachability for the requested versions and all task types (task reachability is not reported per task type).

---

taskQueue

• Optional taskQueue: null | ITaskQueue

Sticky queues are not supported in ENHANCED mode.

---

taskQueueType

• Optional taskQueueType: null | TaskQueueType

Deprecated. Use ENHANCED mode with task_queue_types. Ignored in ENHANCED mode. If unspecified (TASK_QUEUE_TYPE_UNSPECIFIED), then default value (TASK_QUEUE_TYPE_WORKFLOW) will be used.

---

taskQueueTypes

• Optional taskQueueTypes: null | TaskQueueType[]

Task queue types to report info about. If not specified, all types are considered.

---

versions

• Optional versions: null | ITaskQueueVersionSelection

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