Skip to content

Commit 90eb4f7

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 d8e7ee77 of spec repo (#2955)
Co-authored-by: ci.datadog-api-spec <[email protected]>
1 parent e6e8609 commit 90eb4f7

14 files changed

+615
-10
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.6",
7-
"regenerated": "2025-06-30 10:29:37.915889",
8-
"spec_repo_commit": "be63084a"
7+
"regenerated": "2025-06-30 17:05:05.986606",
8+
"spec_repo_commit": "d8e7ee77"
99
},
1010
"v2": {
1111
"apigentools_version": "1.6.6",
12-
"regenerated": "2025-06-30 10:29:37.934362",
13-
"spec_repo_commit": "be63084a"
12+
"regenerated": "2025-06-30 17:05:06.003684",
13+
"spec_repo_commit": "d8e7ee77"
1414
}
1515
}
1616
}

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

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1550,6 +1550,13 @@ components:
15501550
example: host
15511551
nullable: true
15521552
type: string
1553+
type:
1554+
description: The type of variable. This is to differentiate between filter
1555+
variables (interpolated in query) and group by variables (interpolated
1556+
into group by).
1557+
example: group
1558+
nullable: true
1559+
type: string
15531560
required:
15541561
- name
15551562
type: object
@@ -12578,6 +12585,12 @@ components:
1257812585
prefix:
1257912586
description: The tag/attribute key associated with the template variable.
1258012587
type: string
12588+
type:
12589+
description: The type of variable. This is to differentiate between filter
12590+
variables (interpolated in query) and group by variables (interpolated
12591+
into group by).
12592+
nullable: true
12593+
type: string
1258112594
visible_tags:
1258212595
description: List of visible tag values on the shared dashboard.
1258312596
items:

‎examples/v1/dashboards/CreateDashboard_1751391372.java‎

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
// Create a new dashboard with template variable type field returns "OK" response
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.DashboardTemplateVariable;
10+
import com.datadog.api.client.v1.model.HostMapRequest;
11+
import com.datadog.api.client.v1.model.HostMapWidgetDefinition;
12+
import com.datadog.api.client.v1.model.HostMapWidgetDefinitionRequests;
13+
import com.datadog.api.client.v1.model.HostMapWidgetDefinitionType;
14+
import com.datadog.api.client.v1.model.Widget;
15+
import com.datadog.api.client.v1.model.WidgetDefinition;
16+
import java.util.Arrays;
17+
import java.util.Collections;
18+
19+
public class Example {
20+
public static void main(String[] args) {
21+
ApiClient defaultClient = ApiClient.getDefaultApiClient();
22+
DashboardsApi apiInstance = new DashboardsApi(defaultClient);
23+
24+
Dashboard body =
25+
new Dashboard()
26+
.description(null)
27+
.layoutType(DashboardLayoutType.ORDERED)
28+
.reflowType(DashboardReflowType.AUTO)
29+
.templateVariables(
30+
Collections.singletonList(
31+
new DashboardTemplateVariable()
32+
.availableValues(Arrays.asList("service", "datacenter", "env"))
33+
.defaults(Arrays.asList("service", "datacenter"))
34+
.name("group_by_var")
35+
.type("group")))
36+
.title("")
37+
.widgets(
38+
Collections.singletonList(
39+
new Widget()
40+
.definition(
41+
new WidgetDefinition(
42+
new HostMapWidgetDefinition()
43+
.requests(
44+
new HostMapWidgetDefinitionRequests()
45+
.fill(new HostMapRequest().q("avg:system.cpu.user{*}")))
46+
.type(HostMapWidgetDefinitionType.HOSTMAP)))));
47+
48+
try {
49+
Dashboard result = apiInstance.createDashboard(body);
50+
System.out.println(result);
51+
} catch (ApiException e) {
52+
System.err.println("Exception when calling DashboardsApi#createDashboard");
53+
System.err.println("Status code: " + e.getCode());
54+
System.err.println("Reason: " + e.getResponseBody());
55+
System.err.println("Response headers: " + e.getResponseHeaders());
56+
e.printStackTrace();
57+
}
58+
}
59+
}

