Skip to content

Commit fc4fc3c

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
api-clients-generation-pipeline[bot]
and
ci.datadog-api-spec
authored
Regenerate client from commit 497f78f of spec repo (#2981)
Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>
1 parent f1a08f6 commit fc4fc3c

11 files changed

+330
-10
lines changed

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

Lines changed: 31 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3448,9 +3448,10 @@ components:
34483448
$ref: '#/components/schemas/WidgetCustomLink'
34493449
type: array
34503450
requests:
3451-
description: 'Array of one request object to display in the widget. The
3452-
request must contain a `group-by` tag whose value is a country ISO code.
3453-
3451+
description: 'Array of request objects to display in the widget. May include
3452+
an optional request for the region layer and/or an optional request for
3453+
the points layer. Region layer requests must contain a `group-by` tag
3454+
whose value is a country ISO code.
34543455

34553456
See the [Request JSON schema documentation](https://docs.datadoghq.com/dashboards/graphing_json/request_json)
34563457

@@ -3461,7 +3462,7 @@ components:
34613462
query: <METRIC_1>{<SCOPE_1>}
34623463
items:
34633464
$ref: '#/components/schemas/GeomapWidgetRequest'
3464-
maxItems: 1
3465+
maxItems: 2
34653466
minItems: 1
34663467
type: array
34673468
style:
@@ -3519,8 +3520,9 @@ components:
35193520
focus: WORLD
35203521
properties:
35213522
focus:
3522-
description: The 2-letter ISO code of a country to focus the map on. Or
3523-
`WORLD`.
3523+
description: The 2-letter ISO code of a country to focus the map on, or
3524+
`WORLD` for global view, or a region (`EMEA`, `APAC`, `LATAM`), or a continent
3525+
(`NORTH_AMERICA`, `SOUTH_AMERICA`, `EUROPE`, `AFRICA`, `ASIA`, `OCEANIA`).
35243526
example: WORLD
35253527
type: string
35263528
required:
@@ -3539,6 +3541,12 @@ components:
35393541
items:
35403542
$ref: '#/components/schemas/ListStreamColumn'
35413543
type: array
3544+
conditional_formats:
3545+
description: Threshold (numeric) conditional formatting rules may be used
3546+
by a regions layer.
3547+
items:
3548+
$ref: '#/components/schemas/WidgetConditionalFormat'
3549+
type: array
35423550
formulas:
35433551
description: List of formulas that operate on queries.
35443552
items:
@@ -3564,6 +3572,23 @@ components:
35643572
$ref: '#/components/schemas/LogQueryDefinition'
35653573
sort:
35663574
$ref: '#/components/schemas/WidgetSortBy'
3575+
style:
3576+
$ref: '#/components/schemas/GeomapWidgetRequestStyle'
3577+
text_formats:
3578+
description: Text formatting rules may be used by a points layer.
3579+
items:
3580+
$ref: '#/components/schemas/TableWidgetTextFormatRule'
3581+
type: array
3582+
type: object
3583+
GeomapWidgetRequestStyle:
3584+
description: The style to apply to the request for points layer.
3585+
example:
3586+
color_by: status
3587+
properties:
3588+
color_by:
3589+
description: The category to color the points by.
3590+
example: status
3591+
type: string
35673592
type: object
35683593
GraphSnapshot:
35693594
description: Object representing a graph snapshot.

‎docs/datadog_api_client.v1.model.rst‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1096,6 +1096,13 @@ datadog\_api\_client.v1.model.geomap\_widget\_request module
10961096
:members:
10971097
:show-inheritance:
10981098

1099+
datadog\_api\_client.v1.model.geomap\_widget\_request\_style module
1100+
-------------------------------------------------------------------
1101+
1102+
.. automodule:: datadog_api_client.v1.model.geomap_widget_request_style
1103+
:members:
1104+
:show-inheritance:
1105+
10991106
datadog\_api\_client.v1.model.graph\_snapshot module
11001107
----------------------------------------------------
11011108

‎examples/v1/dashboards/CreateDashboard_9836563.py‎

Lines changed: 165 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,165 @@
1+
"""
2+
Create a geomap widget with conditional formats and text formats
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_event_aggregation import FormulaAndFunctionEventAggregation
11+
from datadog_api_client.v1.model.formula_and_function_event_query_definition import (
12+
FormulaAndFunctionEventQueryDefinition,
13+
)
14+
from datadog_api_client.v1.model.formula_and_function_event_query_definition_compute import (
15+
FormulaAndFunctionEventQueryDefinitionCompute,
16+
)
17+
from datadog_api_client.v1.model.formula_and_function_event_query_definition_search import (
18+
FormulaAndFunctionEventQueryDefinitionSearch,
19+
)
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.formula_type import FormulaType
23+
from datadog_api_client.v1.model.geomap_widget_definition import GeomapWidgetDefinition
24+
from datadog_api_client.v1.model.geomap_widget_definition_style import GeomapWidgetDefinitionStyle
25+
from datadog_api_client.v1.model.geomap_widget_definition_type import GeomapWidgetDefinitionType
26+
from datadog_api_client.v1.model.geomap_widget_definition_view import GeomapWidgetDefinitionView
27+
from datadog_api_client.v1.model.geomap_widget_request import GeomapWidgetRequest
28+
from datadog_api_client.v1.model.geomap_widget_request_style import GeomapWidgetRequestStyle
29+
from datadog_api_client.v1.model.list_stream_column import ListStreamColumn
30+
from datadog_api_client.v1.model.list_stream_column_width import ListStreamColumnWidth
31+
from datadog_api_client.v1.model.list_stream_query import ListStreamQuery
32+
from datadog_api_client.v1.model.list_stream_source import ListStreamSource
33+
from datadog_api_client.v1.model.table_widget_text_format_match import TableWidgetTextFormatMatch
34+
from datadog_api_client.v1.model.table_widget_text_format_match_type import TableWidgetTextFormatMatchType
35+
from datadog_api_client.v1.model.table_widget_text_format_palette import TableWidgetTextFormatPalette
36+
from datadog_api_client.v1.model.table_widget_text_format_rule import TableWidgetTextFormatRule
37+
from datadog_api_client.v1.model.widget import Widget
38+
from datadog_api_client.v1.model.widget_comparator import WidgetComparator
39+
from datadog_api_client.v1.model.widget_conditional_format import WidgetConditionalFormat
40+
from datadog_api_client.v1.model.widget_formula import WidgetFormula
41+
from datadog_api_client.v1.model.widget_formula_sort import WidgetFormulaSort
42+
from datadog_api_client.v1.model.widget_layout import WidgetLayout
43+
from datadog_api_client.v1.model.widget_palette import WidgetPalette
44+
from datadog_api_client.v1.model.widget_sort import WidgetSort
45+
from datadog_api_client.v1.model.widget_sort_by import WidgetSortBy
46+
47+
body = Dashboard(
48+
title="Example-Dashboard",
49+
description="Example-Dashboard",
50+
widgets=[
51+
Widget(
52+
definition=GeomapWidgetDefinition(
53+
title="Log Count by Service and Source",
54+
type=GeomapWidgetDefinitionType.GEOMAP,
55+
requests=[
56+
GeomapWidgetRequest(
57+
response_format=FormulaAndFunctionResponseFormat.SCALAR,
58+
queries=[
59+
FormulaAndFunctionEventQueryDefinition(
60+
data_source=FormulaAndFunctionEventsDataSource.RUM,
61+
name="query1",
62+
search=FormulaAndFunctionEventQueryDefinitionSearch(
63+
query="@type:session",
64+
),
65+
indexes=[
66+
"*",
67+
],
68+
compute=FormulaAndFunctionEventQueryDefinitionCompute(
69+
aggregation=FormulaAndFunctionEventAggregation.COUNT,
70+
),
71+
group_by=[],
72+
),
73+
],
74+
conditional_formats=[
75+
WidgetConditionalFormat(
76+
comparator=WidgetComparator.GREATER_THAN,
77+
value=1000.0,
78+
palette=WidgetPalette.WHITE_ON_GREEN,
79+
),
80+
],
81+
formulas=[
82+
WidgetFormula(
83+
formula="query1",
84+
),
85+
],
86+
sort=WidgetSortBy(
87+
count=250,
88+
order_by=[
89+
WidgetFormulaSort(
90+
type=FormulaType.FORMULA,
91+
index=0,
92+
order=WidgetSort.DESCENDING,
93+
),
94+
],
95+
),
96+
),
97+
GeomapWidgetRequest(
98+
response_format=FormulaAndFunctionResponseFormat.EVENT_LIST,
99+
query=ListStreamQuery(
100+
data_source=ListStreamSource.LOGS_STREAM,
101+
query_string="",
102+
indexes=[],
103+
storage="hot",
104+
),
105+
columns=[
106+
ListStreamColumn(
107+
field="@network.client.geoip.location.latitude",
108+
width=ListStreamColumnWidth.AUTO,
109+
),
110+
ListStreamColumn(
111+
field="@network.client.geoip.location.longitude",
112+
width=ListStreamColumnWidth.AUTO,
113+
),
114+
ListStreamColumn(
115+
field="@network.client.geoip.country.iso_code",
116+
width=ListStreamColumnWidth.AUTO,
117+
),
118+
ListStreamColumn(
119+
field="@network.client.geoip.subdivision.name",
120+
width=ListStreamColumnWidth.AUTO,
121+
),
122+
],
123+
style=GeomapWidgetRequestStyle(
124+
color_by="status",
125+
),
126+
text_formats=[
127+
TableWidgetTextFormatRule(
128+
match=TableWidgetTextFormatMatch(
129+
type=TableWidgetTextFormatMatchType.IS,
130+
value="error",
131+
),
132+
palette=TableWidgetTextFormatPalette.WHITE_ON_RED,
133+
),
134+
],
135+
),
136+
],
137+
style=GeomapWidgetDefinitionStyle(
138+
palette="hostmap_blues",
139+
palette_flip=False,
140+
),
141+
view=GeomapWidgetDefinitionView(
142+
focus="NORTH_AMERICA",
143+
),
144+
),
145+
layout=WidgetLayout(
146+
x=0,
147+
y=0,
148+
width=12,
149+
height=6,
150+
),
151+
),
152+
],
153+
template_variables=[],
154+
layout_type=DashboardLayoutType.ORDERED,
155+
notify_list=[],
156+
reflow_type=DashboardReflowType.FIXED,
157+
tags=[],
158+
)
159+
160+
configuration = Configuration()
161+
with ApiClient(configuration) as api_client:
162+
api_instance = DashboardsApi(api_client)
163+
response = api_instance.create_dashboard(body=body)
164+
165+
print(response)

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

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929
class GeomapWidgetDefinition(ModelNormal):
3030
validations = {
3131
"requests": {
32-
"max_items": 1,
32+
"max_items": 2,
3333
"min_items": 1,
3434
},
3535
}
@@ -87,8 +87,7 @@ def __init__(
8787
:param custom_links: A list of custom links.
8888
:type custom_links: [WidgetCustomLink], optional
8989
90-
:param requests: Array of one request object to display in the widget. The request must contain a ``group-by`` tag whose value is a country ISO code.
91-
90+
:param requests: Array of request objects to display in the widget. May include an optional request for the region layer and/or an optional request for the points layer. Region layer requests must contain a ``group-by`` tag whose value is a country ISO code.
9291
See the `Request JSON schema documentation <https://docs.datadoghq.com/dashboards/graphing_json/request_json>`_
9392
for information about building the ``REQUEST_SCHEMA``.
9493
:type requests: [GeomapWidgetRequest]

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ def __init__(self_, focus: str, **kwargs):
2525
"""
2626
The view of the world that the map should render.
2727
28-
:param focus: The 2-letter ISO code of a country to focus the map on. Or ``WORLD``.
28+
:param focus: The 2-letter ISO code of a country to focus the map on, or ``WORLD`` for global view, or a region ( ``EMEA`` , ``APAC`` , ``LATAM`` ), or a continent ( ``NORTH_AMERICA`` , ``SOUTH_AMERICA`` , ``EUROPE`` , ``AFRICA`` , ``ASIA`` , ``OCEANIA`` ).
2929
:type focus: str
3030
"""
3131
super().__init__(kwargs)

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

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,12 +15,15 @@
1515

1616
if TYPE_CHECKING:
1717
from datadog_api_client.v1.model.list_stream_column import ListStreamColumn
18+
from datadog_api_client.v1.model.widget_conditional_format import WidgetConditionalFormat
1819
from datadog_api_client.v1.model.widget_formula import WidgetFormula
1920
from datadog_api_client.v1.model.log_query_definition import LogQueryDefinition
2021
from datadog_api_client.v1.model.formula_and_function_query_definition import FormulaAndFunctionQueryDefinition
2122
from datadog_api_client.v1.model.list_stream_query import ListStreamQuery
2223
from datadog_api_client.v1.model.formula_and_function_response_format import FormulaAndFunctionResponseFormat
2324
from datadog_api_client.v1.model.widget_sort_by import WidgetSortBy
25+
from datadog_api_client.v1.model.geomap_widget_request_style import GeomapWidgetRequestStyle
26+
from datadog_api_client.v1.model.table_widget_text_format_rule import TableWidgetTextFormatRule
2427
from datadog_api_client.v1.model.formula_and_function_metric_query_definition import (
2528
FormulaAndFunctionMetricQueryDefinition,
2629
)
@@ -48,15 +51,19 @@ class GeomapWidgetRequest(ModelNormal):
4851
@cached_property
4952
def openapi_types(_):
5053
from datadog_api_client.v1.model.list_stream_column import ListStreamColumn
54+
from datadog_api_client.v1.model.widget_conditional_format import WidgetConditionalFormat
5155
from datadog_api_client.v1.model.widget_formula import WidgetFormula
5256
from datadog_api_client.v1.model.log_query_definition import LogQueryDefinition
5357
from datadog_api_client.v1.model.formula_and_function_query_definition import FormulaAndFunctionQueryDefinition
5458
from datadog_api_client.v1.model.list_stream_query import ListStreamQuery
5559
from datadog_api_client.v1.model.formula_and_function_response_format import FormulaAndFunctionResponseFormat
5660
from datadog_api_client.v1.model.widget_sort_by import WidgetSortBy
61+
from datadog_api_client.v1.model.geomap_widget_request_style import GeomapWidgetRequestStyle
62+
from datadog_api_client.v1.model.table_widget_text_format_rule import TableWidgetTextFormatRule
5763

5864
return {
5965
"columns": ([ListStreamColumn],),
66+
"conditional_formats": ([WidgetConditionalFormat],),
6067
"formulas": ([WidgetFormula],),
6168
"log_query": (LogQueryDefinition,),
6269
"q": (str,),
@@ -66,10 +73,13 @@ def openapi_types(_):
6673
"rum_query": (LogQueryDefinition,),
6774
"security_query": (LogQueryDefinition,),
6875
"sort": (WidgetSortBy,),
76+
"style": (GeomapWidgetRequestStyle,),
77+
"text_formats": ([TableWidgetTextFormatRule],),
6978
}
7079

7180
attribute_map = {
7281
"columns": "columns",
82+
"conditional_formats": "conditional_formats",
7383
"formulas": "formulas",
7484
"log_query": "log_query",
7585
"q": "q",
@@ -79,11 +89,14 @@ def openapi_types(_):
7989
"rum_query": "rum_query",
8090
"security_query": "security_query",
8191
"sort": "sort",
92+
"style": "style",
93+
"text_formats": "text_formats",
8294
}
8395

8496
def __init__(
8597
self_,
8698
columns: Union[List[ListStreamColumn], UnsetType] = unset,
99+
conditional_formats: Union[List[WidgetConditionalFormat], UnsetType] = unset,
87100
formulas: Union[List[WidgetFormula], UnsetType] = unset,
88101
log_query: Union[LogQueryDefinition, UnsetType] = unset,
89102
q: Union[str, UnsetType] = unset,
@@ -107,6 +120,8 @@ def __init__(
107120
rum_query: Union[LogQueryDefinition, UnsetType] = unset,
108121
security_query: Union[LogQueryDefinition, UnsetType] = unset,
109122
sort: Union[WidgetSortBy, UnsetType] = unset,
123+
style: Union[GeomapWidgetRequestStyle, UnsetType] = unset,
124+
text_formats: Union[List[TableWidgetTextFormatRule], UnsetType] = unset,
110125
**kwargs,
111126
):
112127
"""
@@ -115,6 +130,9 @@ def __init__(
115130
:param columns: Widget columns.
116131
:type columns: [ListStreamColumn], optional
117132
133+
:param conditional_formats: Threshold (numeric) conditional formatting rules may be used by a regions layer.
134+
:type conditional_formats: [WidgetConditionalFormat], optional
135+
118136
:param formulas: List of formulas that operate on queries.
119137
:type formulas: [WidgetFormula], optional
120138
@@ -141,9 +159,17 @@ def __init__(
141159
142160
:param sort: The controls for sorting the widget.
143161
:type sort: WidgetSortBy, optional
162+
163+
:param style: The style to apply to the request for points layer.
164+
:type style: GeomapWidgetRequestStyle, optional
165+
166+
:param text_formats: Text formatting rules may be used by a points layer.
167+
:type text_formats: [TableWidgetTextFormatRule], optional
144168
"""
145169
if columns is not unset:
146170
kwargs["columns"] = columns
171+
if conditional_formats is not unset:
172+
kwargs["conditional_formats"] = conditional_formats
147173
if formulas is not unset:
148174
kwargs["formulas"] = formulas
149175
if log_query is not unset:
@@ -162,4 +188,8 @@ def __init__(
162188
kwargs["security_query"] = security_query
163189
if sort is not unset:
164190
kwargs["sort"] = sort
191+
if style is not unset:
192+
kwargs["style"] = style
193+
if text_formats is not unset:
194+
kwargs["text_formats"] = text_formats
165195
super().__init__(kwargs)

0 commit comments

Comments
 (0)