Skip to content

Commit e9ccde4

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
andauthored
Regenerate client from commit a8466ac of spec repo (#3719)
Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>
1 parent eb798ce commit e9ccde4

12 files changed

Lines changed: 342 additions & 10 deletions

.generator/schemas/v2/openapi.yaml

Lines changed: 82 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -58798,13 +58798,15 @@ components:
5879858798
- token
5879958799
type: object
5880058800
Metric:
58801-
description: Object for a single metric tag configuration.
58801+
description: Object for a single metric.
5880258802
example:
5880358803
id: metric.foo.bar
5880458804
type: metrics
5880558805
properties:
5880658806
id:
5880758807
$ref: "#/components/schemas/MetricName"
58808+
relationships:
58809+
$ref: "#/components/schemas/MetricRelationships"
5880858810
type:
5880958811
$ref: "#/components/schemas/MetricType"
5881058812
type: object
@@ -59341,12 +59343,12 @@ components:
5934159343
description: Object containing the definition of a metric's ingested and indexed volume.
5934259344
properties:
5934359345
indexed_volume:
59344-
description: Indexed volume for the given metric.
59346+
description: Estimated average hourly number of indexed time series for the given metric over the last hour. For organizations on Metric Name Pricing, this represents the estimated sum of indexed data points over the last hour.
5934559347
example: 10
5934659348
format: int64
5934759349
type: integer
5934859350
ingested_volume:
59349-
description: Ingested volume for the given metric.
59351+
description: Estimated average hourly number of ingested time series for the given metric over the last hour. This value is `0` for metrics not configured with Metrics Without Limits. For organizations on Metric Name Pricing, this represents the estimated sum of ingested data points over the last hour.
5935059352
example: 20
5935159353
format: int64
5935259354
type: integer
@@ -59523,6 +59525,12 @@ components:
5952359525
format: double
5952459526
type: number
5952559527
type: object
59528+
MetricRelationships:
59529+
description: Relationships for a metric.
59530+
properties:
59531+
metric_volumes:
59532+
$ref: "#/components/schemas/MetricVolumesRelationship"
59533+
type: object
5952659534
MetricResource:
5952759535
description: Metric resource.
5952859536
example: {name: "dummyhost", type: "host"}
@@ -59715,6 +59723,8 @@ components:
5971559723
$ref: "#/components/schemas/MetricTagConfigurationAttributes"
5971659724
id:
5971759725
$ref: "#/components/schemas/MetricName"
59726+
relationships:
59727+
$ref: "#/components/schemas/MetricRelationships"
5971859728
type:
5971959729
$ref: "#/components/schemas/MetricTagConfigurationType"
5972059730
type: object
@@ -59927,6 +59937,20 @@ components:
5992759937
oneOf:
5992859938
- $ref: "#/components/schemas/MetricDistinctVolume"
5992959939
- $ref: "#/components/schemas/MetricIngestedIndexedVolume"
59940+
MetricVolumesRelationship:
59941+
description: Relationship to a metric volume included in the response.
59942+
properties:
59943+
data:
59944+
$ref: "#/components/schemas/MetricVolumesRelationshipData"
59945+
type: object
59946+
MetricVolumesRelationshipData:
59947+
description: Relationship data for a metric volume.
59948+
properties:
59949+
id:
59950+
$ref: "#/components/schemas/MetricName"
59951+
type:
59952+
$ref: "#/components/schemas/MetricIngestedIndexedVolumeType"
59953+
type: object
5993059954
MetricVolumesResponse:
5993159955
description: Response object which includes a single metric's volume.
5993259956
properties:
@@ -59972,6 +59996,11 @@ components:
5997259996
items:
5997359997
$ref: "#/components/schemas/MetricsAndMetricTagConfigurations"
5997459998
type: array
59999+
included:
60000+
description: Array of metric volume resources included when requested with `include=metric_volumes`.
60001+
items:
60002+
$ref: "#/components/schemas/MetricIngestedIndexedVolume"
60003+
type: array
5997560004
links:
5997660005
$ref: "#/components/schemas/MetricsListResponseLinks"
5997760006
meta:
@@ -152443,13 +152472,20 @@ paths:
152443152472
Query parameters use bracket notation (for example, `filter[tags]`, `filter[queried][window][seconds]`). Pass them as standard URL query strings, URL-encoding the brackets if your client does not handle them. For example: `GET /api/v2/metrics?filter[tags]=env:prod&window[seconds]=86400&page[size]=500`.
152444152473
operationId: ListTagConfigurations
152445152474
parameters:
152446-
- description: Only return custom metrics that have been configured with Metrics Without Limits.
152475+
- description: Only return custom metrics that have been configured (`true`) or not configured (`false`) with Metrics Without Limits.
152447152476
example: true
152448152477
in: query
152449152478
name: filter[configured]
152450152479
required: false
152451152480
schema:
152452152481
type: boolean
152482+
- description: Only return metrics that are eligible (`true`) or ineligible (`false`) for configuration with Metrics Without Limits.
152483+
example: true
152484+
in: query
152485+
name: filter[is_configurable]
152486+
required: false
152487+
schema:
152488+
type: boolean
152453152489
- description: Only return metrics that have the given tag key(s) in their Metrics Without Limits configuration (included or excluded).
152454152490
example: "app,env"
152455152491
in: query
@@ -152507,6 +152543,20 @@ paths:
152507152543
required: false
152508152544
schema:
152509152545
type: boolean
152546+
- description: Include related resources in the response. Set to `metric_volumes` to include indexed and ingested volume counts for each metric.
152547+
example: metric_volumes
152548+
in: query
152549+
name: include
152550+
required: false
152551+
schema:
152552+
type: string
152553+
- description: "Sort results by metric volume. Prefix a key with `-` for descending order. Supported keys: `metric_volumes.indexed_volume`, `metric_volumes.ingested_volume`, `metric_volumes.indexed_volume_delta`, `metric_volumes.ingested_volume_delta`. Requires a paginated request (`page[size]` or `page[cursor]`)."
152554+
example: "-metric_volumes.indexed_volume"
152555+
in: query
152556+
name: sort
152557+
required: false
152558+
schema:
152559+
type: string
152510152560
- description: |-
152511152561
Only return metrics that have been actively reporting in the specified window. The default value is 3600 seconds (1 hour), the maximum value is 2,592,000 seconds (30 days), and the minimum value is 1 second.
152512152562
example: 3600
@@ -152548,6 +152598,34 @@ paths:
152548152598
meta:
152549152599
pagination:
152550152600
next_cursor:
152601+
with_metric_volumes:
152602+
value:
152603+
data:
152604+
- id: user.custom.cpu.usage
152605+
relationships:
152606+
metric_volumes:
152607+
data:
152608+
id: user.custom.cpu.usage
152609+
type: metric_volumes
152610+
type: metrics
152611+
- id: user.custom.mem.usage
152612+
relationships:
152613+
metric_volumes:
152614+
data:
152615+
id: user.custom.mem.usage
152616+
type: metric_volumes
152617+
type: metrics
152618+
included:
152619+
- attributes:
152620+
indexed_volume: 1000
152621+
ingested_volume: 456
152622+
id: user.custom.cpu.usage
152623+
type: metric_volumes
152624+
- attributes:
152625+
indexed_volume: 250
152626+
ingested_volume: 1011
152627+
id: user.custom.mem.usage
152628+
type: metric_volumes
152551152629
schema:
152552152630
$ref: "#/components/schemas/MetricsAndMetricTagConfigurationsResponse"
152553152631
description: Success

docs/datadog_api_client.v2.model.rst

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24602,6 +24602,13 @@ datadog\_api\_client.v2.model.metric\_point module
2460224602
:members:
2460324603
:show-inheritance:
2460424604

24605+
datadog\_api\_client.v2.model.metric\_relationships module
24606+
----------------------------------------------------------
24607+
24608+
.. automodule:: datadog_api_client.v2.model.metric_relationships
24609+
:members:
24610+
:show-inheritance:
24611+
2460524612
datadog\_api\_client.v2.model.metric\_resource module
2460624613
-----------------------------------------------------
2460724614

@@ -24784,6 +24791,20 @@ datadog\_api\_client.v2.model.metric\_volumes module
2478424791
:members:
2478524792
:show-inheritance:
2478624793

24794+
datadog\_api\_client.v2.model.metric\_volumes\_relationship module
24795+
------------------------------------------------------------------
24796+
24797+
.. automodule:: datadog_api_client.v2.model.metric_volumes_relationship
24798+
:members:
24799+
:show-inheritance:
24800+
24801+
datadog\_api\_client.v2.model.metric\_volumes\_relationship\_data module
24802+
------------------------------------------------------------------------
24803+
24804+
.. automodule:: datadog_api_client.v2.model.metric_volumes_relationship_data
24805+
:members:
24806+
:show-inheritance:
24807+
2478724808
datadog\_api\_client.v2.model.metric\_volumes\_response module
2478824809
--------------------------------------------------------------
2478924810

src/datadog_api_client/v2/api/metrics_api.py

Lines changed: 53 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -473,6 +473,11 @@ def __init__(self, api_client=None):
473473
"attribute": "filter[configured]",
474474
"location": "query",
475475
},
476+
"filter_is_configurable": {
477+
"openapi_types": (bool,),
478+
"attribute": "filter[is_configurable]",
479+
"location": "query",
480+
},
476481
"filter_tags_configured": {
477482
"openapi_types": (str,),
478483
"attribute": "filter[tags_configured]",
@@ -512,6 +517,16 @@ def __init__(self, api_client=None):
512517
"attribute": "filter[related_assets]",
513518
"location": "query",
514519
},
520+
"include": {
521+
"openapi_types": (str,),
522+
"attribute": "include",
523+
"location": "query",
524+
},
525+
"sort": {
526+
"openapi_types": (str,),
527+
"attribute": "sort",
528+
"location": "query",
529+
},
515530
"window_seconds": {
516531
"validation": {
517532
"inclusive_maximum": 2592000,
@@ -1153,13 +1168,16 @@ def list_tag_configurations(
11531168
self,
11541169
*,
11551170
filter_configured: Union[bool, UnsetType] = unset,
1171+
filter_is_configurable: Union[bool, UnsetType] = unset,
11561172
filter_tags_configured: Union[str, UnsetType] = unset,
11571173
filter_metric_type: Union[MetricTagConfigurationMetricTypeCategory, UnsetType] = unset,
11581174
filter_include_percentiles: Union[bool, UnsetType] = unset,
11591175
filter_queried: Union[bool, UnsetType] = unset,
11601176
filter_queried_window_seconds: Union[int, UnsetType] = unset,
11611177
filter_tags: Union[str, UnsetType] = unset,
11621178
filter_related_assets: Union[bool, UnsetType] = unset,
1179+
include: Union[str, UnsetType] = unset,
1180+
sort: Union[str, UnsetType] = unset,
11631181
window_seconds: Union[int, UnsetType] = unset,
11641182
page_size: Union[int, UnsetType] = unset,
11651183
page_cursor: Union[str, UnsetType] = unset,
@@ -1170,8 +1188,10 @@ def list_tag_configurations(
11701188
11711189
Query parameters use bracket notation (for example, ``filter[tags]`` , ``filter[queried][window][seconds]`` ). Pass them as standard URL query strings, URL-encoding the brackets if your client does not handle them. For example: ``GET /api/v2/metrics?filter[tags]=env:prod&window[seconds]=86400&page[size]=500``.
11721190
1173-
:param filter_configured: Only return custom metrics that have been configured with Metrics Without Limits.
1191+
:param filter_configured: Only return custom metrics that have been configured ( ``true`` ) or not configured ( ``false`` ) with Metrics Without Limits.
11741192
:type filter_configured: bool, optional
1193+
:param filter_is_configurable: Only return metrics that are eligible ( ``true`` ) or ineligible ( ``false`` ) for configuration with Metrics Without Limits.
1194+
:type filter_is_configurable: bool, optional
11751195
:param filter_tags_configured: Only return metrics that have the given tag key(s) in their Metrics Without Limits configuration (included or excluded).
11761196
:type filter_tags_configured: str, optional
11771197
:param filter_metric_type: Only return metrics of the given metric type.
@@ -1186,6 +1206,10 @@ def list_tag_configurations(
11861206
:type filter_tags: str, optional
11871207
:param filter_related_assets: Only return metrics that are used in at least one dashboard, monitor, notebook, or SLO.
11881208
:type filter_related_assets: bool, optional
1209+
:param include: Include related resources in the response. Set to ``metric_volumes`` to include indexed and ingested volume counts for each metric.
1210+
:type include: str, optional
1211+
:param sort: Sort results by metric volume. Prefix a key with ``-`` for descending order. Supported keys: ``metric_volumes.indexed_volume`` , ``metric_volumes.ingested_volume`` , ``metric_volumes.indexed_volume_delta`` , ``metric_volumes.ingested_volume_delta``. Requires a paginated request ( ``page[size]`` or ``page[cursor]`` ).
1212+
:type sort: str, optional
11891213
:param window_seconds: Only return metrics that have been actively reporting in the specified window. The default value is 3600 seconds (1 hour), the maximum value is 2,592,000 seconds (30 days), and the minimum value is 1 second.
11901214
:type window_seconds: int, optional
11911215
:param page_size: Maximum number of results per page. Send ``page[size]`` on the first request to opt in to pagination. On each subsequent request, send ``page[cursor]`` set to the value of ``meta.pagination.next_cursor`` from the previous response. The default value is 10000, the maximum value is 10000, and the minimum value is 1.
@@ -1198,6 +1222,9 @@ def list_tag_configurations(
11981222
if filter_configured is not unset:
11991223
kwargs["filter_configured"] = filter_configured
12001224

1225+
if filter_is_configurable is not unset:
1226+
kwargs["filter_is_configurable"] = filter_is_configurable
1227+
12011228
if filter_tags_configured is not unset:
12021229
kwargs["filter_tags_configured"] = filter_tags_configured
12031230

@@ -1219,6 +1246,12 @@ def list_tag_configurations(
12191246
if filter_related_assets is not unset:
12201247
kwargs["filter_related_assets"] = filter_related_assets
12211248

1249+
if include is not unset:
1250+
kwargs["include"] = include
1251+
1252+
if sort is not unset:
1253+
kwargs["sort"] = sort
1254+
12221255
if window_seconds is not unset:
12231256
kwargs["window_seconds"] = window_seconds
12241257

@@ -1234,13 +1267,16 @@ def list_tag_configurations_with_pagination(
12341267
self,
12351268
*,
12361269
filter_configured: Union[bool, UnsetType] = unset,
1270+
filter_is_configurable: Union[bool, UnsetType] = unset,
12371271
filter_tags_configured: Union[str, UnsetType] = unset,
12381272
filter_metric_type: Union[MetricTagConfigurationMetricTypeCategory, UnsetType] = unset,
12391273
filter_include_percentiles: Union[bool, UnsetType] = unset,
12401274
filter_queried: Union[bool, UnsetType] = unset,
12411275
filter_queried_window_seconds: Union[int, UnsetType] = unset,
12421276
filter_tags: Union[str, UnsetType] = unset,
12431277
filter_related_assets: Union[bool, UnsetType] = unset,
1278+
include: Union[str, UnsetType] = unset,
1279+
sort: Union[str, UnsetType] = unset,
12441280
window_seconds: Union[int, UnsetType] = unset,
12451281
page_size: Union[int, UnsetType] = unset,
12461282
page_cursor: Union[str, UnsetType] = unset,
@@ -1249,8 +1285,10 @@ def list_tag_configurations_with_pagination(
12491285
12501286
Provide a paginated version of :meth:`list_tag_configurations`, returning all items.
12511287
1252-
:param filter_configured: Only return custom metrics that have been configured with Metrics Without Limits.
1288+
:param filter_configured: Only return custom metrics that have been configured ( ``true`` ) or not configured ( ``false`` ) with Metrics Without Limits.
12531289
:type filter_configured: bool, optional
1290+
:param filter_is_configurable: Only return metrics that are eligible ( ``true`` ) or ineligible ( ``false`` ) for configuration with Metrics Without Limits.
1291+
:type filter_is_configurable: bool, optional
12541292
:param filter_tags_configured: Only return metrics that have the given tag key(s) in their Metrics Without Limits configuration (included or excluded).
12551293
:type filter_tags_configured: str, optional
12561294
:param filter_metric_type: Only return metrics of the given metric type.
@@ -1265,6 +1303,10 @@ def list_tag_configurations_with_pagination(
12651303
:type filter_tags: str, optional
12661304
:param filter_related_assets: Only return metrics that are used in at least one dashboard, monitor, notebook, or SLO.
12671305
:type filter_related_assets: bool, optional
1306+
:param include: Include related resources in the response. Set to ``metric_volumes`` to include indexed and ingested volume counts for each metric.
1307+
:type include: str, optional
1308+
:param sort: Sort results by metric volume. Prefix a key with ``-`` for descending order. Supported keys: ``metric_volumes.indexed_volume`` , ``metric_volumes.ingested_volume`` , ``metric_volumes.indexed_volume_delta`` , ``metric_volumes.ingested_volume_delta``. Requires a paginated request ( ``page[size]`` or ``page[cursor]`` ).
1309+
:type sort: str, optional
12681310
:param window_seconds: Only return metrics that have been actively reporting in the specified window. The default value is 3600 seconds (1 hour), the maximum value is 2,592,000 seconds (30 days), and the minimum value is 1 second.
12691311
:type window_seconds: int, optional
12701312
:param page_size: Maximum number of results per page. Send ``page[size]`` on the first request to opt in to pagination. On each subsequent request, send ``page[cursor]`` set to the value of ``meta.pagination.next_cursor`` from the previous response. The default value is 10000, the maximum value is 10000, and the minimum value is 1.
@@ -1279,6 +1321,9 @@ def list_tag_configurations_with_pagination(
12791321
if filter_configured is not unset:
12801322
kwargs["filter_configured"] = filter_configured
12811323

1324+
if filter_is_configurable is not unset:
1325+
kwargs["filter_is_configurable"] = filter_is_configurable
1326+
12821327
if filter_tags_configured is not unset:
12831328
kwargs["filter_tags_configured"] = filter_tags_configured
12841329

@@ -1300,6 +1345,12 @@ def list_tag_configurations_with_pagination(
13001345
if filter_related_assets is not unset:
13011346
kwargs["filter_related_assets"] = filter_related_assets
13021347

1348+
if include is not unset:
1349+
kwargs["include"] = include
1350+
1351+
if sort is not unset:
1352+
kwargs["sort"] = sort
1353+
13031354
if window_seconds is not unset:
13041355
kwargs["window_seconds"] = window_seconds
13051356

0 commit comments

Comments
 (0)