Skip to content

Commit 6930b4f

Browse files
author
ci.datadog-api-spec
committed
Regenerate client from commit 4fb1af4 of spec repo
1 parent 08bc435 commit 6930b4f

18 files changed

Lines changed: 504 additions & 292 deletions

.generator/schemas/v1/openapi.yaml

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25934,6 +25934,8 @@ components:
2593425934
$ref: '#/components/schemas/WidgetLineType'
2593525935
line_width:
2593625936
$ref: '#/components/schemas/WidgetLineWidth'
25937+
order_by:
25938+
$ref: '#/components/schemas/WidgetStyleOrderBy'
2593725939
palette:
2593825940
description: Color palette to apply to the widget.
2593925941
type: string
@@ -25996,6 +25998,19 @@ components:
2599625998
description: Color palette to apply to the widget.
2599725999
type: string
2599826000
type: object
26001+
WidgetStyleOrderBy:
26002+
description: 'How to order series in timeseries visualizations.
26003+
26004+
- `tags`: Order series alphabetically by tag name (default behavior)
26005+
26006+
- `values`: Order series by their current metric values (typically descending)'
26007+
enum:
26008+
- tags
26009+
- values
26010+
type: string
26011+
x-enum-varnames:
26012+
- TAGS
26013+
- VALUES
2599926014
WidgetSummaryType:
2600026015
description: Which summary type should be used.
2600126016
enum:

.generator/schemas/v2/openapi.yaml

