Interface: IDescribeTaskQueueRequest
workflowservice.v1.IDescribeTaskQueueRequest
Properties of a DescribeTaskQueueRequest.
Hierarchy
-
↳
IDescribeTaskQueueRequest
Properties
apiMode
• Optional apiMode: null | DescribeTaskQueueMode
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
includeTaskQueueStatus
• Optional includeTaskQueueStatus: null | boolean
Deprecated, use report_stats instead.
If true, the task queue status will be included in the response.
Inherited from
$Properties.includeTaskQueueStatus
namespace
• Optional namespace: null | string
DescribeTaskQueueRequest namespace
Inherited from
reportConfig
• Optional reportConfig: null | boolean
Report Task Queue Config
Inherited from
reportPollers
• Optional reportPollers: null | boolean
Deprecated (as part of the ENHANCED mode deprecation). Report list of pollers for requested task queue types and versions.
Inherited from
reportStats
• Optional reportStats: null | boolean
Report stats for the requested task queue type(s).
Inherited from
reportTaskReachability
• Optional reportTaskReachability: null | boolean
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: null | $Properties
Sticky queues are not supported in deprecated ENHANCED mode.
Inherited from
taskQueueType
• Optional taskQueueType: null | TaskQueueType
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
taskQueueTypes
• Optional taskQueueTypes: null | TaskQueueType[]
Deprecated (as part of the ENHANCED mode deprecation). Task queue types to report info about. If not specified, all types are considered.
Inherited from
versions
• Optional versions: null | $Properties
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 --)