Skip to content

Commit c8a3e56

Browse files
stephanosstephanos
committed
Add Stats to DescribeTaskQueue
1 parent 50cbefb commit c8a3e56

3 files changed

Lines changed: 152 additions & 91 deletions

File tree

‎openapi/openapiv2.json‎

Lines changed: 44 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -1488,6 +1488,18 @@
14881488
"required": true,
14891489
"type": "string"
14901490
},
1491+
{
1492+
"name": "apiMode",
1493+
"description": "Select the API mode to use for this request: DEFAULT mode (if unset) or ENHANCED mode.\nConsult the documentation for each field to understand which mode it is supported in.\n\n - DESCRIBE_TASK_QUEUE_MODE_UNSPECIFIED: Unspecified means legacy behavior.\n - DESCRIBE_TASK_QUEUE_MODE_ENHANCED: Enhanced mode reports aggregated results for all partitions, supports Build IDs, and reports richer info.",
1494+
"in": "query",
1495+
"required": false,
1496+
"type": "string",
1497+
"enum": [
1498+
"DESCRIBE_TASK_QUEUE_MODE_UNSPECIFIED",
1499+
"DESCRIBE_TASK_QUEUE_MODE_ENHANCED"
1500+
],
1501+
"default": "DESCRIBE_TASK_QUEUE_MODE_UNSPECIFIED"
1502+
},
14911503
{
14921504
"name": "taskQueue.kind",
14931505
"description": "Default: TASK_QUEUE_KIND_NORMAL.\n\n - TASK_QUEUE_KIND_NORMAL: Tasks from a normal workflow task queue always include complete workflow history\n\nThe task queue specified by the user is always a normal task queue. There can be as many\nworkers as desired for a single normal task queue. All those workers may pick up tasks from\nthat queue.\n - TASK_QUEUE_KIND_STICKY: A sticky queue only includes new history since the last workflow task, and they are\nper-worker.\n\nSticky queues are created dynamically by each worker during their start up. They only exist\nfor the lifetime of the worker process. Tasks in a sticky task queue are only available to\nthe worker that created the sticky queue.\n\nSticky queues are only for workflow tasks. There are no sticky task queues for activities.",
@@ -1510,7 +1522,7 @@
15101522
},
15111523
{
15121524
"name": "taskQueueType",
1513-
"description": "Deprecated. Use `ENHANCED` mode with `task_queue_types`. Ignored in `ENHANCED` mode.\nIf unspecified (TASK_QUEUE_TYPE_UNSPECIFIED), then default value (TASK_QUEUE_TYPE_WORKFLOW) will be used.\n\n - TASK_QUEUE_TYPE_WORKFLOW: Workflow type of task queue.\n - TASK_QUEUE_TYPE_ACTIVITY: Activity type of task queue.\n - TASK_QUEUE_TYPE_NEXUS: Task queue type for dispatching Nexus requests.",
1525+
"description": "[DEFAULT MODE ONLY]\nIf unspecified (TASK_QUEUE_TYPE_UNSPECIFIED), then default value (TASK_QUEUE_TYPE_WORKFLOW) will be used.\nOnly supported in default mode (use `task_queue_types` in ENHANCED mode instead).\n\n - TASK_QUEUE_TYPE_WORKFLOW: Workflow type of task queue.\n - TASK_QUEUE_TYPE_ACTIVITY: Activity type of task queue.\n - TASK_QUEUE_TYPE_NEXUS: Task queue type for dispatching Nexus requests.",
15141526
"in": "query",
15151527
"required": false,
15161528
"type": "string",
@@ -1524,23 +1536,11 @@
15241536
},
15251537
{
15261538
"name": "includeTaskQueueStatus",
1527-
"description": "Deprecated. Ignored in `ENHANCED` mode.",
1539+
"description": "[DEFAULT MODE ONLY]\nIf true, the task queue status will be included in the response.\nIn ENHANCED mode, use `report_stats` instead.",
15281540
"in": "query",
15291541
"required": false,
15301542
"type": "boolean"
15311543
},
1532-
{
1533-
"name": "apiMode",
1534-
"description": "All options except `task_queue_type` and `include_task_queue_status` are only available in the `ENHANCED` mode.\n\n - DESCRIBE_TASK_QUEUE_MODE_UNSPECIFIED: Unspecified means legacy behavior.\n - DESCRIBE_TASK_QUEUE_MODE_ENHANCED: Enhanced mode reports aggregated results for all partitions, supports Build IDs, and reports richer info.",
1535-
"in": "query",
1536-
"required": false,
1537-
"type": "string",
1538-
"enum": [
1539-
"DESCRIBE_TASK_QUEUE_MODE_UNSPECIFIED",
1540-
"DESCRIBE_TASK_QUEUE_MODE_ENHANCED"
1541-
],
1542-
"default": "DESCRIBE_TASK_QUEUE_MODE_UNSPECIFIED"
1543-
},
15441544
{
15451545
"name": "versions.buildIds",
15461546
"description": "Include specific Build IDs.",
@@ -1568,7 +1568,7 @@
15681568
},
15691569
{
15701570
"name": "taskQueueTypes",
1571-
"description": "Task queue types to report info about. If not specified, all types are considered.\n\n - TASK_QUEUE_TYPE_WORKFLOW: Workflow type of task queue.\n - TASK_QUEUE_TYPE_ACTIVITY: Activity type of task queue.\n - TASK_QUEUE_TYPE_NEXUS: Task queue type for dispatching Nexus requests.",
1571+
"description": "[ENHANCED MODE ONLY]\nTask queue types to report info about. If not specified, all types are considered.\n\n - TASK_QUEUE_TYPE_WORKFLOW: Workflow type of task queue.\n - TASK_QUEUE_TYPE_ACTIVITY: Activity type of task queue.\n - TASK_QUEUE_TYPE_NEXUS: Task queue type for dispatching Nexus requests.",
15721572
"in": "query",
15731573
"required": false,
15741574
"type": "array",
@@ -1585,21 +1585,21 @@
15851585
},
15861586
{
15871587
"name": "reportStats",
1588-
"description": "Report stats for the requested task queue types and versions",
1588+
"description": "[BOTH MODES]\nReport stats for the requested task queue type(s), and versions (only in ENHANCED mode).",
15891589
"in": "query",
15901590
"required": false,
15911591
"type": "boolean"
15921592
},
15931593
{
15941594
"name": "reportPollers",
1595-
"description": "Report list of pollers for requested task queue types and versions",
1595+
"description": "[ENHANCED MODE ONLY]\nReport list of pollers for requested task queue types and versions.",
15961596
"in": "query",
15971597
"required": false,
15981598
"type": "boolean"
15991599
},
16001600
{
16011601
"name": "reportTaskReachability",
1602-
"description": "Report task reachability for the requested versions and all task types (task reachability is not reported\nper task type).",
1602+
"description": "[ENHANCED MODE ONLY]\nReport task reachability for the requested versions and all task types (task reachability is not reported\nper task type).",
16031603
"in": "query",
16041604
"required": false,
16051605
"type": "boolean"
@@ -5036,6 +5036,18 @@
50365036
"required": true,
50375037
"type": "string"
50385038
},
5039+
{
5040+
"name": "apiMode",
5041+
"description": "Select the API mode to use for this request: DEFAULT mode (if unset) or ENHANCED mode.\nConsult the documentation for each field to understand which mode it is supported in.\n\n - DESCRIBE_TASK_QUEUE_MODE_UNSPECIFIED: Unspecified means legacy behavior.\n - DESCRIBE_TASK_QUEUE_MODE_ENHANCED: Enhanced mode reports aggregated results for all partitions, supports Build IDs, and reports richer info.",
5042+
"in": "query",
5043+
"required": false,
5044+
"type": "string",
5045+
"enum": [
5046+
"DESCRIBE_TASK_QUEUE_MODE_UNSPECIFIED",
5047+
"DESCRIBE_TASK_QUEUE_MODE_ENHANCED"
5048+
],
5049+
"default": "DESCRIBE_TASK_QUEUE_MODE_UNSPECIFIED"
5050+
},
50395051
{
50405052
"name": "taskQueue.kind",
50415053
"description": "Default: TASK_QUEUE_KIND_NORMAL.\n\n - TASK_QUEUE_KIND_NORMAL: Tasks from a normal workflow task queue always include complete workflow history\n\nThe task queue specified by the user is always a normal task queue. There can be as many\nworkers as desired for a single normal task queue. All those workers may pick up tasks from\nthat queue.\n - TASK_QUEUE_KIND_STICKY: A sticky queue only includes new history since the last workflow task, and they are\nper-worker.\n\nSticky queues are created dynamically by each worker during their start up. They only exist\nfor the lifetime of the worker process. Tasks in a sticky task queue are only available to\nthe worker that created the sticky queue.\n\nSticky queues are only for workflow tasks. There are no sticky task queues for activities.",
@@ -5058,7 +5070,7 @@
50585070
},
50595071
{
50605072
"name": "taskQueueType",
5061-
"description": "Deprecated. Use `ENHANCED` mode with `task_queue_types`. Ignored in `ENHANCED` mode.\nIf unspecified (TASK_QUEUE_TYPE_UNSPECIFIED), then default value (TASK_QUEUE_TYPE_WORKFLOW) will be used.\n\n - TASK_QUEUE_TYPE_WORKFLOW: Workflow type of task queue.\n - TASK_QUEUE_TYPE_ACTIVITY: Activity type of task queue.\n - TASK_QUEUE_TYPE_NEXUS: Task queue type for dispatching Nexus requests.",
5073+
"description": "[DEFAULT MODE ONLY]\nIf unspecified (TASK_QUEUE_TYPE_UNSPECIFIED), then default value (TASK_QUEUE_TYPE_WORKFLOW) will be used.\nOnly supported in default mode (use `task_queue_types` in ENHANCED mode instead).\n\n - TASK_QUEUE_TYPE_WORKFLOW: Workflow type of task queue.\n - TASK_QUEUE_TYPE_ACTIVITY: Activity type of task queue.\n - TASK_QUEUE_TYPE_NEXUS: Task queue type for dispatching Nexus requests.",
50625074
"in": "query",
50635075
"required": false,
50645076
"type": "string",
@@ -5072,23 +5084,11 @@
50725084
},
50735085
{
50745086
"name": "includeTaskQueueStatus",
5075-
"description": "Deprecated. Ignored in `ENHANCED` mode.",
5087+
"description": "[DEFAULT MODE ONLY]\nIf true, the task queue status will be included in the response.\nIn ENHANCED mode, use `report_stats` instead.",
50765088
"in": "query",
50775089
"required": false,
50785090
"type": "boolean"
50795091
},
5080-
{
5081-
"name": "apiMode",
5082-
"description": "All options except `task_queue_type` and `include_task_queue_status` are only available in the `ENHANCED` mode.\n\n - DESCRIBE_TASK_QUEUE_MODE_UNSPECIFIED: Unspecified means legacy behavior.\n - DESCRIBE_TASK_QUEUE_MODE_ENHANCED: Enhanced mode reports aggregated results for all partitions, supports Build IDs, and reports richer info.",
5083-
"in": "query",
5084-
"required": false,
5085-
"type": "string",
5086-
"enum": [
5087-
"DESCRIBE_TASK_QUEUE_MODE_UNSPECIFIED",
5088-
"DESCRIBE_TASK_QUEUE_MODE_ENHANCED"
5089-
],
5090-
"default": "DESCRIBE_TASK_QUEUE_MODE_UNSPECIFIED"
5091-
},
50925092
{
50935093
"name": "versions.buildIds",
50945094
"description": "Include specific Build IDs.",
@@ -5116,7 +5116,7 @@
51165116
},
51175117
{
51185118
"name": "taskQueueTypes",
5119-
"description": "Task queue types to report info about. If not specified, all types are considered.\n\n - TASK_QUEUE_TYPE_WORKFLOW: Workflow type of task queue.\n - TASK_QUEUE_TYPE_ACTIVITY: Activity type of task queue.\n - TASK_QUEUE_TYPE_NEXUS: Task queue type for dispatching Nexus requests.",
5119+
"description": "[ENHANCED MODE ONLY]\nTask queue types to report info about. If not specified, all types are considered.\n\n - TASK_QUEUE_TYPE_WORKFLOW: Workflow type of task queue.\n - TASK_QUEUE_TYPE_ACTIVITY: Activity type of task queue.\n - TASK_QUEUE_TYPE_NEXUS: Task queue type for dispatching Nexus requests.",
51205120
"in": "query",
51215121
"required": false,
51225122
"type": "array",
@@ -5133,21 +5133,21 @@
51335133
},
51345134
{
51355135
"name": "reportStats",
5136-
"description": "Report stats for the requested task queue types and versions",
5136+
"description": "[BOTH MODES]\nReport stats for the requested task queue type(s), and versions (only in ENHANCED mode).",
51375137
"in": "query",
51385138
"required": false,
51395139
"type": "boolean"
51405140
},
51415141
{
51425142
"name": "reportPollers",
5143-
"description": "Report list of pollers for requested task queue types and versions",
5143+
"description": "[ENHANCED MODE ONLY]\nReport list of pollers for requested task queue types and versions.",
51445144
"in": "query",
51455145
"required": false,
51465146
"type": "boolean"
51475147
},
51485148
{
51495149
"name": "reportTaskReachability",
5150-
"description": "Report task reachability for the requested versions and all task types (task reachability is not reported\nper task type).",
5150+
"description": "[ENHANCED MODE ONLY]\nReport task reachability for the requested versions and all task types (task reachability is not reported\nper task type).",
51515151
"in": "query",
51525152
"required": false,
51535153
"type": "boolean"
@@ -10058,22 +10058,26 @@
1005810058
"type": "object",
1005910059
"$ref": "#/definitions/v1PollerInfo"
1006010060
},
10061-
"description": "Deprecated. Use `versions_info.types_info.pollers` with `ENHANCED` mode instead.\nNot set in `ENHANCED` mode."
10061+
"title": "[DEFAULT MODE ONLY]"
1006210062
},
1006310063
"taskQueueStatus": {
1006410064
"$ref": "#/definitions/v1TaskQueueStatus",
10065-
"description": "Deprecated. Not set in `ENHANCED` mode."
10065+
"description": "[DEFAULT MODE ONLY]\nDeprecated.\nStatus of the task queue. Only populated when `include_task_queue_status` is set to true in the request."
10066+
},
10067+
"taskQueueStats": {
10068+
"$ref": "#/definitions/v1TaskQueueStats",
10069+
"description": "[DEFAULT MODE ONLY]\nStatistics for the task queue. Only populated when `report_stats` is set to true in the request."
1006610070
},
1006710071
"versionsInfo": {
1006810072
"type": "object",
1006910073
"additionalProperties": {
1007010074
"$ref": "#/definitions/v1TaskQueueVersionInfo"
1007110075
},
10072-
"description": "This map contains Task Queue information for each Build ID. Empty string as key value means unversioned.\nOnly set in `ENHANCED` mode."
10076+
"description": "[ENHANCED MODE ONLY]\nThis map contains Task Queue information for each Build ID. Empty string as key value means unversioned."
1007310077
},
1007410078
"versioningInfo": {
1007510079
"$ref": "#/definitions/v1TaskQueueVersioningInfo",
10076-
"description": "Specifies which Worker Deployment Version(s) Server routes this Task Queue's tasks to.\nWhen not present, it means the tasks are routed to Unversioned workers (workers with\nUNVERSIONED or unspecified WorkerVersioningMode.)\nTask Queue Versioning info is updated indirectly by calling SetWorkerDeploymentCurrentVersion\nand SetWorkerDeploymentRampingVersion on Worker Deployments.\nNote: This information is not relevant to Pinned workflow executions and their activities as\nthey are always routed to their Pinned Deployment Version. However, new workflow executions\nare typically not Pinned until they complete their first task (unless they are started with\na Pinned VersioningOverride or are Child Workflows of a Pinned parent)."
10080+
"description": "[ENHANCED MODE ONLY]\nSpecifies which Worker Deployment Version(s) Server routes this Task Queue's tasks to.\nWhen not present, it means the tasks are routed to Unversioned workers (workers with\nUNVERSIONED or unspecified WorkerVersioningMode.)\nTask Queue Versioning info is updated indirectly by calling SetWorkerDeploymentCurrentVersion\nand SetWorkerDeploymentRampingVersion on Worker Deployments.\nNote: This information is not relevant to Pinned workflow executions and their activities as\nthey are always routed to their Pinned Deployment Version. However, new workflow executions\nare typically not Pinned until they complete their first task (unless they are started with\na Pinned VersioningOverride or are Child Workflows of a Pinned parent)."
1007710081
}
1007810082
}
1007910083
},

0 commit comments

Comments
 (0)