Lines changed: 7 additions & 82 deletions
Original file line numberDiff line numberDiff line change
@@ -32619,7 +32619,7 @@ components:
3261932619
x-enum-varnames:
3262032620
- ACTIVELY_QUERIED_CONFIGURATIONS
3262132621
MetricAllTags:
32622-
description: Object for a single metric's indexed and ingested tags.
32622+
description: Object for a single metric's indexed tags.
3262332623
properties:
3262432624
attributes:
3262532625
$ref: '#/components/schemas/MetricAllTagsAttributes'
@@ -32629,33 +32629,21 @@ components:
3262932629
$ref: '#/components/schemas/MetricType'
3263032630
type: object
3263132631
MetricAllTagsAttributes:
32632-
description: Object containing the definition of a metric's indexed and ingested
32633-
tags.
32632+
description: Object containing the definition of a metric's tags.
3263432633
properties:
32635-
ingested_tags:
32636-
description: List of ingested tags that are not indexed.
32637-
example:
32638-
- env:prod
32639-
- service:web
32640-
- version:1.0
32641-
items:
32642-
description: Ingested tags for the metric.
32643-
type: string
32644-
type: array
3264532634
tags:
32646-
description: List of indexed tags.
32635+
description: List of indexed tag value pairs.
3264732636
example:
3264832637
- sport:golf
3264932638
- sport:football
3265032639
- animal:dog
3265132640
items:
32652-
description: Indexed tags for the metric.
32641+
description: Tag key-value pairs.
3265332642
type: string
3265432643
type: array
3265532644
type: object
3265632645
MetricAllTagsResponse:
32657-
description: Response object that includes a single metric's indexed and ingested
32658-
tags.
32646+
description: Response object that includes a single metric's indexed tags.
3265932647
properties:
3266032648
data:
3266132649
$ref: '#/components/schemas/MetricAllTags'
@@ -77333,74 +77321,11 @@ paths:
7733377321
- metrics_read
7733477322
/api/v2/metrics/{metric_name}/all-tags:
7733577323
get:
77336-
description: 'View indexed and ingested tags for a given metric name.
77337-
77338-
Results are filtered by the `window[seconds]` parameter, which defaults to
77339-
14400 (4 hours).'
77324+
description: View indexed tag key-value pairs for a given metric name over the
77325+
previous hour.
7734077326
operationId: ListTagsByMetricName
7734177327
parameters:
7734277328
- $ref: '#/components/parameters/MetricName'
77343-
- description: 'The number of seconds of look back (from now) to query for tag
77344-
data.
77345-
77346-
Default value is 14400 (4 hours), minimum value is 14400 (4 hours).'
77347-
example: 14400
77348-
in: query
77349-
name: window[seconds]
77350-
required: false
77351-
schema:
77352-
format: int64
77353-
type: integer
77354-
- description: 'Filter results to tags from data points that have the specified
77355-
tags.
77356-
77357-
For example, `filter[tags]=env:staging,host:123` returns tags only from
77358-
data points with both `env:staging` and `host:123`.'
77359-
example: env:staging,host:123
77360-
in: query
77361-
name: filter[tags]
77362-
required: false
77363-
schema:
77364-
type: string
77365-
- description: 'Filter returned tags to those matching a substring.
77366-
77367-
For example, `filter[match]=env` returns tags like `env:prod`, `environment:staging`,
77368-
etc.'
77369-
example: env
77370-
in: query
77371-
name: filter[match]
77372-
required: false
77373-
schema:
77374-
type: string
77375-
- description: 'Whether to include tag values in the response.
77376-
77377-
Defaults to true.'
77378-
example: true
77379-
in: query
77380-
name: filter[include_tag_values]
77381-
required: false
77382-
schema:
77383-
type: boolean
77384-
- description: 'Whether to allow partial results.
77385-
77386-
Defaults to false.'
77387-
example: false
77388-
in: query
77389-
name: filter[allow_partial]
77390-
required: false
77391-
schema:
77392-
type: boolean
77393-
- description: Maximum number of results to return.
77394-
example: 1000
77395-
in: query
77396-
name: page[limit]
77397-
required: false
77398-
schema:
77399-
default: 1000000
77400-
format: int32
77401-
maximum: 1000000
77402-
minimum: 1
77403-
type: integer
7740477329
responses:
7740577330
'200':
7740677331
content:
Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
// Create a new dashboard with timeseries widget using order_by values
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.TimeseriesWidgetDefinition;
9+
import com.datadog.api.client.v1.model.TimeseriesWidgetDefinitionType;
10+
import com.datadog.api.client.v1.model.TimeseriesWidgetRequest;
11+
import com.datadog.api.client.v1.model.Widget;
12+
import com.datadog.api.client.v1.model.WidgetDefinition;
13+
import com.datadog.api.client.v1.model.WidgetDisplayType;
14+
import com.datadog.api.client.v1.model.WidgetRequestStyle;
15+
import com.datadog.api.client.v1.model.WidgetStyleOrderBy;
16+
import java.util.Collections;
17+
18+
public class Example {
19+
public static void main(String[] args) {
20+
ApiClient defaultClient = ApiClient.getDefaultApiClient();
21+
DashboardsApi apiInstance = new DashboardsApi(defaultClient);
22+
23+
Dashboard body =
24+
new Dashboard()
25+
.layoutType(DashboardLayoutType.ORDERED)
26+
.title("Example-Dashboard with order_by values")
27+
.widgets(
28+
Collections.singletonList(
29+
new Widget()
30+
.definition(
31+
new WidgetDefinition(
32+
new TimeseriesWidgetDefinition()
33+
.type(TimeseriesWidgetDefinitionType.TIMESERIES)
34+
.requests(
35+
Collections.singletonList(
36+
new TimeseriesWidgetRequest()
37+
.q("avg:system.cpu.user{*} by {host}")
38+
.style(
39+
new WidgetRequestStyle()
40+
.palette("warm")
41+
.orderBy(WidgetStyleOrderBy.VALUES))
42+
.displayType(WidgetDisplayType.LINE)))))));
43+
44+
try {
45+
Dashboard result = apiInstance.createDashboard(body);
46+
System.out.println(result);
47+
} catch (ApiException e) {
48+
System.err.println("Exception when calling DashboardsApi#createDashboard");
49+
System.err.println("Status code: " + e.getCode());
50+
System.err.println("Reason: " + e.getResponseBody());
51+
System.err.println("Response headers: " + e.getResponseHeaders());
52+
e.printStackTrace();
53+
}
54+
}
55+
}
Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
// Create a new dashboard with timeseries widget without order_by for backward compatibility
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.TimeseriesWidgetDefinition;
9+
import com.datadog.api.client.v1.model.TimeseriesWidgetDefinitionType;
10+
import com.datadog.api.client.v1.model.TimeseriesWidgetRequest;
11+
import com.datadog.api.client.v1.model.Widget;
12+
import com.datadog.api.client.v1.model.WidgetDefinition;
13+
import com.datadog.api.client.v1.model.WidgetDisplayType;
14+
import com.datadog.api.client.v1.model.WidgetLineType;
15+
import com.datadog.api.client.v1.model.WidgetLineWidth;
16+
import com.datadog.api.client.v1.model.WidgetRequestStyle;
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+
.layoutType(DashboardLayoutType.ORDERED)
27+
.title("Example-Dashboard without order_by")
28+
.widgets(
29+
Collections.singletonList(
30+
new Widget()
31+
.definition(
32+
new WidgetDefinition(
33+
new TimeseriesWidgetDefinition()
34+
.type(TimeseriesWidgetDefinitionType.TIMESERIES)
35+
.requests(
36+
Collections.singletonList(
37+
new TimeseriesWidgetRequest()
38+
.q("avg:system.cpu.user{*} by {host}")
39+
.style(
40+
new WidgetRequestStyle()
41+
.palette("dog_classic")
42+
.lineType(WidgetLineType.SOLID)
43+
.lineWidth(WidgetLineWidth.NORMAL))
44+
.displayType(WidgetDisplayType.LINE)))))));
45+
46+
try {
47+
Dashboard result = apiInstance.createDashboard(body);
48+
System.out.println(result);
49+
} catch (ApiException e) {
50+
System.err.println("Exception when calling DashboardsApi#createDashboard");
51+
System.err.println("Status code: " + e.getCode());
52+
System.err.println("Reason: " + e.getResponseBody());
53+
System.err.println("Response headers: " + e.getResponseHeaders());
54+
e.printStackTrace();
55+
}
56+
}
57+
}
Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
// Create a new dashboard with timeseries widget using order_by tags
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.TimeseriesWidgetDefinition;
9+
import com.datadog.api.client.v1.model.TimeseriesWidgetDefinitionType;
10+
import com.datadog.api.client.v1.model.TimeseriesWidgetRequest;
11+
import com.datadog.api.client.v1.model.Widget;
12+
import com.datadog.api.client.v1.model.WidgetDefinition;
13+
import com.datadog.api.client.v1.model.WidgetDisplayType;
14+
import com.datadog.api.client.v1.model.WidgetRequestStyle;
15+
import com.datadog.api.client.v1.model.WidgetStyleOrderBy;
16+
import java.util.Collections;
17+
18+
public class Example {
19+
public static void main(String[] args) {
20+
ApiClient defaultClient = ApiClient.getDefaultApiClient();
21+
DashboardsApi apiInstance = new DashboardsApi(defaultClient);
22+
23+
Dashboard body =
24+
new Dashboard()
25+
.layoutType(DashboardLayoutType.ORDERED)
26+
.title("Example-Dashboard with order_by tags")
27+
.widgets(
28+
Collections.singletonList(
29+
new Widget()
30+
.definition(
31+
new WidgetDefinition(
32+
new TimeseriesWidgetDefinition()
33+
.type(TimeseriesWidgetDefinitionType.TIMESERIES)
34+
.requests(
35+
Collections.singletonList(
36+
new TimeseriesWidgetRequest()
37+
.q("avg:system.cpu.user{*} by {host}")
38+
.style(
39+
new WidgetRequestStyle()
40+
.palette("dog_classic")
41+
.orderBy(WidgetStyleOrderBy.TAGS))
42+
.displayType(WidgetDisplayType.LINE)))))));
43+
44+
try {
45+
Dashboard result = apiInstance.createDashboard(body);
46+
System.out.println(result);
47+
} catch (ApiException e) {
48+
System.err.println("Exception when calling DashboardsApi#createDashboard");
49+
System.err.println("Status code: " + e.getCode());
50+
System.err.println("Reason: " + e.getResponseBody());
51+
System.err.println("Response headers: " + e.getResponseHeaders());
52+
e.printStackTrace();
53+
}
54+
}
55+
}

