Skip to content

Commit ea3b888

Browse files
author
ci.datadog-api-spec
committed
Regenerate client from commit 9430d06 of spec repo
1 parent b7f080f commit ea3b888

15 files changed

+445
-16
lines changed

‎.generator/schemas/v1/openapi.yaml‎

Lines changed: 34 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2962,10 +2962,7 @@ components:
29622962
data_source:
29632963
$ref: '#/components/schemas/FormulaAndFunctionEventsDataSource'
29642964
group_by:
2965-
description: Group by options.
2966-
items:
2967-
$ref: '#/components/schemas/FormulaAndFunctionEventQueryGroupBy'
2968-
type: array
2965+
$ref: '#/components/schemas/FormulaAndFunctionEventQueryGroupByConfig'
29692966
indexes:
29702967
description: An array of index names to query in the stream. Omit or use
29712968
`[]` to query all indexes at once.
@@ -3037,6 +3034,39 @@ components:
30373034
required:
30383035
- facet
30393036
type: object
3037+
FormulaAndFunctionEventQueryGroupByConfig:
3038+
description: Group by configuration for a formula and functions events query.
3039+
Can be a list of facet objects or a flat object with a list of fields.
3040+
oneOf:
3041+
- $ref: '#/components/schemas/FormulaAndFunctionEventQueryGroupByList'
3042+
- $ref: '#/components/schemas/FormulaAndFunctionEventQueryGroupByFields'
3043+
FormulaAndFunctionEventQueryGroupByFields:
3044+
description: Flat group by using multiple event facets.
3045+
properties:
3046+
fields:
3047+
description: List of event facets to group by.
3048+
example:
3049+
- hostname
3050+
- service
3051+
items:
3052+
description: Event facet.
3053+
type: string
3054+
type: array
3055+
limit:
3056+
description: Number of groups to return.
3057+
example: 10
3058+
format: int64
3059+
type: integer
3060+
sort:
3061+
$ref: '#/components/schemas/FormulaAndFunctionEventQueryGroupBySort'
3062+
required:
3063+
- fields
3064+
type: object
3065+
FormulaAndFunctionEventQueryGroupByList:
3066+
description: List of objects used to group by.
3067+
items:
3068+
$ref: '#/components/schemas/FormulaAndFunctionEventQueryGroupBy'
3069+
type: array
30403070
FormulaAndFunctionEventQueryGroupBySort:
30413071
description: Options for sorting group by results.
30423072
properties:

‎docs/datadog_api_client.v1.model.rst‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -928,6 +928,20 @@ datadog\_api\_client.v1.model.formula\_and\_function\_event\_query\_group\_by mo
928928
:members:
929929
:show-inheritance:
930930

931+
datadog\_api\_client.v1.model.formula\_and\_function\_event\_query\_group\_by\_config module
932+
--------------------------------------------------------------------------------------------
933+
934+
.. automodule:: datadog_api_client.v1.model.formula_and_function_event_query_group_by_config
935+
:members:
936+
:show-inheritance:
937+
938+
datadog\_api\_client.v1.model.formula\_and\_function\_event\_query\_group\_by\_fields module
939+
--------------------------------------------------------------------------------------------
940+
941+
.. automodule:: datadog_api_client.v1.model.formula_and_function_event_query_group_by_fields
942+
:members:
943+
:show-inheritance:
944+
931945
datadog\_api\_client.v1.model.formula\_and\_function\_event\_query\_group\_by\_sort module
932946
------------------------------------------------------------------------------------------
933947