‎examples/v1/dashboards/CreatePublicDashboard_1668947073.java‎

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
// Create a shared dashboard with a group template variable returns "OK" response
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.DashboardGlobalTime;
7+
import com.datadog.api.client.v1.model.DashboardGlobalTimeLiveSpan;
8+
import com.datadog.api.client.v1.model.DashboardShareType;
9+
import com.datadog.api.client.v1.model.DashboardType;
10+
import com.datadog.api.client.v1.model.SelectableTemplateVariableItems;
11+
import com.datadog.api.client.v1.model.SharedDashboard;
12+
import java.util.Arrays;
13+
import java.util.Collections;
14+
15+
public class Example {
16+
public static void main(String[] args) {
17+
ApiClient defaultClient = ApiClient.getDefaultApiClient();
18+
DashboardsApi apiInstance = new DashboardsApi(defaultClient);
19+
20+
// there is a valid "dashboard" in the system
21+
String DASHBOARD_ID = System.getenv("DASHBOARD_ID");
22+
23+
SharedDashboard body =
24+
new SharedDashboard()
25+
.dashboardId(DASHBOARD_ID)
26+
.dashboardType(DashboardType.CUSTOM_TIMEBOARD)
27+
.shareType(DashboardShareType.OPEN)
28+
.globalTime(
29+
new DashboardGlobalTime().liveSpan(DashboardGlobalTimeLiveSpan.PAST_ONE_HOUR))
30+
.selectableTemplateVars(
31+
Collections.singletonList(
32+
new SelectableTemplateVariableItems()
33+
.defaultValue("*")
34+
.name("group_by_var")
35+
.type("group")
36+
.visibleTags(Arrays.asList("selectableValue1", "selectableValue2"))));
37+
38+
try {
39+
SharedDashboard result = apiInstance.createPublicDashboard(body);
40+
System.out.println(result);
41+
} catch (ApiException e) {
42+
System.err.println("Exception when calling DashboardsApi#createPublicDashboard");
43+
System.err.println("Status code: " + e.getCode());
44+
System.err.println("Reason: " + e.getResponseBody());
45+
System.err.println("Response headers: " + e.getResponseHeaders());
46+
e.printStackTrace();
47+
}
48+
}
49+
}

‎examples/v1/dashboards/UpdatePublicDashboard_1708268778.java‎

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
// Update a shared dashboard with selectable_template_vars returns "OK" response
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.DashboardGlobalTimeLiveSpan;
7+
import com.datadog.api.client.v1.model.DashboardShareType;
8+
import com.datadog.api.client.v1.model.SelectableTemplateVariableItems;
9+
import com.datadog.api.client.v1.model.SharedDashboard;
10+
import com.datadog.api.client.v1.model.SharedDashboardUpdateRequest;
11+
import com.datadog.api.client.v1.model.SharedDashboardUpdateRequestGlobalTime;
12+
import java.util.Arrays;
13+
import java.util.Collections;
14+
15+
public class Example {
16+
public static void main(String[] args) {
17+
ApiClient defaultClient = ApiClient.getDefaultApiClient();
18+
DashboardsApi apiInstance = new DashboardsApi(defaultClient);
19+
20+
// there is a valid "shared_dashboard" in the system
21+
String SHARED_DASHBOARD_TOKEN = System.getenv("SHARED_DASHBOARD_TOKEN");
22+
23+
SharedDashboardUpdateRequest body =
24+
new SharedDashboardUpdateRequest()
25+
.globalTime(
26+
new SharedDashboardUpdateRequestGlobalTime()
27+
.liveSpan(DashboardGlobalTimeLiveSpan.PAST_FIFTEEN_MINUTES))
28+
.shareType(DashboardShareType.OPEN)
29+
.selectableTemplateVars(
30+
Collections.singletonList(
31+
new SelectableTemplateVariableItems()
32+
.defaultValue("*")
33+
.name("group_by_var")
34+
.type("group")
35+
.visibleTags(Arrays.asList("selectableValue1", "selectableValue2"))));
36+
37+
try {
38+
SharedDashboard result = apiInstance.updatePublicDashboard(SHARED_DASHBOARD_TOKEN, body);
39+
System.out.println(result);
40+
} catch (ApiException e) {
41+
System.err.println("Exception when calling DashboardsApi#updatePublicDashboard");
42+
System.err.println("Status code: " + e.getCode());
43+
System.err.println("Reason: " + e.getResponseBody());
44+
System.err.println("Response headers: " + e.getResponseHeaders());
45+
e.printStackTrace();
46+
}
47+
}
48+
}

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

