Skip to content

Commit 911d6bd

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
andauthored
Regenerate client from commit b5e5ace of spec repo (#3239)
Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>
1 parent 4e5d87c commit 911d6bd

18 files changed

+389
-38
lines changed

.generator/schemas/v1/openapi.yaml

Lines changed: 33 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -4608,10 +4608,11 @@ components:
46084608
type: array
46094609
type: object
46104610
HourlyUsageAttributionUsageType:
4611-
description: 'Supported products for hourly usage attribution requests.
4611+
description: 'Supported products for hourly usage attribution requests. Usage
4612+
types are in the format `<usage_type>_usage`.
46124613

4613-
The following values have been **deprecated**: `estimated_indexed_spans_usage`,
4614-
`estimated_ingested_spans_usage`.'
4614+
To obtain the complete list of valid usage types, make a request to the [Get
4615+
usage attribution types API](https://docs.datadoghq.com/api/latest/usage-metering/#get-usage-attribution-types).'
46154616
enum:
46164617
- api_usage
46174618
- apm_fargate_usage
@@ -9161,7 +9162,11 @@ components:
91619162
type: array
91629163
type: object
91639164
MonthlyUsageAttributionSupportedMetrics:
9164-
description: Supported metrics for monthly usage attribution requests.
9165+
description: 'Supported metrics for monthly usage attribution requests. Usage
9166+
types are in the format `<usage_type>_usage`.
9167+
9168+
To obtain the complete list of valid usage types, make a request to the [Get
9169+
usage attribution types API](https://docs.datadoghq.com/api/latest/usage-metering/#get-usage-attribution-types).'
91659170
enum:
91669171
- api_usage
91679172
- api_percentage
@@ -9492,10 +9497,7 @@ components:
94929497
- SCA_FARGATE_PERCENTAGE
94939498
- ALL
94949499
MonthlyUsageAttributionValues:
9495-
description: 'Fields in Usage Summary by tag(s).
9496-
9497-
The following values have been **deprecated**: `estimated_indexed_spans_usage`,
9498-
`estimated_indexed_spans_percentage`, `estimated_ingested_spans_usage`, `estimated_ingested_spans_percentage`.'
9500+
description: Fields in Usage Summary by tag(s).
94999501
properties:
95009502
api_percentage:
95019503
description: The percentage of synthetic API test usage by tag(s).
@@ -37493,10 +37495,7 @@ paths:
3749337495
code example:\n\n```\nresponse := GetHourlyUsageAttribution(start_month)\ncursor
3749437496
:= response.metadata.pagination.next_record_id\nWHILE cursor != null BEGIN\n
3749537497
\ sleep(5 seconds) # Avoid running into rate limit\n response := GetHourlyUsageAttribution(start_month,
37496-
next_record_id=cursor)\n cursor := response.metadata.pagination.next_record_id\nEND\n```\nThe
37497-
following values have been **deprecated**:\n `estimated_indexed_spans_usage`,
37498-
`estimated_indexed_spans_percentage`, `estimated_ingested_spans_usage`, `estimated_ingested_spans_percentage`,
37499-
`llm_observability_usage`, `llm_observability_percentage`."
37498+
next_record_id=cursor)\n cursor := response.metadata.pagination.next_record_id\nEND\n```"
3750037499
operationId: GetHourlyUsageAttribution
3750137500
parameters:
3750237501
- description: 'Datetime in ISO-8601 format, UTC, precise to hour: `[YYYY-MM-DDThh]`
@@ -37517,9 +37516,14 @@ paths:
3751737516
schema:
3751837517
format: date-time
3751937518
type: string
37520-
- description: 'Usage type to retrieve. The following values have been **deprecated**:
37519+
- description: 'Usage type to retrieve. Usage types are in the format `<usage_type>_usage`.
37520+
37521+
Example: `infra_host_usage`
3752137522

37522-
`estimated_indexed_spans_usage`, `estimated_ingested_spans_usage`.'
37523+
To obtain the complete list of active usage types that can be used to replace
37524+
37525+
`<usage_type>` in the field names, make a request to the [Get usage attribution
37526+
types API](https://docs.datadoghq.com/api/latest/usage-metering/#get-usage-attribution-types).'
3752337527
in: query
3752437528
name: usage_type
3752537529
required: true
@@ -38072,10 +38076,15 @@ paths:
3807238076
- description: 'Comma-separated list of usage types to return, or `*` for all
3807338077
usage types.
3807438078

38075-
The following values have been **deprecated**:
38079+
Usage types are in the format `<usage_type>_usage` and `<usage_type>_percentage`.
38080+
38081+
Example: `infra_host_usage,infra_host_percentage`
3807638082

38077-
`estimated_indexed_spans_usage`, `estimated_indexed_spans_percentage`, `estimated_ingested_spans_usage`,
38078-
`estimated_ingested_spans_percentage`, `llm_observability_usage`, `llm_observability_percentage`.'
38083+
To obtain the complete list of usage attribution types that can be used
38084+
to replace
38085+
38086+
`<usage_type>` in the field names, make a request to the [Get usage attribution
38087+
types API](https://docs.datadoghq.com/api/latest/usage-metering/#get-usage-attribution-types).'
3807938088
in: query
3808038089
name: fields
3808138090
required: true
@@ -38087,12 +38096,15 @@ paths:
3808738096
required: false
3808838097
schema:
3808938098
$ref: '#/components/schemas/UsageSortDirection'
38090-
- description: 'The field to sort by.
38099+
- description: 'The field to sort by. Sort fields are in the format `<usage_type>_usage`.
38100+
38101+
Example: `infra_host_usage`
3809138102

38092-
The following values have been **deprecated**:
38103+
To obtain the complete list of usage attribution types that can be used
38104+
to replace
3809338105

38094-
`estimated_indexed_spans_usage`, `estimated_indexed_spans_percentage`, `estimated_ingested_spans_usage`,
38095-
`estimated_ingested_spans_percentage`.'
38106+
`<usage_type>` in the field names, make a request to the [Get usage attribution
38107+
types API](https://docs.datadoghq.com/api/latest/usage-metering/#get-usage-attribution-types).'
3809638108
in: query
3809738109
name: sort_name
3809838110
required: false

.generator/schemas/v2/openapi.yaml

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70690,6 +70690,42 @@ components:
7069070690
usage_type:
7069170691
$ref: '#/components/schemas/HourlyUsageType'
7069270692
type: object
70693+
UsageAttributionTypesAttributes:
70694+
description: List of usage attribution types.
70695+
properties:
70696+
values:
70697+
description: List of usage attribution types.
70698+
items:
70699+
description: A given usage type in a list.
70700+
example: infra_host
70701+
type: string
70702+
type: array
70703+
type: object
70704+
UsageAttributionTypesBody:
70705+
description: Usage attribution types data.
70706+
properties:
70707+
attributes:
70708+
$ref: '#/components/schemas/UsageAttributionTypesAttributes'
70709+
id:
70710+
description: Unique ID of the response.
70711+
type: string
70712+
type:
70713+
$ref: '#/components/schemas/UsageAttributionTypesType'
70714+
type: object
70715+
UsageAttributionTypesResponse:
70716+
description: Usage attribution types response.
70717+
properties:
70718+
data:
70719+
$ref: '#/components/schemas/UsageAttributionTypesBody'
70720+
type: object
70721+
UsageAttributionTypesType:
70722+
default: usage_attribution_types
70723+
description: Type of usage attribution types data.
70724+
enum:
70725+
- usage_attribution_types
70726+
type: string
70727+
x-enum-varnames:
70728+
- USAGE_ATTRIBUTION_TYPES
7069370729
UsageDataObject:
7069470730
description: Usage data.
7069570731
properties:
@@ -109764,6 +109800,41 @@ paths:
109764109800
permissions:
109765109801
- usage_read
109766109802
- billing_read
109803+
/api/v2/usage/usage-attribution-types:
109804+
get:
109805+
description: Get usage attribution types.
109806+
operationId: GetUsageAttributionTypes
109807+
responses:
109808+
'200':
109809+
content:
109810+
application/json;datetime-format=rfc3339:
109811+
schema:
109812+
$ref: '#/components/schemas/UsageAttributionTypesResponse'
109813+
description: OK
109814+
'403':
109815+
content:
109816+
application/json;datetime-format=rfc3339:
109817+
schema:
109818+
$ref: '#/components/schemas/APIErrorResponse'
109819+
description: Forbidden - User is not authorized
109820+
'429':
109821+
content:
109822+
application/json;datetime-format=rfc3339:
109823+
schema:
109824+
$ref: '#/components/schemas/APIErrorResponse'
109825+
description: Too many requests
109826+
security:
109827+
- apiKeyAuth: []
109828+
appKeyAuth: []
109829+
- AuthZ:
109830+
- usage_read
109831+
summary: Get usage attribution types
109832+
tags:
109833+
- Usage Metering
109834+
x-permission:
109835+
operator: OR
109836+
permissions:
109837+
- usage_read
109767109838
/api/v2/user_invitations:
109768109839
post:
109769109840
description: Sends emails to one or more users inviting them to join the organization.

docs/datadog_api_client.v2.model.rst

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31077,6 +31077,34 @@ datadog\_api\_client.v2.model.usage\_attributes\_object module
3107731077
:members:
3107831078
:show-inheritance:
3107931079

31080+
datadog\_api\_client.v2.model.usage\_attribution\_types\_attributes module
31081+
--------------------------------------------------------------------------
31082+
31083+
.. automodule:: datadog_api_client.v2.model.usage_attribution_types_attributes
31084+
:members:
31085+
:show-inheritance:
31086+
31087+
datadog\_api\_client.v2.model.usage\_attribution\_types\_body module
31088+
--------------------------------------------------------------------
31089+
31090+
.. automodule:: datadog_api_client.v2.model.usage_attribution_types_body
31091+
:members:
31092+
:show-inheritance:
31093+
31094+
datadog\_api\_client.v2.model.usage\_attribution\_types\_response module
31095+
------------------------------------------------------------------------
31096+
31097+
.. automodule:: datadog_api_client.v2.model.usage_attribution_types_response
31098+
:members:
31099+
:show-inheritance:
31100+
31101+
datadog\_api\_client.v2.model.usage\_attribution\_types\_type module
31102+
--------------------------------------------------------------------
31103+
31104+
.. automodule:: datadog_api_client.v2.model.usage_attribution_types_type
31105+
:members:
31106+
:show-inheritance:
31107+
3108031108
datadog\_api\_client.v2.model.usage\_data\_object module
3108131109
--------------------------------------------------------
3108231110

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
"""
2+
Get usage attribution types returns "OK" response
3+
"""
4+
5+
from datadog_api_client import ApiClient, Configuration
6+
from datadog_api_client.v2.api.usage_metering_api import UsageMeteringApi
7+
8+
configuration = Configuration()
9+
with ApiClient(configuration) as api_client:
10+
api_instance = UsageMeteringApi(api_client)
11+
response = api_instance.get_usage_attribution_types()
12+
13+
print(response)

src/datadog_api_client/v1/api/usage_metering_api.py

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1280,13 +1280,12 @@ def get_hourly_usage_attribution(
12801280
cursor := response.metadata.pagination.next_record_id
12811281
END
12821282
1283-
The following values have been **deprecated** :
1284-
``estimated_indexed_spans_usage`` , ``estimated_indexed_spans_percentage`` , ``estimated_ingested_spans_usage`` , ``estimated_ingested_spans_percentage`` , ``llm_observability_usage`` , ``llm_observability_percentage``.
1285-
12861283
:param start_hr: Datetime in ISO-8601 format, UTC, precise to hour: ``[YYYY-MM-DDThh]`` for usage beginning at this hour.
12871284
:type start_hr: datetime
1288-
:param usage_type: Usage type to retrieve. The following values have been **deprecated** :
1289-
``estimated_indexed_spans_usage`` , ``estimated_ingested_spans_usage``.
1285+
:param usage_type: Usage type to retrieve. Usage types are in the format ``<usage_type>_usage``.
1286+
Example: ``infra_host_usage``
1287+
To obtain the complete list of active usage types that can be used to replace
1288+
``<usage_type>`` in the field names, make a request to the `Get usage attribution types API <https://docs.datadoghq.com/api/latest/usage-metering/#get-usage-attribution-types>`_.
12901289
:type usage_type: HourlyUsageAttributionUsageType
12911290
:param end_hr: Datetime in ISO-8601 format, UTC, precise to hour: ``[YYYY-MM-DDThh]`` for usage ending
12921291
**before** this hour.
@@ -1448,16 +1447,19 @@ def get_monthly_usage_attribution(
14481447
Maximum of 15 months ago.
14491448
:type start_month: datetime
14501449
:param fields: Comma-separated list of usage types to return, or ``*`` for all usage types.
1451-
The following values have been **deprecated** :
1452-
``estimated_indexed_spans_usage`` , ``estimated_indexed_spans_percentage`` , ``estimated_ingested_spans_usage`` , ``estimated_ingested_spans_percentage`` , ``llm_observability_usage`` , ``llm_observability_percentage``.
1450+
Usage types are in the format ``<usage_type>_usage`` and ``<usage_type>_percentage``.
1451+
Example: ``infra_host_usage,infra_host_percentage``
1452+
To obtain the complete list of usage attribution types that can be used to replace
1453+
``<usage_type>`` in the field names, make a request to the `Get usage attribution types API <https://docs.datadoghq.com/api/latest/usage-metering/#get-usage-attribution-types>`_.
14531454
:type fields: MonthlyUsageAttributionSupportedMetrics
14541455
:param end_month: Datetime in ISO-8601 format, UTC, precise to month: ``[YYYY-MM]`` for usage ending this month.
14551456
:type end_month: datetime, optional
14561457
:param sort_direction: The direction to sort by: ``[desc, asc]``.
14571458
:type sort_direction: UsageSortDirection, optional
1458-
:param sort_name: The field to sort by.
1459-
The following values have been **deprecated** :
1460-
``estimated_indexed_spans_usage`` , ``estimated_indexed_spans_percentage`` , ``estimated_ingested_spans_usage`` , ``estimated_ingested_spans_percentage``.
1459+
:param sort_name: The field to sort by. Sort fields are in the format ``<usage_type>_usage``.
1460+
Example: ``infra_host_usage``
1461+
To obtain the complete list of usage attribution types that can be used to replace
1462+
``<usage_type>`` in the field names, make a request to the `Get usage attribution types API <https://docs.datadoghq.com/api/latest/usage-metering/#get-usage-attribution-types>`_.
14611463
:type sort_name: MonthlyUsageAttributionSupportedMetrics, optional
14621464
:param tag_breakdown_keys: Comma separated list of tag keys used to group usage. If no value is provided the usage will not be broken down by tags.
14631465

src/datadog_api_client/v1/model/hourly_usage_attribution_body.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -94,8 +94,8 @@ def __init__(
9494
:param updated_at: Shows the most recent hour in the current month for all organizations where usages are calculated.
9595
:type updated_at: str, optional
9696
97-
:param usage_type: Supported products for hourly usage attribution requests.
98-
The following values have been **deprecated** : ``estimated_indexed_spans_usage`` , ``estimated_ingested_spans_usage``.
97+
:param usage_type: Supported products for hourly usage attribution requests. Usage types are in the format ``<usage_type>_usage``.
98+
To obtain the complete list of valid usage types, make a request to the `Get usage attribution types API <https://docs.datadoghq.com/api/latest/usage-metering/#get-usage-attribution-types>`_.
9999
:type usage_type: HourlyUsageAttributionUsageType, optional
100100
"""
101101
if hour is not unset:

src/datadog_api_client/v1/model/hourly_usage_attribution_usage_type.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,8 @@
1414

1515
class HourlyUsageAttributionUsageType(ModelSimple):
1616
"""
17-
Supported products for hourly usage attribution requests.
18-
The following values have been **deprecated**: `estimated_indexed_spans_usage`, `estimated_ingested_spans_usage`.
17+
Supported products for hourly usage attribution requests. Usage types are in the format `<usage_type>_usage`.
18+
To obtain the complete list of valid usage types, make a request to the [Get usage attribution types API](https://docs.datadoghq.com/api/latest/usage-metering/#get-usage-attribution-types).
1919
2020
:param value: Must be one of ["api_usage", "apm_fargate_usage", "apm_host_usage", "apm_usm_usage", "appsec_fargate_usage", "appsec_usage", "asm_serverless_traced_invocations_usage", "asm_serverless_traced_invocations_percentage", "bits_ai_investigations_usage", "browser_usage", "ci_pipeline_indexed_spans_usage", "ci_test_indexed_spans_usage", "ci_visibility_itr_usage", "cloud_siem_usage", "code_security_host_usage", "container_excl_agent_usage", "container_usage", "cspm_containers_usage", "cspm_hosts_usage", "custom_event_usage", "custom_ingested_timeseries_usage", "custom_timeseries_usage", "cws_containers_usage", "cws_fargate_task_usage", "cws_hosts_usage", "data_jobs_monitoring_usage", "data_stream_monitoring_usage", "dbm_hosts_usage", "dbm_queries_usage", "error_tracking_usage", "error_tracking_percentage", "estimated_indexed_spans_usage", "estimated_ingested_spans_usage", "fargate_usage", "flex_logs_starter", "flex_stored_logs", "functions_usage", "incident_management_monthly_active_users_usage", "indexed_spans_usage", "infra_host_usage", "ingested_logs_bytes_usage", "ingested_spans_bytes_usage", "invocations_usage", "lambda_traced_invocations_usage", "llm_observability_usage", "llm_spans_usage", "logs_indexed_15day_usage", "logs_indexed_180day_usage", "logs_indexed_1day_usage", "logs_indexed_30day_usage", "logs_indexed_360day_usage", "logs_indexed_3day_usage", "logs_indexed_45day_usage", "logs_indexed_60day_usage", "logs_indexed_7day_usage", "logs_indexed_90day_usage", "logs_indexed_custom_retention_usage", "mobile_app_testing_usage", "ndm_netflow_usage", "npm_host_usage", "network_device_wireless_usage", "obs_pipeline_bytes_usage", "obs_pipelines_vcpu_usage", "online_archive_usage", "product_analytics_session_usage", "profiled_container_usage", "profiled_fargate_usage", "profiled_host_usage", "published_app", "rum_browser_mobile_sessions_usage", "rum_ingested_usage", "rum_investigate_usage", "rum_replay_sessions_usage", "rum_session_replay_add_on_usage", "sca_fargate_usage", "sds_scanned_bytes_usage", "serverless_apps_usage", "siem_analyzed_logs_add_on_usage", "siem_ingested_bytes_usage", "snmp_usage", "universal_service_monitoring_usage", "vuln_management_hosts_usage", "workflow_executions_usage"].
2121
:type value: str

src/datadog_api_client/v1/model/monthly_usage_attribution_body.py

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,6 @@ def __init__(
8989
:type updated_at: datetime, optional
9090
9191
:param values: Fields in Usage Summary by tag(s).
92-
The following values have been **deprecated** : ``estimated_indexed_spans_usage`` , ``estimated_indexed_spans_percentage`` , ``estimated_ingested_spans_usage`` , ``estimated_ingested_spans_percentage``.
9392
:type values: MonthlyUsageAttributionValues, optional
9493
"""
9594
if month is not unset:

0 commit comments

Comments
 (0)