Skip to content

Commit 50dc52d

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
api-clients-generation-pipeline[bot]
and
ci.datadog-api-spec
authored
Add support for geomap widget using response_type event_list (#1534)
Co-authored-by: ci.datadog-api-spec <[email protected]>
1 parent 8788749 commit 50dc52d

16 files changed

+202
-16
lines changed

‎.apigentools-info

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@
44
"spec_versions": {
55
"v1": {
66
"apigentools_version": "1.6.4",
7-
"regenerated": "2023-06-28 13:29:53.237675",
8-
"spec_repo_commit": "042157e1"
7+
"regenerated": "2023-06-28 20:35:54.929673",
8+
"spec_repo_commit": "e0f0af3f"
99
},
1010
"v2": {
1111
"apigentools_version": "1.6.4",
12-
"regenerated": "2023-06-28 13:29:53.250399",
13-
"spec_repo_commit": "042157e1"
12+
"regenerated": "2023-06-28 20:35:54.954768",
13+
"spec_repo_commit": "e0f0af3f"
1414
}
1515
}
1616
}

‎.generator/schemas/v1/openapi.yaml

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2731,15 +2731,18 @@ components:
27312731
- $ref: '#/components/schemas/FormulaAndFunctionSLOQueryDefinition'
27322732
type: object
27332733
FormulaAndFunctionResponseFormat:
2734-
description: Timeseries or Scalar response.
2734+
description: Timeseries, scalar, or event list response. Event list response
2735+
formats are supported by Geomap widgets.
27352736
enum:
27362737
- timeseries
27372738
- scalar
2739+
- event_list
27382740
example: timeseries
27392741
type: string
27402742
x-enum-varnames:
27412743
- TIMESERIES
27422744
- SCALAR
2745+
- EVENT_LIST
27432746
FormulaAndFunctionSLODataSource:
27442747
description: Data source for SLO measures queries.
27452748
enum:
@@ -3127,6 +3130,16 @@ components:
31273130
GeomapWidgetRequest:
31283131
description: An updated geomap widget.
31293132
properties:
3133+
columns:
3134+
description: Widget columns.
3135+
example:
3136+
- field: timestamp
3137+
width: auto
3138+
- field: content
3139+
width: full
3140+
items:
3141+
$ref: '#/components/schemas/ListStreamColumn'
3142+
type: array
31303143
formulas:
31313144
description: List of formulas that operate on queries.
31323145
items:
@@ -3142,6 +3155,8 @@ components:
31423155
items:
31433156
$ref: '#/components/schemas/FormulaAndFunctionQueryDefinition'
31443157
type: array
3158+
query:
3159+
$ref: '#/components/schemas/ListStreamQuery'
31453160
response_format:
31463161
$ref: '#/components/schemas/FormulaAndFunctionResponseFormat'
31473162
rum_query:

‎examples/v1/dashboards/CreateDashboard_3513586382.py

