Skip to content

Commit b5d3f79

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 (#3283)
Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>
1 parent c32f1c7 commit b5d3f79

File tree

9 files changed

+529
-13
lines changed

9 files changed

+529
-13
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.

‎examples/v1/dashboards/CreateDashboard_9836563.java‎

Lines changed: 168 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,168 @@
1+
// Create a geomap widget with conditional formats and text formats
2+
3+
import com.datadog.api.client.ApiClient;
4+
import com.datadog.api.client.ApiException;
5+
import com.datadog.api.client.v1.api.DashboardsApi;
6+
import com.datadog.api.client.v1.model.Dashboard;
7+
import com.datadog.api.client.v1.model.DashboardLayoutType;
8+
import com.datadog.api.client.v1.model.DashboardReflowType;
9+
import com.datadog.api.client.v1.model.FormulaAndFunctionEventAggregation;
10+
import com.datadog.api.client.v1.model.FormulaAndFunctionEventQueryDefinition;
11+
import com.datadog.api.client.v1.model.FormulaAndFunctionEventQueryDefinitionCompute;
12+
import com.datadog.api.client.v1.model.FormulaAndFunctionEventQueryDefinitionSearch;
13+
import com.datadog.api.client.v1.model.FormulaAndFunctionEventsDataSource;
14+
import com.datadog.api.client.v1.model.FormulaAndFunctionQueryDefinition;
15+
import com.datadog.api.client.v1.model.FormulaAndFunctionResponseFormat;
16+
import com.datadog.api.client.v1.model.FormulaType;
17+
import com.datadog.api.client.v1.model.GeomapWidgetDefinition;
18+
import com.datadog.api.client.v1.model.GeomapWidgetDefinitionStyle;
19+
import com.datadog.api.client.v1.model.GeomapWidgetDefinitionType;
20+
import com.datadog.api.client.v1.model.GeomapWidgetDefinitionView;
21+
import com.datadog.api.client.v1.model.GeomapWidgetRequest;
22+
import com.datadog.api.client.v1.model.GeomapWidgetRequestStyle;
23+
import com.datadog.api.client.v1.model.ListStreamColumn;
24+
import com.datadog.api.client.v1.model.ListStreamColumnWidth;
25+
import com.datadog.api.client.v1.model.ListStreamQuery;
26+
import com.datadog.api.client.v1.model.ListStreamSource;
27+
import com.datadog.api.client.v1.model.TableWidgetTextFormatMatch;
28+
import com.datadog.api.client.v1.model.TableWidgetTextFormatMatchType;
29+
import com.datadog.api.client.v1.model.TableWidgetTextFormatPalette;
30+
import com.datadog.api.client.v1.model.TableWidgetTextFormatRule;
31+
import com.datadog.api.client.v1.model.Widget;
32+
import com.datadog.api.client.v1.model.WidgetComparator;
33+
import com.datadog.api.client.v1.model.WidgetConditionalFormat;
34+
import com.datadog.api.client.v1.model.WidgetDefinition;
35+
import com.datadog.api.client.v1.model.WidgetFormula;
36+
import com.datadog.api.client.v1.model.WidgetFormulaSort;
37+
import com.datadog.api.client.v1.model.WidgetLayout;
38+
import com.datadog.api.client.v1.model.WidgetPalette;
39+
import com.datadog.api.client.v1.model.WidgetSort;
40+
import com.datadog.api.client.v1.model.WidgetSortBy;
41+
import com.datadog.api.client.v1.model.WidgetSortOrderBy;
42+
import java.util.Arrays;
43+
import java.util.Collections;
44+
45+
public class Example {
46+
public static void main(String[] args) {
47+
ApiClient defaultClient = ApiClient.getDefaultApiClient();
48+
DashboardsApi apiInstance = new DashboardsApi(defaultClient);
49+
50+
Dashboard body =
51+
new Dashboard()
52+
.title("Example-Dashboard")
53+
.description("Example-Dashboard")
54+
.widgets(
55+
Collections.singletonList(
56+
new Widget()
57+
.definition(
58+
new WidgetDefinition(
59+
new GeomapWidgetDefinition()
60+
.title("Log Count by Service and Source")
61+
.type(GeomapWidgetDefinitionType.GEOMAP)
62+
.requests(
63+
Arrays.asList(
64+
new GeomapWidgetRequest()
65+
.responseFormat(
66+
FormulaAndFunctionResponseFormat.SCALAR)
67+
.queries(
68+
Collections.singletonList(
69+
new FormulaAndFunctionQueryDefinition(
70+
new FormulaAndFunctionEventQueryDefinition()
71+
.dataSource(
72+
FormulaAndFunctionEventsDataSource
73+
.RUM)
74+
.name("query1")
75+
.search(
76+
new FormulaAndFunctionEventQueryDefinitionSearch()
77+
.query("@type:session"))
78+
.indexes(
79+
Collections.singletonList("*"))
80+
.compute(
81+
new FormulaAndFunctionEventQueryDefinitionCompute()
82+
.aggregation(
83+
FormulaAndFunctionEventAggregation
84+
.COUNT)))))
85+
.conditionalFormats(
86+
Collections.singletonList(
87+
new WidgetConditionalFormat()
88+
.comparator(
89+
WidgetComparator.GREATER_THAN)
90+
.value(1000.0)
91+
.palette(WidgetPalette.WHITE_ON_GREEN)))
92+
.formulas(
93+
Collections.singletonList(
94+
new WidgetFormula().formula("query1")))
95+
.sort(
96+
new WidgetSortBy()
97+
.count(250L)
98+
.orderBy(
99+
Collections.singletonList(
100+
new WidgetSortOrderBy(
101+
new WidgetFormulaSort()
102+
.type(FormulaType.FORMULA)
103+
.index(0L)
104+
.order(
105+
WidgetSort
106+
.DESCENDING))))),
107+
new GeomapWidgetRequest()
108+
.responseFormat(
109+
FormulaAndFunctionResponseFormat.EVENT_LIST)
110+
.query(
111+
new ListStreamQuery()
112+
.dataSource(ListStreamSource.LOGS_STREAM)
113+
.queryString("")
114+
.storage("hot"))
115+
.columns(
116+
Arrays.asList(
117+
new ListStreamColumn()
118+
.field(
119+
"@network.client.geoip.location.latitude")
120+
.width(ListStreamColumnWidth.AUTO),
121+
new ListStreamColumn()
122+
.field(
123+
"@network.client.geoip.location.longitude")
124+
.width(ListStreamColumnWidth.AUTO),
125+
new ListStreamColumn()
126+
.field(
127+
"@network.client.geoip.country.iso_code")
128+
.width(ListStreamColumnWidth.AUTO),
129+
new ListStreamColumn()
130+
.field(
131+
"@network.client.geoip.subdivision.name")
132+
.width(ListStreamColumnWidth.AUTO)))
133+
.style(
134+
new GeomapWidgetRequestStyle()
135+
.colorBy("status"))
136+
.textFormats(
137+
Collections.singletonList(
138+
new TableWidgetTextFormatRule()
139+
.match(
140+
new TableWidgetTextFormatMatch()
141+
.type(
142+
TableWidgetTextFormatMatchType
143+
.IS)
144+
.value("error"))
145+
.palette(
146+
TableWidgetTextFormatPalette
147+
.WHITE_ON_RED)))))
148+
.style(
149+
new GeomapWidgetDefinitionStyle()
150+
.palette("hostmap_blues")
151+
.paletteFlip(false))
152+
.view(new GeomapWidgetDefinitionView().focus("NORTH_AMERICA"))))
153+
.layout(new WidgetLayout().x(0L).y(0L).width(12L).height(6L))))
154+
.layoutType(DashboardLayoutType.ORDERED)
155+
.reflowType(DashboardReflowType.FIXED);
156+
157+
try {
158+
Dashboard result = apiInstance.createDashboard(body);
159+
System.out.println(result);
160+
} catch (ApiException e) {
161+
System.err.println("Exception when calling DashboardsApi#createDashboard");
162+
System.err.println("Status code: " + e.getCode());
163+
System.err.println("Reason: " + e.getResponseBody());
164+
System.err.println("Response headers: " + e.getResponseHeaders());
165+
e.printStackTrace();
166+
}
167+
}
168+
}

‎src/main/java/com/datadog/api/client/v1/model/GeomapWidgetDefinition.java‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -128,11 +128,11 @@ public GeomapWidgetDefinition addRequestsItem(GeomapWidgetRequest requestsItem)
128128
}
129129