src/main/java/com/datadog/api/client/v1/model/WidgetRequestStyle.java

Lines changed: 34 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@
2020
@JsonPropertyOrder({
2121
WidgetRequestStyle.JSON_PROPERTY_LINE_TYPE,
2222
WidgetRequestStyle.JSON_PROPERTY_LINE_WIDTH,
23+
WidgetRequestStyle.JSON_PROPERTY_ORDER_BY,
2324
WidgetRequestStyle.JSON_PROPERTY_PALETTE
2425
})
2526
@jakarta.annotation.Generated(
@@ -32,6 +33,9 @@ public class WidgetRequestStyle {
3233
public static final String JSON_PROPERTY_LINE_WIDTH = "line_width";
3334
private WidgetLineWidth lineWidth;
3435

36+
public static final String JSON_PROPERTY_ORDER_BY = "order_by";
37+
private WidgetStyleOrderBy orderBy;
38+
3539
public static final String JSON_PROPERTY_PALETTE = "palette";
3640
private String palette;
3741

@@ -85,6 +89,33 @@ public void setLineWidth(WidgetLineWidth lineWidth) {
8589
this.lineWidth = lineWidth;
8690
}
8791

92+
public WidgetRequestStyle orderBy(WidgetStyleOrderBy orderBy) {
93+
this.orderBy = orderBy;
94+
this.unparsed |= !orderBy.isValid();
95+
return this;
96+
}
97+
98+
/**
99+
* How to order series in timeseries visualizations. - <code>tags</code>: Order series
100+
* alphabetically by tag name (default behavior) - <code>values</code>: Order series by their
101+
* current metric values (typically descending)
102+
*
103+
* @return orderBy
104+
*/
105+
@jakarta.annotation.Nullable
106+
@JsonProperty(JSON_PROPERTY_ORDER_BY)
107+
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
108+
public WidgetStyleOrderBy getOrderBy() {
109+
return orderBy;
110+
}
111+
112+
public void setOrderBy(WidgetStyleOrderBy orderBy) {
113+
if (!orderBy.isValid()) {
114+
this.unparsed = true;
115+
}
116+
this.orderBy = orderBy;
117+
}
118+
88119
public WidgetRequestStyle palette(String palette) {
89120
this.palette = palette;
90121
return this;
@@ -164,13 +195,14 @@ public boolean equals(Object o) {
164195
WidgetRequestStyle widgetRequestStyle = (WidgetRequestStyle) o;
165196
return Objects.equals(this.lineType, widgetRequestStyle.lineType)
166197
&& Objects.equals(this.lineWidth, widgetRequestStyle.lineWidth)
198+
&& Objects.equals(this.orderBy, widgetRequestStyle.orderBy)
167199
&& Objects.equals(this.palette, widgetRequestStyle.palette)
168200
&& Objects.equals(this.additionalProperties, widgetRequestStyle.additionalProperties);
169201
}
170202

171203
@Override
172204
public int hashCode() {
173-
return Objects.hash(lineType, lineWidth, palette, additionalProperties);
205+
return Objects.hash(lineType, lineWidth, orderBy, palette, additionalProperties);
174206
}
175207

176208
@Override
@@ -179,6 +211,7 @@ public String toString() {
179211
sb.append("class WidgetRequestStyle {\n");
180212
sb.append(" lineType: ").append(toIndentedString(lineType)).append("\n");
181213
sb.append(" lineWidth: ").append(toIndentedString(lineWidth)).append("\n");
214+
sb.append(" orderBy: ").append(toIndentedString(orderBy)).append("\n");
182215
sb.append(" palette: ").append(toIndentedString(palette)).append("\n");
183216
sb.append(" additionalProperties: ")
184217
.append(toIndentedString(additionalProperties))

0 commit comments

Comments
 (0)