Lines changed: 98 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
1+
"""
2+
Create a geomap widget using an event_list request
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.dashboard_reflow_type import DashboardReflowType
10+
from datadog_api_client.v1.model.formula_and_function_response_format import FormulaAndFunctionResponseFormat
11+
from datadog_api_client.v1.model.geomap_widget_definition import GeomapWidgetDefinition
12+
from datadog_api_client.v1.model.geomap_widget_definition_style import GeomapWidgetDefinitionStyle
13+
from datadog_api_client.v1.model.geomap_widget_definition_type import GeomapWidgetDefinitionType
14+
from datadog_api_client.v1.model.geomap_widget_definition_view import GeomapWidgetDefinitionView
15+
from datadog_api_client.v1.model.geomap_widget_request import GeomapWidgetRequest
16+
from datadog_api_client.v1.model.list_stream_column import ListStreamColumn
17+
from datadog_api_client.v1.model.list_stream_column_width import ListStreamColumnWidth
18+
from datadog_api_client.v1.model.list_stream_query import ListStreamQuery
19+
from datadog_api_client.v1.model.list_stream_source import ListStreamSource
20+
from datadog_api_client.v1.model.widget import Widget
21+
from datadog_api_client.v1.model.widget_layout import WidgetLayout
22+
from datadog_api_client.v1.model.widget_text_align import WidgetTextAlign
23+
24+
body = Dashboard(
25+
title="Example-Dashboard",
26+
description="Example-Dashboard",
27+
widgets=[
28+
Widget(
29+
definition=GeomapWidgetDefinition(
30+
title="",
31+
title_size="16",
32+
title_align=WidgetTextAlign.LEFT,
33+
type=GeomapWidgetDefinitionType.GEOMAP,
34+
requests=[
35+
GeomapWidgetRequest(
36+
response_format=FormulaAndFunctionResponseFormat.EVENT_LIST,
37+
query=ListStreamQuery(
38+
data_source=ListStreamSource.LOGS_STREAM,
39+
query_string="",
40+
indexes=[],
41+
),
42+
columns=[
43+
ListStreamColumn(
44+
field="@network.client.geoip.location.latitude",
45+
width=ListStreamColumnWidth.AUTO,
46+
),
47+
ListStreamColumn(
48+
field="@network.client.geoip.location.longitude",
49+
width=ListStreamColumnWidth.AUTO,
50+
),
51+
ListStreamColumn(
52+
field="@network.client.geoip.country.iso_code",
53+
width=ListStreamColumnWidth.AUTO,
54+
),
55+
ListStreamColumn(
56+
field="@network.client.geoip.subdivision.name",
57+
width=ListStreamColumnWidth.AUTO,
58+
),
59+
ListStreamColumn(
60+
field="classic",
61+
width=ListStreamColumnWidth.AUTO,
62+
),
63+
ListStreamColumn(
64+
field="",
65+
width=ListStreamColumnWidth.AUTO,
66+
),
67+
],
68+
),
69+
],
70+
style=GeomapWidgetDefinitionStyle(
71+
palette="hostmap_blues",
72+
palette_flip=False,
73+
),
74+
view=GeomapWidgetDefinitionView(
75+
focus="WORLD",
76+
),
77+
),
78+
layout=WidgetLayout(
79+
x=0,
80+
y=0,
81+
width=12,
82+
height=6,
83+
),
84+
),
85+
],
86+
template_variables=[],
87+
layout_type=DashboardLayoutType.ORDERED,
88+
notify_list=[],
89+
reflow_type=DashboardReflowType.FIXED,
90+
tags=[],
91+
)
92+
93+
configuration = Configuration()
94+
with ApiClient(configuration) as api_client:
95+
api_instance = DashboardsApi(api_client)
96+
response = api_instance.create_dashboard(body=body)
97+
98+
print(response)

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -178,7 +178,7 @@ def __init__(
178178
:param queries: List of queries that can be returned directly or used in formulas.
179179
:type queries: [FormulaAndFunctionQueryDefinition], optional
180180
181-
:param response_format: Timeseries or Scalar response.
181+
:param response_format: Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets.
182182
:type response_format: FormulaAndFunctionResponseFormat, optional
183183
184184
:param rum_query: The log query.

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

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

1515
class FormulaAndFunctionResponseFormat(ModelSimple):
1616
"""
17-
Timeseries or Scalar response.
17+
Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets.
1818
19-
:param value: Must be one of ["timeseries", "scalar"].
19+
:param value: Must be one of ["timeseries", "scalar", "event_list"].
2020
:type value: str
2121
"""
2222

2323
allowed_values = {
2424
"timeseries",
2525
"scalar",
26+
"event_list",
2627
}
2728
TIMESERIES: ClassVar["FormulaAndFunctionResponseFormat"]
2829
SCALAR: ClassVar["FormulaAndFunctionResponseFormat"]
30+
EVENT_LIST: ClassVar["FormulaAndFunctionResponseFormat"]
2931

3032
@cached_property
3133
def openapi_types(_):
@@ -36,3 +38,4 @@ def openapi_types(_):
3638

3739
FormulaAndFunctionResponseFormat.TIMESERIES = FormulaAndFunctionResponseFormat("timeseries")
3840
FormulaAndFunctionResponseFormat.SCALAR = FormulaAndFunctionResponseFormat("scalar")
41+
FormulaAndFunctionResponseFormat.EVENT_LIST = FormulaAndFunctionResponseFormat("event_list")

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

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,11 @@
1414

1515

1616
if TYPE_CHECKING:
17+
from datadog_api_client.v1.model.list_stream_column import ListStreamColumn
1718
from datadog_api_client.v1.model.widget_formula import WidgetFormula
1819
from datadog_api_client.v1.model.log_query_definition import LogQueryDefinition
1920
from datadog_api_client.v1.model.formula_and_function_query_definition import FormulaAndFunctionQueryDefinition
21+
from datadog_api_client.v1.model.list_stream_query import ListStreamQuery
2022
from datadog_api_client.v1.model.formula_and_function_response_format import FormulaAndFunctionResponseFormat
2123
from datadog_api_client.v1.model.formula_and_function_metric_query_definition import (
2224
FormulaAndFunctionMetricQueryDefinition,
@@ -41,33 +43,40 @@
4143
class GeomapWidgetRequest(ModelNormal):
4244
@cached_property
4345
def openapi_types(_):
46+
from datadog_api_client.v1.model.list_stream_column import ListStreamColumn
4447
from datadog_api_client.v1.model.widget_formula import WidgetFormula
4548
from datadog_api_client.v1.model.log_query_definition import LogQueryDefinition
4649
from datadog_api_client.v1.model.formula_and_function_query_definition import FormulaAndFunctionQueryDefinition
50+
from datadog_api_client.v1.model.list_stream_query import ListStreamQuery
4751
from datadog_api_client.v1.model.formula_and_function_response_format import FormulaAndFunctionResponseFormat
4852

4953
return {
54+
"columns": ([ListStreamColumn],),
5055
"formulas": ([WidgetFormula],),
5156
"log_query": (LogQueryDefinition,),
5257
"q": (str,),
5358
"queries": ([FormulaAndFunctionQueryDefinition],),
59+
"query": (ListStreamQuery,),
5460
"response_format": (FormulaAndFunctionResponseFormat,),
5561
"rum_query": (LogQueryDefinition,),
5662
"security_query": (LogQueryDefinition,),
5763
}
5864

5965
attribute_map = {
66+
"columns": "columns",
6067
"formulas": "formulas",
6168
"log_query": "log_query",
6269
"q": "q",
6370
"queries": "queries",
71+
"query": "query",
6472
"response_format": "response_format",
6573
"rum_query": "rum_query",
6674
"security_query": "security_query",
6775
}
6876

6977
def __init__(
7078
self_,
79+
columns: Union[List[ListStreamColumn], UnsetType] = unset,
7180
formulas: Union[List[WidgetFormula], UnsetType] = unset,
7281
log_query: Union[LogQueryDefinition, UnsetType] = unset,
7382
q: Union[str, UnsetType] = unset,
@@ -85,6 +94,7 @@ def __init__(
8594
],
8695
UnsetType,
8796
] = unset,
97+
query: Union[ListStreamQuery, UnsetType] = unset,
8898
response_format: Union[FormulaAndFunctionResponseFormat, UnsetType] = unset,
8999
rum_query: Union[LogQueryDefinition, UnsetType] = unset,
90100
security_query: Union[LogQueryDefinition, UnsetType] = unset,
@@ -93,6 +103,9 @@ def __init__(
93103
"""
94104
An updated geomap widget.
95105
106+
:param columns: Widget columns.
107+
:type columns: [ListStreamColumn], optional
108+
96109
:param formulas: List of formulas that operate on queries.
97110
:type formulas: [WidgetFormula], optional
98111
@@ -105,7 +118,10 @@ def __init__(
105118
:param queries: List of queries that can be returned directly or used in formulas.
106119
:type queries: [FormulaAndFunctionQueryDefinition], optional
107120
108-
:param response_format: Timeseries or Scalar response.
121+
:param query: Updated list stream widget.
122+
:type query: ListStreamQuery, optional
123+
124+
:param response_format: Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets.
109125
:type response_format: FormulaAndFunctionResponseFormat, optional
110126
111127
:param rum_query: The log query.
@@ -114,6 +130,8 @@ def __init__(
114130
:param security_query: The log query.
115131
:type security_query: LogQueryDefinition, optional
116132
"""
133+
if columns is not unset:
134+
kwargs["columns"] = columns
117135
if formulas is not unset:
118136
kwargs["formulas"] = formulas
119137
if log_query is not unset:
@@ -122,6 +140,8 @@ def __init__(
122140
kwargs["q"] = q
123141
if queries is not unset:
124142
kwargs["queries"] = queries
143+
if query is not unset:
144+
kwargs["query"] = query
125145
if response_format is not unset:
126146
kwargs["response_format"] = response_format
127147
if rum_query is not unset:

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -159,7 +159,7 @@ def __init__(
159159
:param queries: List of queries that can be returned directly or used in formulas.
160160
:type queries: [FormulaAndFunctionQueryDefinition], optional
161161
162-
:param response_format: Timeseries or Scalar response.
162+
:param response_format: Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets.
163163
:type response_format: FormulaAndFunctionResponseFormat, optional
164164
165165
:param rum_query: The log query.

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ def __init__(
8585
:param queries: List of queries that can be returned directly or used in formulas.
8686
:type queries: [FormulaAndFunctionQueryDefinition], optional
8787
88-
:param response_format: Timeseries or Scalar response.
88+
:param response_format: Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets.
8989
:type response_format: FormulaAndFunctionResponseFormat, optional
9090
"""
9191
if formulas is not unset:

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -143,7 +143,7 @@ def __init__(
143143
:param queries: List of queries that can be returned directly or used in formulas.
144144
:type queries: [FormulaAndFunctionQueryDefinition], optional
145145
146-
:param response_format: Timeseries or Scalar response.
146+
:param response_format: Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets.
147147
:type response_format: FormulaAndFunctionResponseFormat, optional
148148
149149
:param rum_query: The log query.

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -189,7 +189,7 @@ def __init__(
189189
:param queries: List of queries that can be returned directly or used in formulas.
190190
:type queries: [FormulaAndFunctionQueryDefinition], optional
191191
192-
:param response_format: Timeseries or Scalar response.
192+
:param response_format: Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets.
193193
:type response_format: FormulaAndFunctionResponseFormat, optional
194194
195195
:param rum_query: The log query.

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -170,7 +170,7 @@ def __init__(
170170
:param queries: List of queries that can be returned directly or used in formulas.
171171
:type queries: [FormulaAndFunctionQueryDefinition], optional
172172
173-
:param response_format: Timeseries or Scalar response.
173+
:param response_format: Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets.
174174
:type response_format: FormulaAndFunctionResponseFormat, optional
175175
176176
:param rum_query: The log query.

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -162,7 +162,7 @@ def __init__(
162162
:param queries: List of queries that can be returned directly or used in formulas.
163163
:type queries: [FormulaAndFunctionQueryDefinition], optional
164164
165-
:param response_format: Timeseries or Scalar response.
165+
:param response_format: Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets.
166166
:type response_format: FormulaAndFunctionResponseFormat, optional
167167
168168
:param rum_query: The log query.

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ def __init__(
9191
:param queries: List of queries that can be returned directly or used in formulas.
9292
:type queries: [FormulaAndFunctionQueryDefinition], optional
9393
94-
:param response_format: Timeseries or Scalar response.
94+
:param response_format: Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets.
9595
:type response_format: FormulaAndFunctionResponseFormat, optional
9696
"""
9797
if formulas is not unset:

‎tests/v1/cassettes/test_scenarios/test_create_a_geomap_widget_using_an_event_list_request.frozen

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
2023-06-21T19:29:03.584Z

0 commit comments

Comments
 (0)