‎examples/v1/dashboards/CreateDashboard_4018282928.py‎

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
"""
2+
Create a new dashboard with formulas and functions events query using flat group by fields
3+
"""
4+
5+
from datadog_api_client import ApiClient, Configuration
6+
from datadog_api_client.v1.api.dashboards_api import DashboardsApi
7+
from datadog_api_client.v1.model.dashboard import Dashboard
8+
from datadog_api_client.v1.model.dashboard_layout_type import DashboardLayoutType
9+
from datadog_api_client.v1.model.formula_and_function_event_aggregation import FormulaAndFunctionEventAggregation
10+
from datadog_api_client.v1.model.formula_and_function_event_query_definition import (
11+
FormulaAndFunctionEventQueryDefinition,
12+
)
13+
from datadog_api_client.v1.model.formula_and_function_event_query_definition_compute import (
14+
FormulaAndFunctionEventQueryDefinitionCompute,
15+
)
16+
from datadog_api_client.v1.model.formula_and_function_event_query_definition_search import (
17+
FormulaAndFunctionEventQueryDefinitionSearch,
18+
)
19+
from datadog_api_client.v1.model.formula_and_function_event_query_group_by_fields import (
20+
FormulaAndFunctionEventQueryGroupByFields,
21+
)
22+
from datadog_api_client.v1.model.formula_and_function_events_data_source import FormulaAndFunctionEventsDataSource
23+
from datadog_api_client.v1.model.formula_and_function_response_format import FormulaAndFunctionResponseFormat
24+
from datadog_api_client.v1.model.timeseries_widget_definition import TimeseriesWidgetDefinition
25+
from datadog_api_client.v1.model.timeseries_widget_definition_type import TimeseriesWidgetDefinitionType
26+
from datadog_api_client.v1.model.timeseries_widget_request import TimeseriesWidgetRequest
27+
from datadog_api_client.v1.model.widget import Widget
28+
from datadog_api_client.v1.model.widget_layout import WidgetLayout
29+
30+
body = Dashboard(
31+
title="Example-Dashboard with events flat group_by fields",
32+
widgets=[
33+
Widget(
34+
definition=TimeseriesWidgetDefinition(
35+
type=TimeseriesWidgetDefinitionType.TIMESERIES,
36+
requests=[
37+
TimeseriesWidgetRequest(
38+
response_format=FormulaAndFunctionResponseFormat.TIMESERIES,
39+
queries=[
40+
FormulaAndFunctionEventQueryDefinition(
41+
data_source=FormulaAndFunctionEventsDataSource.EVENTS,
42+
name="query1",
43+
search=FormulaAndFunctionEventQueryDefinitionSearch(
44+
query="",
45+
),
46+
compute=FormulaAndFunctionEventQueryDefinitionCompute(
47+
aggregation=FormulaAndFunctionEventAggregation.COUNT,
48+
),
49+
group_by=FormulaAndFunctionEventQueryGroupByFields(
50+
fields=[
51+
"service",
52+
"host",
53+
],
54+
limit=10,
55+
),
56+
),
57+
],
58+
),
59+
],
60+
),
61+
layout=WidgetLayout(
62+
x=0,
63+
y=0,
64+
width=4,
65+
height=2,
66+
),
67+
),
68+
],
69+
layout_type=DashboardLayoutType.ORDERED,
70+
)
71+
72+
configuration = Configuration()
73+
with ApiClient(configuration) as api_client:
74+
api_instance = DashboardsApi(api_client)
75+
response = api_instance.create_dashboard(body=body)
76+
77+
print(response)