130130
/**
131-
* Array of one request object to display in the widget. The request must contain a <code>group-by
132-
* </code> tag whose value is a country ISO code.
133-
*
134-
* <p>See the <a href="https://docs.datadoghq.com/dashboards/graphing_json/request_json">Request
135-
* JSON schema documentation</a> for information about building the <code>REQUEST_SCHEMA</code>.
131+
* Array of request objects to display in the widget. May include an optional request for the
132+
* region layer and/or an optional request for the points layer. Region layer requests must
133+
* contain a <code>group-by</code> tag whose value is a country ISO code. See the <a
134+
* href="https://docs.datadoghq.com/dashboards/graphing_json/request_json">Request JSON schema
135+
* documentation</a> for information about building the <code>REQUEST_SCHEMA</code>.
136136
*
137137
* @return requests
138138
*/

‎src/main/java/com/datadog/api/client/v1/model/GeomapWidgetDefinitionView.java‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,10 @@ public GeomapWidgetDefinitionView focus(String focus) {
4040
}
4141

4242
/**
43-
* The 2-letter ISO code of a country to focus the map on. Or <code>WORLD</code>.
43+
* The 2-letter ISO code of a country to focus the map on, or <code>WORLD</code> for global view,
44+
* or a region (<code>EMEA</code>, <code>APAC</code>, <code>LATAM</code>), or a continent (<code>
45+
* NORTH_AMERICA</code>, <code>SOUTH_AMERICA</code>, <code>EUROPE</code>, <code>AFRICA</code>,
46+
* <code>ASIA</code>, <code>OCEANIA</code>).
4447
*
4548
* @return focus
4649
*/

0 commit comments

Comments
 (0)