Skip to content

Document missing response fields for the v1 Query timeseries points endpoint #4491

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
dd-octo-sts wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Document missing response fields for the v1 Query timeseries points endpoint #4491

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 33 additions & 0 deletions .generator/schemas/v1/openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8915,6 +8915,11 @@ components:
nullable: true
readOnly: true
type: string
attributes:
additionalProperties: {}
description: Additional read-only attributes returned for the series.
readOnly: true
type: object
display_name:
description: Display name of the metric.
example: system.cpu.idle
Expand Down Expand Up @@ -9020,6 +9025,12 @@ components:
example: time_series
readOnly: true
type: string
resp_version:
description: Version of the response format.
example: 1
format: int64
readOnly: true
type: integer
series:
description: List of timeseries queried.
items:
Expand All @@ -9031,11 +9042,27 @@ components:
example: ok
readOnly: true
type: string
times:
description: |-
Legacy field, always returned as an empty list. Timestamps are returned
in the `pointlist` of each entry of `series`.
items:
description: An unused legacy timestamp.
readOnly: true
type: array
to_date:
description: End of requested time window, milliseconds since Unix epoch.
format: int64
readOnly: true
type: integer
values:
description: |-
Legacy field, always returned as an empty list. Timeseries values are
returned in the `pointlist` of each entry of `series`.
items:
description: An unused legacy value.
readOnly: true
type: array
type: object
MetricsQueryUnit:
description: Object containing the metric unit family, scale factor, name, and short name.
Expand All @@ -9046,6 +9073,12 @@ components:
example: time
readOnly: true
type: string
id:
description: Unit identifier.
example: 17
format: int64
readOnly: true
type: integer
name:
description: Unit name
example: minute
Expand Down
19 changes: 19 additions & 0 deletions src/main/java/com/datadog/api/client/v1/model/MetricsQueryMetadata.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@
/** Object containing all metric names returned and their associated metadata. */
@JsonPropertyOrder({
MetricsQueryMetadata.JSON_PROPERTY_AGGR,
MetricsQueryMetadata.JSON_PROPERTY_ATTRIBUTES,
MetricsQueryMetadata.JSON_PROPERTY_DISPLAY_NAME,
MetricsQueryMetadata.JSON_PROPERTY_END,
MetricsQueryMetadata.JSON_PROPERTY_EXPRESSION,
Expand All @@ -41,6 +42,9 @@ public class MetricsQueryMetadata {
public static final String JSON_PROPERTY_AGGR = "aggr";
private JsonNullable<String> aggr = JsonNullable.<String>undefined();

public static final String JSON_PROPERTY_ATTRIBUTES = "attributes";
private Map<String, Object> attributes = null;

public static final String JSON_PROPERTY_DISPLAY_NAME = "display_name";
private String displayName;

Expand Down Expand Up @@ -103,6 +107,18 @@ private void setAggr_JsonNullable(JsonNullable<String> aggr) {
this.aggr = aggr;
}

/**
* Additional read-only attributes returned for the series.
*
* @return attributes
*/
@jakarta.annotation.Nullable
@JsonProperty(JSON_PROPERTY_ATTRIBUTES)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public Map<String, Object> getAttributes() {
return attributes;
}

/**
* Display name of the metric.
*
Expand Down Expand Up @@ -307,6 +323,7 @@ public boolean equals(Object o) {
}
MetricsQueryMetadata metricsQueryMetadata = (MetricsQueryMetadata) o;
return Objects.equals(this.aggr, metricsQueryMetadata.aggr)
&& Objects.equals(this.attributes, metricsQueryMetadata.attributes)
&& Objects.equals(this.displayName, metricsQueryMetadata.displayName)
&& Objects.equals(this.end, metricsQueryMetadata.end)
&& Objects.equals(this.expression, metricsQueryMetadata.expression)
Expand All @@ -326,6 +343,7 @@ public boolean equals(Object o) {
public int hashCode() {
return Objects.hash(
aggr,
attributes,
displayName,
end,
expression,
Expand All @@ -346,6 +364,7 @@ public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class MetricsQueryMetadata {\n");
sb.append(" aggr: ").append(toIndentedString(aggr)).append("\n");
sb.append(" attributes: ").append(toIndentedString(attributes)).append("\n");
sb.append(" displayName: ").append(toIndentedString(displayName)).append("\n");
sb.append(" end: ").append(toIndentedString(end)).append("\n");
sb.append(" expression: ").append(toIndentedString(expression)).append("\n");
Expand Down
61 changes: 60 additions & 1 deletion src/main/java/com/datadog/api/client/v1/model/MetricsQueryResponse.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,12 @@
MetricsQueryResponse.JSON_PROPERTY_MESSAGE,
MetricsQueryResponse.JSON_PROPERTY_QUERY,
MetricsQueryResponse.JSON_PROPERTY_RES_TYPE,
MetricsQueryResponse.JSON_PROPERTY_RESP_VERSION,
MetricsQueryResponse.JSON_PROPERTY_SERIES,
MetricsQueryResponse.JSON_PROPERTY_STATUS,
MetricsQueryResponse.JSON_PROPERTY_TO_DATE
MetricsQueryResponse.JSON_PROPERTY_TIMES,
MetricsQueryResponse.JSON_PROPERTY_TO_DATE,
MetricsQueryResponse.JSON_PROPERTY_VALUES
})
@jakarta.annotation.Generated(
value = "https://github.com/DataDog/datadog-api-client-java/blob/master/.generator")
Expand All @@ -51,15 +54,24 @@ public class MetricsQueryResponse {
public static final String JSON_PROPERTY_RES_TYPE = "res_type";
private String resType;

public static final String JSON_PROPERTY_RESP_VERSION = "resp_version";
private Long respVersion;

public static final String JSON_PROPERTY_SERIES = "series";
private List<MetricsQueryMetadata> series = null;

public static final String JSON_PROPERTY_STATUS = "status";
private String status;

public static final String JSON_PROPERTY_TIMES = "times";
private List<Object> times = null;

public static final String JSON_PROPERTY_TO_DATE = "to_date";
private Long toDate;

public static final String JSON_PROPERTY_VALUES = "values";
private List<Object> values = null;

/**
* Message indicating the errors if status is not <code>ok</code>.
*
Expand Down Expand Up @@ -132,6 +144,18 @@ public String getResType() {
return resType;
}

/**
* Version of the response format.
*
* @return respVersion
*/
@jakarta.annotation.Nullable
@JsonProperty(JSON_PROPERTY_RESP_VERSION)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public Long getRespVersion() {
return respVersion;
}

/**
* List of timeseries queried.
*
Expand All @@ -156,6 +180,19 @@ public String getStatus() {
return status;
}

/**
* Legacy field, always returned as an empty list. Timestamps are returned in the <code>pointlist
* </code> of each entry of <code>series</code>.
*
* @return times
*/
@jakarta.annotation.Nullable
@JsonProperty(JSON_PROPERTY_TIMES)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public List<Object> getTimes() {
return times;
}

/**
* End of requested time window, milliseconds since Unix epoch.
*
Expand All @@ -168,6 +205,19 @@ public Long getToDate() {
return toDate;
}

/**
* Legacy field, always returned as an empty list. Timeseries values are returned in the <code>
* pointlist</code> of each entry of <code>series</code>.
*
* @return values
*/
@jakarta.annotation.Nullable
@JsonProperty(JSON_PROPERTY_VALUES)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public List<Object> getValues() {
return values;
}

/**
* A container for additional, undeclared properties. This is a holder for any undeclared
* properties as specified with the 'additionalProperties' keyword in the OAS document.
Expand Down Expand Up @@ -230,9 +280,12 @@ public boolean equals(Object o) {
&& Objects.equals(this.message, metricsQueryResponse.message)
&& Objects.equals(this.query, metricsQueryResponse.query)
&& Objects.equals(this.resType, metricsQueryResponse.resType)
&& Objects.equals(this.respVersion, metricsQueryResponse.respVersion)
&& Objects.equals(this.series, metricsQueryResponse.series)
&& Objects.equals(this.status, metricsQueryResponse.status)
&& Objects.equals(this.times, metricsQueryResponse.times)
&& Objects.equals(this.toDate, metricsQueryResponse.toDate)
&& Objects.equals(this.values, metricsQueryResponse.values)
&& Objects.equals(this.additionalProperties, metricsQueryResponse.additionalProperties);
}

Expand All @@ -245,9 +298,12 @@ public int hashCode() {
message,
query,
resType,
respVersion,
series,
status,
times,
toDate,
values,
additionalProperties);
}

Expand All @@ -261,9 +317,12 @@ public String toString() {
sb.append(" message: ").append(toIndentedString(message)).append("\n");
sb.append(" query: ").append(toIndentedString(query)).append("\n");
sb.append(" resType: ").append(toIndentedString(resType)).append("\n");
sb.append(" respVersion: ").append(toIndentedString(respVersion)).append("\n");
sb.append(" series: ").append(toIndentedString(series)).append("\n");
sb.append(" status: ").append(toIndentedString(status)).append("\n");
sb.append(" times: ").append(toIndentedString(times)).append("\n");
sb.append(" toDate: ").append(toIndentedString(toDate)).append("\n");
sb.append(" values: ").append(toIndentedString(values)).append("\n");
sb.append(" additionalProperties: ")
.append(toIndentedString(additionalProperties))
.append("\n");
Expand Down
20 changes: 19 additions & 1 deletion src/main/java/com/datadog/api/client/v1/model/MetricsQueryUnit.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@
/** Object containing the metric unit family, scale factor, name, and short name. */
@JsonPropertyOrder({
MetricsQueryUnit.JSON_PROPERTY_FAMILY,
MetricsQueryUnit.JSON_PROPERTY_ID,
MetricsQueryUnit.JSON_PROPERTY_NAME,
MetricsQueryUnit.JSON_PROPERTY_PLURAL,
MetricsQueryUnit.JSON_PROPERTY_SCALE_FACTOR,
Expand All @@ -31,6 +32,9 @@ public class MetricsQueryUnit {
public static final String JSON_PROPERTY_FAMILY = "family";
private String family;

public static final String JSON_PROPERTY_ID = "id";
private Long id;

public static final String JSON_PROPERTY_NAME = "name";
private String name;

Expand All @@ -55,6 +59,18 @@ public String getFamily() {
return family;
}

/**
* Unit identifier.
*
* @return id
*/
@jakarta.annotation.Nullable
@JsonProperty(JSON_PROPERTY_ID)
@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
public Long getId() {
return id;
}

/**
* Unit name
*
Expand Down Expand Up @@ -160,6 +176,7 @@ public boolean equals(Object o) {
}
MetricsQueryUnit metricsQueryUnit = (MetricsQueryUnit) o;
return Objects.equals(this.family, metricsQueryUnit.family)
&& Objects.equals(this.id, metricsQueryUnit.id)
&& Objects.equals(this.name, metricsQueryUnit.name)
&& Objects.equals(this.plural, metricsQueryUnit.plural)
&& Objects.equals(this.scaleFactor, metricsQueryUnit.scaleFactor)
Expand All @@ -169,14 +186,15 @@ public boolean equals(Object o) {

@Override
public int hashCode() {
return Objects.hash(family, name, plural, scaleFactor, shortName, additionalProperties);
return Objects.hash(family, id, name, plural, scaleFactor, shortName, additionalProperties);
}

@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class MetricsQueryUnit {\n");
sb.append(" family: ").append(toIndentedString(family)).append("\n");
sb.append(" id: ").append(toIndentedString(id)).append("\n");
sb.append(" name: ").append(toIndentedString(name)).append("\n");
sb.append(" plural: ").append(toIndentedString(plural)).append("\n");
sb.append(" scaleFactor: ").append(toIndentedString(scaleFactor)).append("\n");
Expand Down
Loading