‎examples/v1/dashboards/CreateDashboard_732700533.py‎

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
"""
2+
Create a new dashboard with formulas and functions events query using facet group by
3+
"""
4+
5+
from datadog_api_client import ApiClient, Configuration
6+
from datadog_api_client.v1.api.dashboards_api import DashboardsApi
7+
from datadog_api_client.v1.model.dashboard import Dashboard
8+
from datadog_api_client.v1.model.dashboard_layout_type import DashboardLayoutType
9+
from datadog_api_client.v1.model.formula_and_function_event_aggregation import FormulaAndFunctionEventAggregation
10+
from datadog_api_client.v1.model.formula_and_function_event_query_definition import (
11+
FormulaAndFunctionEventQueryDefinition,
12+
)
13+
from datadog_api_client.v1.model.formula_and_function_event_query_definition_compute import (
14+
FormulaAndFunctionEventQueryDefinitionCompute,
15+
)
16+
from datadog_api_client.v1.model.formula_and_function_event_query_definition_search import (
17+
FormulaAndFunctionEventQueryDefinitionSearch,
18+
)
19+
from datadog_api_client.v1.model.formula_and_function_event_query_group_by import FormulaAndFunctionEventQueryGroupBy
20+
from datadog_api_client.v1.model.formula_and_function_events_data_source import FormulaAndFunctionEventsDataSource
21+
from datadog_api_client.v1.model.formula_and_function_response_format import FormulaAndFunctionResponseFormat
22+
from datadog_api_client.v1.model.timeseries_widget_definition import TimeseriesWidgetDefinition
23+
from datadog_api_client.v1.model.timeseries_widget_definition_type import TimeseriesWidgetDefinitionType
24+
from datadog_api_client.v1.model.timeseries_widget_request import TimeseriesWidgetRequest
25+
from datadog_api_client.v1.model.widget import Widget
26+
from datadog_api_client.v1.model.widget_layout import WidgetLayout
27+
28+
body = Dashboard(
29+
title="Example-Dashboard with events facet group_by",
30+
widgets=[
31+
Widget(
32+
definition=TimeseriesWidgetDefinition(
33+
type=TimeseriesWidgetDefinitionType.TIMESERIES,
34+
requests=[
35+
TimeseriesWidgetRequest(
36+
response_format=FormulaAndFunctionResponseFormat.TIMESERIES,
37+
queries=[
38+
FormulaAndFunctionEventQueryDefinition(
39+
data_source=FormulaAndFunctionEventsDataSource.EVENTS,
40+
name="query1",
41+
search=FormulaAndFunctionEventQueryDefinitionSearch(
42+
query="",
43+
),
44+
compute=FormulaAndFunctionEventQueryDefinitionCompute(
45+
aggregation=FormulaAndFunctionEventAggregation.COUNT,
46+
),
47+
group_by=[
48+
FormulaAndFunctionEventQueryGroupBy(
49+
facet="service",
50+
limit=10,
51+
),
52+
],
53+
),
54+
],
55+
),
56+
],
57+
),
58+
layout=WidgetLayout(
59+
x=0,
60+
y=0,
61+
width=4,
62+
height=2,
63+
),
64+
),
65+
],
66+
layout_type=DashboardLayoutType.ORDERED,
67+
)
68+
69+
configuration = Configuration()
70+
with ApiClient(configuration) as api_client:
71+
api_instance = DashboardsApi(api_client)
72+
response = api_instance.create_dashboard(body=body)
73+
74+
print(response)

‎src/datadog_api_client/v1/model/distribution_widget_histogram_request_query.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,8 @@ def __init__(self, **kwargs):
3636
:param compute: Compute options.
3737
:type compute: FormulaAndFunctionEventQueryDefinitionCompute
3838
39-
:param group_by: Group by options.
40-
:type group_by: [FormulaAndFunctionEventQueryGroupBy], optional
39+
:param group_by: Group by configuration for a formula and functions events query. Can be a list of facet objects or a flat object with a list of fields.
40+
:type group_by: FormulaAndFunctionEventQueryGroupByConfig, optional
4141
4242
:param indexes: An array of index names to query in the stream. Omit or use `[]` to query all indexes at once.
4343
:type indexes: [str], optional

‎src/datadog_api_client/v1/model/formula_and_function_event_query_definition.py‎