Lines changed: 41 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,8 @@
2626
DashboardTemplateVariable.JSON_PROPERTY_DEFAULT,
2727
DashboardTemplateVariable.JSON_PROPERTY_DEFAULTS,
2828
DashboardTemplateVariable.JSON_PROPERTY_NAME,
29-
DashboardTemplateVariable.JSON_PROPERTY_PREFIX
29+
DashboardTemplateVariable.JSON_PROPERTY_PREFIX,
30+
DashboardTemplateVariable.JSON_PROPERTY_TYPE
3031
})
3132
@jakarta.annotation.Generated(
3233
value = "https://github.com/DataDog/datadog-api-client-java/blob/master/.generator")
@@ -47,6 +48,9 @@ public class DashboardTemplateVariable {
4748
public static final String JSON_PROPERTY_PREFIX = "prefix";
4849
private JsonNullable<String> prefix = JsonNullable.<String>undefined();
4950

51+
public static final String JSON_PROPERTY_TYPE = "type";
52+
private JsonNullable<String> type = JsonNullable.<String>undefined();
53+
5054
public DashboardTemplateVariable() {}
5155

5256
@JsonCreator
@@ -216,6 +220,38 @@ public void setPrefix(String prefix) {
216220
this.prefix = JsonNullable.<String>of(prefix);
217221
}
218222

223+
public DashboardTemplateVariable type(String type) {
224+
this.type = JsonNullable.<String>of(type);
225+
return this;
226+
}
227+
228+
/**
229+
* The type of variable. This is to differentiate between filter variables (interpolated in query)
230+
* and group by variables (interpolated into group by).
231+
*
232+
* @return type
233+
*/
234+
@jakarta.annotation.Nullable
235+
@JsonIgnore
236+
public String getType() {
237+
return type.orElse(null);
238+
}
239+
240+
@JsonProperty(JSON_PROPERTY_TYPE)
241+
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
242+
public JsonNullable<String> getType_JsonNullable() {
243+
return type;
244+
}
245+
246+
@JsonProperty(JSON_PROPERTY_TYPE)
247+
public void setType_JsonNullable(JsonNullable<String> type) {
248+
this.type = type;
249+
}
250+
251+
public void setType(String type) {
252+
this.type = JsonNullable.<String>of(type);
253+
}
254+
219255
/**
220256
* A container for additional, undeclared properties. This is a holder for any undeclared
221257
* properties as specified with the 'additionalProperties' keyword in the OAS document.
@@ -277,13 +313,15 @@ public boolean equals(Object o) {
277313
&& Objects.equals(this.defaults, dashboardTemplateVariable.defaults)
278314
&& Objects.equals(this.name, dashboardTemplateVariable.name)
279315
&& Objects.equals(this.prefix, dashboardTemplateVariable.prefix)
316+
&& Objects.equals(this.type, dashboardTemplateVariable.type)
280317
&& Objects.equals(
281318
this.additionalProperties, dashboardTemplateVariable.additionalProperties);
282319
}
283320

284321
@Override
285322
public int hashCode() {
286-
return Objects.hash(availableValues, _default, defaults, name, prefix, additionalProperties);
323+
return Objects.hash(
324+
availableValues, _default, defaults, name, prefix, type, additionalProperties);
287325
}
288326

289327
@Override
@@ -295,6 +333,7 @@ public String toString() {
295333
sb.append(" defaults: ").append(toIndentedString(defaults)).append("\n");
296334
sb.append(" name: ").append(toIndentedString(name)).append("\n");
297335
sb.append(" prefix: ").append(toIndentedString(prefix)).append("\n");
336+
sb.append(" type: ").append(toIndentedString(type)).append("\n");
298337
sb.append(" additionalProperties: ")
299338
.append(toIndentedString(additionalProperties))
300339
.append("\n");

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

Lines changed: 39 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@
2727
SelectableTemplateVariableItems.JSON_PROPERTY_DEFAULT_VALUE,
2828
SelectableTemplateVariableItems.JSON_PROPERTY_NAME,
2929
SelectableTemplateVariableItems.JSON_PROPERTY_PREFIX,
30+
SelectableTemplateVariableItems.JSON_PROPERTY_TYPE,
3031
SelectableTemplateVariableItems.JSON_PROPERTY_VISIBLE_TAGS
3132
})
3233
@jakarta.annotation.Generated(
@@ -42,6 +43,9 @@ public class SelectableTemplateVariableItems {
4243
public static final String JSON_PROPERTY_PREFIX = "prefix";
4344
private String prefix;
4445

46+
public static final String JSON_PROPERTY_TYPE = "type";
47+
private JsonNullable<String> type = JsonNullable.<String>undefined();
48+
4549
public static final String JSON_PROPERTY_VISIBLE_TAGS = "visible_tags";
4650
private JsonNullable<List<String>> visibleTags = JsonNullable.<List<String>>undefined();
4751

@@ -108,6 +112,38 @@ public void setPrefix(String prefix) {
108112
this.prefix = prefix;
109113
}
110114

115+
public SelectableTemplateVariableItems type(String type) {
116+
this.type = JsonNullable.<String>of(type);
117+
return this;
118+
}
119+
120+
/**
121+
* The type of variable. This is to differentiate between filter variables (interpolated in query)
122+
* and group by variables (interpolated into group by).
123+
*
124+
* @return type
125+
*/
126+
@jakarta.annotation.Nullable
127+
@JsonIgnore
128+
public String getType() {
129+
return type.orElse(null);
130+
}
131+
132+
@JsonProperty(JSON_PROPERTY_TYPE)
133+
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
134+
public JsonNullable<String> getType_JsonNullable() {
135+
return type;
136+
}
137+
138+
@JsonProperty(JSON_PROPERTY_TYPE)
139+
public void setType_JsonNullable(JsonNullable<String> type) {
140+
this.type = type;
141+
}
142+
143+
public void setType(String type) {
144+
this.type = JsonNullable.<String>of(type);
145+
}
146+
111147
public SelectableTemplateVariableItems visibleTags(List<String> visibleTags) {
112148
this.visibleTags = JsonNullable.<List<String>>of(visibleTags);
113149
return this;
@@ -211,14 +247,15 @@ public boolean equals(Object o) {
211247
return Objects.equals(this.defaultValue, selectableTemplateVariableItems.defaultValue)
212248
&& Objects.equals(this.name, selectableTemplateVariableItems.name)
213249
&& Objects.equals(this.prefix, selectableTemplateVariableItems.prefix)
250+
&& Objects.equals(this.type, selectableTemplateVariableItems.type)
214251
&& Objects.equals(this.visibleTags, selectableTemplateVariableItems.visibleTags)
215252
&& Objects.equals(
216253
this.additionalProperties, selectableTemplateVariableItems.additionalProperties);
217254
}
218255

219256
@Override
220257
public int hashCode() {
221-
return Objects.hash(defaultValue, name, prefix, visibleTags, additionalProperties);
258+
return Objects.hash(defaultValue, name, prefix, type, visibleTags, additionalProperties);
222259
}
223260

224261
@Override
@@ -228,6 +265,7 @@ public String toString() {
228265
sb.append(" defaultValue: ").append(toIndentedString(defaultValue)).append("\n");
229266
sb.append(" name: ").append(toIndentedString(name)).append("\n");
230267
sb.append(" prefix: ").append(toIndentedString(prefix)).append("\n");
268+
sb.append(" type: ").append(toIndentedString(type)).append("\n");
231269
sb.append(" visibleTags: ").append(toIndentedString(visibleTags)).append("\n");
232270
sb.append(" additionalProperties: ")
233271
.append(toIndentedString(additionalProperties))

‎src/test/resources/cassettes/features/v1/Create_a_new_dashboard_with_template_variable_type_field_returns_OK_response.freeze‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
2025-06-30T15:47:16.966Z

0 commit comments

Comments
 (0)