Lines changed: 19 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -18,12 +18,18 @@
1818
FormulaAndFunctionEventQueryDefinitionCompute,
1919
)
2020
from datadog_api_client.v1.model.formula_and_function_events_data_source import FormulaAndFunctionEventsDataSource
21-
from datadog_api_client.v1.model.formula_and_function_event_query_group_by import (
22-
FormulaAndFunctionEventQueryGroupBy,
21+
from datadog_api_client.v1.model.formula_and_function_event_query_group_by_config import (
22+
FormulaAndFunctionEventQueryGroupByConfig,
2323
)
2424
from datadog_api_client.v1.model.formula_and_function_event_query_definition_search import (
2525
FormulaAndFunctionEventQueryDefinitionSearch,
2626
)
27+
from datadog_api_client.v1.model.formula_and_function_event_query_group_by import (
28+
FormulaAndFunctionEventQueryGroupBy,
29+
)
30+
from datadog_api_client.v1.model.formula_and_function_event_query_group_by_fields import (
31+
FormulaAndFunctionEventQueryGroupByFields,
32+
)
2733

2834

2935
class FormulaAndFunctionEventQueryDefinition(ModelNormal):
@@ -41,8 +47,8 @@ def openapi_types(_):
4147
from datadog_api_client.v1.model.formula_and_function_events_data_source import (
4248
FormulaAndFunctionEventsDataSource,
4349
)
44-
from datadog_api_client.v1.model.formula_and_function_event_query_group_by import (
45-
FormulaAndFunctionEventQueryGroupBy,
50+
from datadog_api_client.v1.model.formula_and_function_event_query_group_by_config import (
51+
FormulaAndFunctionEventQueryGroupByConfig,
4652
)
4753
from datadog_api_client.v1.model.formula_and_function_event_query_definition_search import (
4854
FormulaAndFunctionEventQueryDefinitionSearch,
@@ -52,7 +58,7 @@ def openapi_types(_):
5258
"compute": (FormulaAndFunctionEventQueryDefinitionCompute,),
5359
"cross_org_uuids": ([str],),
5460
"data_source": (FormulaAndFunctionEventsDataSource,),
55-
"group_by": ([FormulaAndFunctionEventQueryGroupBy],),
61+
"group_by": (FormulaAndFunctionEventQueryGroupByConfig,),
5662
"indexes": ([str],),
5763
"name": (str,),
5864
"search": (FormulaAndFunctionEventQueryDefinitionSearch,),
@@ -76,7 +82,12 @@ def __init__(
7682
data_source: FormulaAndFunctionEventsDataSource,
7783
name: str,
7884
cross_org_uuids: Union[List[str], UnsetType] = unset,
79-
group_by: Union[List[FormulaAndFunctionEventQueryGroupBy], UnsetType] = unset,
85+
group_by: Union[
86+
FormulaAndFunctionEventQueryGroupByConfig,
87+
List[FormulaAndFunctionEventQueryGroupBy],
88+
FormulaAndFunctionEventQueryGroupByFields,
89+
UnsetType,
90+
] = unset,
8091
indexes: Union[List[str], UnsetType] = unset,
8192
search: Union[FormulaAndFunctionEventQueryDefinitionSearch, UnsetType] = unset,
8293
storage: Union[str, UnsetType] = unset,
@@ -94,8 +105,8 @@ def __init__(
94105
:param data_source: Data source for event platform-based queries.
95106
:type data_source: FormulaAndFunctionEventsDataSource
96107
97-
:param group_by: Group by options.
98-
:type group_by: [FormulaAndFunctionEventQueryGroupBy], optional
108+
:param group_by: Group by configuration for a formula and functions events query. Can be a list of facet objects or a flat object with a list of fields.
109+
:type group_by: FormulaAndFunctionEventQueryGroupByConfig, optional
99110
100111
:param indexes: An array of index names to query in the stream. Omit or use ``[]`` to query all indexes at once.
101112
:type indexes: [str], optional

‎src/datadog_api_client/v1/model/formula_and_function_event_query_group_by_config.py‎

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
# Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License.
2+
# This product includes software developed at Datadog (https://www.datadoghq.com/).
3+
# Copyright 2019-Present Datadog, Inc.
4+
from __future__ import annotations
5+
6+
7+
from datadog_api_client.model_utils import (
8+
ModelComposed,
9+
cached_property,
10+
)
11+
12+
13+
class FormulaAndFunctionEventQueryGroupByConfig(ModelComposed):
14+
def __init__(self, **kwargs):
15+
"""
16+
Group by configuration for a formula and functions events query. Can be a list of facet objects or a flat object with a list of fields.
17+
18+
:param fields: List of event facets to group by.
19+
:type fields: [str]
20+
21+
:param limit: Number of groups to return.
22+
:type limit: int, optional
23+
24+
:param sort: Options for sorting group by results.
25+
:type sort: FormulaAndFunctionEventQueryGroupBySort, optional
26+
"""
27+
super().__init__(kwargs)
28+
29+
@cached_property
30+
def _composed_schemas(_):
31+
# we need this here to make our import statements work
32+
# we must store _composed_schemas in here so the code is only run
33+
# when we invoke this method. If we kept this at the class
34+
# level we would get an error because the class level
35+
# code would be run when this module is imported, and these composed
36+
# classes don't exist yet because their module has not finished
37+
# loading
38+
from datadog_api_client.v1.model.formula_and_function_event_query_group_by import (
39+
FormulaAndFunctionEventQueryGroupBy,
40+
)
41+
from datadog_api_client.v1.model.formula_and_function_event_query_group_by_fields import (
42+
FormulaAndFunctionEventQueryGroupByFields,
43+
)
44+
45+
return {
46+
"oneOf": [
47+
[FormulaAndFunctionEventQueryGroupBy],
48+
FormulaAndFunctionEventQueryGroupByFields,
49+
],
50+
}

0 commit comments

Comments
 (0)