com.datadog.api.client.v1.api

Class MetricsApi

java.lang.Object

com.datadog.api.client.v1.api.MetricsApi

@Generated(value="https://github.com/DataDog/datadog-api-client-java/blob/master/.generator")
public class MetricsApi
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MetricsApi.ListActiveMetricsOptionalParameters Manage optional parameters to listActiveMetrics.
static class	MetricsApi.SubmitDistributionPointsOptionalParameters Manage optional parameters to submitDistributionPoints.
static class	MetricsApi.SubmitMetricsOptionalParameters Manage optional parameters to submitMetrics.

Constructor Summary

Constructors

Constructor and Description
MetricsApi()
MetricsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient() Get the API client.
MetricMetadata	getMetricMetadata(String metricName) Get metric metadata.
CompletableFuture<MetricMetadata>	getMetricMetadataAsync(String metricName) Get metric metadata.
ApiResponse<MetricMetadata>	getMetricMetadataWithHttpInfo(String metricName) Get metadata about a specific metric.
CompletableFuture<ApiResponse<MetricMetadata>>	getMetricMetadataWithHttpInfoAsync(String metricName) Get metric metadata.
MetricsListResponse	listActiveMetrics(Long from) Get active metrics list.
MetricsListResponse	listActiveMetrics(Long from, MetricsApi.ListActiveMetricsOptionalParameters parameters) Get active metrics list.
CompletableFuture<MetricsListResponse>	listActiveMetricsAsync(Long from) Get active metrics list.
CompletableFuture<MetricsListResponse>	listActiveMetricsAsync(Long from, MetricsApi.ListActiveMetricsOptionalParameters parameters) Get active metrics list.
ApiResponse<MetricsListResponse>	listActiveMetricsWithHttpInfo(Long from, MetricsApi.ListActiveMetricsOptionalParameters parameters) Get the list of actively reporting metrics from a given time until now.
CompletableFuture<ApiResponse<MetricsListResponse>>	listActiveMetricsWithHttpInfoAsync(Long from, MetricsApi.ListActiveMetricsOptionalParameters parameters) Get active metrics list.
MetricSearchResponse	listMetrics(String q) Search metrics.
CompletableFuture<MetricSearchResponse>	listMetricsAsync(String q) Search metrics.
ApiResponse<MetricSearchResponse>	listMetricsWithHttpInfo(String q) Search for metrics from the last 24 hours in Datadog.
CompletableFuture<ApiResponse<MetricSearchResponse>>	listMetricsWithHttpInfoAsync(String q) Search metrics.
MetricsQueryResponse	queryMetrics(Long from, Long to, String query) Query timeseries points.
CompletableFuture<MetricsQueryResponse>	queryMetricsAsync(Long from, Long to, String query) Query timeseries points.
ApiResponse<MetricsQueryResponse>	queryMetricsWithHttpInfo(Long from, Long to, String query) Query timeseries points.
CompletableFuture<ApiResponse<MetricsQueryResponse>>	queryMetricsWithHttpInfoAsync(Long from, Long to, String query) Query timeseries points.
void	setApiClient(ApiClient apiClient) Set the API client.
IntakePayloadAccepted	submitDistributionPoints(DistributionPointsPayload body) Submit distribution points.
IntakePayloadAccepted	submitDistributionPoints(DistributionPointsPayload body, MetricsApi.SubmitDistributionPointsOptionalParameters parameters) Submit distribution points.
CompletableFuture<IntakePayloadAccepted>	submitDistributionPointsAsync(DistributionPointsPayload body) Submit distribution points.
CompletableFuture<IntakePayloadAccepted>	submitDistributionPointsAsync(DistributionPointsPayload body, MetricsApi.SubmitDistributionPointsOptionalParameters parameters) Submit distribution points.
ApiResponse<IntakePayloadAccepted>	submitDistributionPointsWithHttpInfo(DistributionPointsPayload body, MetricsApi.SubmitDistributionPointsOptionalParameters parameters) The distribution points end-point allows you to post distribution data that can be graphed on Datadog’s dashboards.
CompletableFuture<ApiResponse<IntakePayloadAccepted>>	submitDistributionPointsWithHttpInfoAsync(DistributionPointsPayload body, MetricsApi.SubmitDistributionPointsOptionalParameters parameters) Submit distribution points.
IntakePayloadAccepted	submitMetrics(MetricsPayload body) Submit metrics.
IntakePayloadAccepted	submitMetrics(MetricsPayload body, MetricsApi.SubmitMetricsOptionalParameters parameters) Submit metrics.
CompletableFuture<IntakePayloadAccepted>	submitMetricsAsync(MetricsPayload body) Submit metrics.
CompletableFuture<IntakePayloadAccepted>	submitMetricsAsync(MetricsPayload body, MetricsApi.SubmitMetricsOptionalParameters parameters) Submit metrics.
ApiResponse<IntakePayloadAccepted>	submitMetricsWithHttpInfo(MetricsPayload body, MetricsApi.SubmitMetricsOptionalParameters parameters) The metrics end-point allows you to post time-series data that can be graphed on Datadog’s dashboards.
CompletableFuture<ApiResponse<IntakePayloadAccepted>>	submitMetricsWithHttpInfoAsync(MetricsPayload body, MetricsApi.SubmitMetricsOptionalParameters parameters) Submit metrics.
MetricMetadata	updateMetricMetadata(String metricName, MetricMetadata body) Edit metric metadata.
CompletableFuture<MetricMetadata>	updateMetricMetadataAsync(String metricName, MetricMetadata body) Edit metric metadata.
ApiResponse<MetricMetadata>	updateMetricMetadataWithHttpInfo(String metricName, MetricMetadata body) Edit metadata of a specific metric.
CompletableFuture<ApiResponse<MetricMetadata>>	updateMetricMetadataWithHttpInfoAsync(String metricName, MetricMetadata body) Edit metric metadata.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MetricsApi

public MetricsApi()

MetricsApi

public MetricsApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

Get the API client.

Returns:

API client

setApiClient

public void setApiClient(ApiClient apiClient)

Set the API client.

Parameters:

apiClient - an instance of API client

getMetricMetadata

public MetricMetadata getMetricMetadata(String metricName)
                                 throws ApiException

Get metric metadata.

See getMetricMetadataWithHttpInfo(java.lang.String).

Parameters:

metricName - Name of the metric for which to get metadata. (required)

Returns:

MetricMetadata

Throws:

ApiException - if fails to make API call

getMetricMetadataAsync

public CompletableFuture<MetricMetadata> getMetricMetadataAsync(String metricName)

Get metric metadata.

See getMetricMetadataWithHttpInfoAsync(java.lang.String).

Parameters:

metricName - Name of the metric for which to get metadata. (required)

Returns:

CompletableFuture<MetricMetadata>

getMetricMetadataWithHttpInfo

public ApiResponse<MetricMetadata> getMetricMetadataWithHttpInfo(String metricName)
                                                          throws ApiException

Get metadata about a specific metric.

Parameters:

metricName - Name of the metric for which to get metadata. (required)

Returns:

ApiResponse<MetricMetadata>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK	-
403	Forbidden	-
404	Not Found	-
429	Too many requests	-

getMetricMetadataWithHttpInfoAsync

public CompletableFuture<ApiResponse<MetricMetadata>> getMetricMetadataWithHttpInfoAsync(String metricName)

Get metric metadata.

See getMetricMetadataWithHttpInfo(java.lang.String).

Parameters:

metricName - Name of the metric for which to get metadata. (required)

Returns:

CompletableFuture<ApiResponse<MetricMetadata>>

listActiveMetrics

public MetricsListResponse listActiveMetrics(Long from)
                                      throws ApiException

Get active metrics list.

See listActiveMetricsWithHttpInfo(java.lang.Long, com.datadog.api.client.v1.api.MetricsApi.ListActiveMetricsOptionalParameters).

Parameters:

from - Seconds since the Unix epoch. (required)

Returns:

MetricsListResponse

Throws:

ApiException - if fails to make API call

listActiveMetricsAsync

public CompletableFuture<MetricsListResponse> listActiveMetricsAsync(Long from)

Get active metrics list.

See listActiveMetricsWithHttpInfoAsync(java.lang.Long, com.datadog.api.client.v1.api.MetricsApi.ListActiveMetricsOptionalParameters).

Parameters:

from - Seconds since the Unix epoch. (required)

Returns:

CompletableFuture<MetricsListResponse>

listActiveMetrics

public MetricsListResponse listActiveMetrics(Long from,
                                             MetricsApi.ListActiveMetricsOptionalParameters parameters)
                                      throws ApiException

Get active metrics list.

See listActiveMetricsWithHttpInfo(java.lang.Long, com.datadog.api.client.v1.api.MetricsApi.ListActiveMetricsOptionalParameters).

Parameters:

from - Seconds since the Unix epoch. (required)

parameters - Optional parameters for the request.

Returns:

MetricsListResponse

Throws:

ApiException - if fails to make API call

listActiveMetricsAsync

public CompletableFuture<MetricsListResponse> listActiveMetricsAsync(Long from,
                                                                     MetricsApi.ListActiveMetricsOptionalParameters parameters)

Get active metrics list.

See listActiveMetricsWithHttpInfoAsync(java.lang.Long, com.datadog.api.client.v1.api.MetricsApi.ListActiveMetricsOptionalParameters).

Parameters:

from - Seconds since the Unix epoch. (required)

parameters - Optional parameters for the request.

Returns:

CompletableFuture<MetricsListResponse>

listActiveMetricsWithHttpInfo

public ApiResponse<MetricsListResponse> listActiveMetricsWithHttpInfo(Long from,
                                                                      MetricsApi.ListActiveMetricsOptionalParameters parameters)
                                                               throws ApiException

Get the list of actively reporting metrics from a given time until now.

Parameters:

from - Seconds since the Unix epoch. (required)

parameters - Optional parameters for the request.

Returns:

ApiResponse<MetricsListResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK	-
400	Bad Request	-
403	Forbidden	-
429	Too many requests	-

listActiveMetricsWithHttpInfoAsync

public CompletableFuture<ApiResponse<MetricsListResponse>> listActiveMetricsWithHttpInfoAsync(Long from,
                                                                                              MetricsApi.ListActiveMetricsOptionalParameters parameters)

Get active metrics list.

See listActiveMetricsWithHttpInfo(java.lang.Long, com.datadog.api.client.v1.api.MetricsApi.ListActiveMetricsOptionalParameters).

Parameters:

from - Seconds since the Unix epoch. (required)

parameters - Optional parameters for the request.

Returns:

CompletableFuture<ApiResponse<MetricsListResponse>>

listMetrics

public MetricSearchResponse listMetrics(String q)
                                 throws ApiException

Search metrics.

See listMetricsWithHttpInfo(java.lang.String).

Parameters:

q - Query string to search metrics upon. Can optionally be prefixed with metrics: . (required)

Returns:

MetricSearchResponse

Throws:

ApiException - if fails to make API call

listMetricsAsync

public CompletableFuture<MetricSearchResponse> listMetricsAsync(String q)

Search metrics.

See listMetricsWithHttpInfoAsync(java.lang.String).

Parameters:

q - Query string to search metrics upon. Can optionally be prefixed with metrics: . (required)

Returns:

CompletableFuture<MetricSearchResponse>

listMetricsWithHttpInfo

public ApiResponse<MetricSearchResponse> listMetricsWithHttpInfo(String q)
                                                          throws ApiException

Search for metrics from the last 24 hours in Datadog.

Parameters:

q - Query string to search metrics upon. Can optionally be prefixed with metrics: . (required)

Returns:

ApiResponse<MetricSearchResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK	-
400	Bad Request	-
403	Forbidden	-
429	Too many requests	-

listMetricsWithHttpInfoAsync

public CompletableFuture<ApiResponse<MetricSearchResponse>> listMetricsWithHttpInfoAsync(String q)

Search metrics.

See listMetricsWithHttpInfo(java.lang.String).

Parameters:

q - Query string to search metrics upon. Can optionally be prefixed with metrics: . (required)

Returns:

CompletableFuture<ApiResponse<MetricSearchResponse>>

queryMetrics

public MetricsQueryResponse queryMetrics(Long from,
                                         Long to,
                                         String query)
                                  throws ApiException

Query timeseries points.

See queryMetricsWithHttpInfo(java.lang.Long, java.lang.Long, java.lang.String).

Parameters:

from - Start of the queried time period, seconds since the Unix epoch. (required)

to - End of the queried time period, seconds since the Unix epoch. (required)

query - Query string. (required)

Returns:

MetricsQueryResponse

Throws:

ApiException - if fails to make API call

queryMetricsAsync

public CompletableFuture<MetricsQueryResponse> queryMetricsAsync(Long from,
                                                                 Long to,
                                                                 String query)

Query timeseries points.

See queryMetricsWithHttpInfoAsync(java.lang.Long, java.lang.Long, java.lang.String).

Parameters:

from - Start of the queried time period, seconds since the Unix epoch. (required)

to - End of the queried time period, seconds since the Unix epoch. (required)

query - Query string. (required)

Returns:

CompletableFuture<MetricsQueryResponse>

queryMetricsWithHttpInfo

public ApiResponse<MetricsQueryResponse> queryMetricsWithHttpInfo(Long from,
                                                                  Long to,
                                                                  String query)
                                                           throws ApiException

Query timeseries points.

Parameters:

from - Start of the queried time period, seconds since the Unix epoch. (required)

to - End of the queried time period, seconds since the Unix epoch. (required)

query - Query string. (required)

Returns:

ApiResponse<MetricsQueryResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK	-
400	Bad Request	-
403	Forbidden	-
429	Too many requests	-

queryMetricsWithHttpInfoAsync

public CompletableFuture<ApiResponse<MetricsQueryResponse>> queryMetricsWithHttpInfoAsync(Long from,
                                                                                          Long to,
                                                                                          String query)

Query timeseries points.

See queryMetricsWithHttpInfo(java.lang.Long, java.lang.Long, java.lang.String).

Parameters:

from - Start of the queried time period, seconds since the Unix epoch. (required)

to - End of the queried time period, seconds since the Unix epoch. (required)

query - Query string. (required)

Returns:

CompletableFuture<ApiResponse<MetricsQueryResponse>>

submitDistributionPoints

public IntakePayloadAccepted submitDistributionPoints(DistributionPointsPayload body)
                                               throws ApiException

Submit distribution points.

See submitDistributionPointsWithHttpInfo(com.datadog.api.client.v1.model.DistributionPointsPayload, com.datadog.api.client.v1.api.MetricsApi.SubmitDistributionPointsOptionalParameters).

Parameters:

body - (required)

Returns:

IntakePayloadAccepted

Throws:

ApiException - if fails to make API call

submitDistributionPointsAsync

public CompletableFuture<IntakePayloadAccepted> submitDistributionPointsAsync(DistributionPointsPayload body)

Submit distribution points.

See submitDistributionPointsWithHttpInfoAsync(com.datadog.api.client.v1.model.DistributionPointsPayload, com.datadog.api.client.v1.api.MetricsApi.SubmitDistributionPointsOptionalParameters).

Parameters:

body - (required)

Returns:

CompletableFuture<IntakePayloadAccepted>

submitDistributionPoints

public IntakePayloadAccepted submitDistributionPoints(DistributionPointsPayload body,
                                                      MetricsApi.SubmitDistributionPointsOptionalParameters parameters)
                                               throws ApiException

Submit distribution points.

See submitDistributionPointsWithHttpInfo(com.datadog.api.client.v1.model.DistributionPointsPayload, com.datadog.api.client.v1.api.MetricsApi.SubmitDistributionPointsOptionalParameters).

Parameters:

body - (required)

parameters - Optional parameters for the request.

Returns:

IntakePayloadAccepted

Throws:

ApiException - if fails to make API call

submitDistributionPointsAsync

public CompletableFuture<IntakePayloadAccepted> submitDistributionPointsAsync(DistributionPointsPayload body,
                                                                              MetricsApi.SubmitDistributionPointsOptionalParameters parameters)

Submit distribution points.

See submitDistributionPointsWithHttpInfoAsync(com.datadog.api.client.v1.model.DistributionPointsPayload, com.datadog.api.client.v1.api.MetricsApi.SubmitDistributionPointsOptionalParameters).

Parameters:

body - (required)

parameters - Optional parameters for the request.

Returns:

CompletableFuture<IntakePayloadAccepted>

submitDistributionPointsWithHttpInfo

public ApiResponse<IntakePayloadAccepted> submitDistributionPointsWithHttpInfo(DistributionPointsPayload body,
                                                                               MetricsApi.SubmitDistributionPointsOptionalParameters parameters)
                                                                        throws ApiException

The distribution points end-point allows you to post distribution data that can be graphed on Datadog’s dashboards.

Parameters:

body - (required)

parameters - Optional parameters for the request.

Returns:

ApiResponse<IntakePayloadAccepted>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
202	Payload accepted	-
400	Bad Request	-
403	Authentication error	-
408	Request timeout	-
413	Payload too large	-
429	Too many requests	-

submitDistributionPointsWithHttpInfoAsync

public CompletableFuture<ApiResponse<IntakePayloadAccepted>> submitDistributionPointsWithHttpInfoAsync(DistributionPointsPayload body,
                                                                                                       MetricsApi.SubmitDistributionPointsOptionalParameters parameters)

Submit distribution points.

See submitDistributionPointsWithHttpInfo(com.datadog.api.client.v1.model.DistributionPointsPayload, com.datadog.api.client.v1.api.MetricsApi.SubmitDistributionPointsOptionalParameters).

Parameters:

body - (required)

parameters - Optional parameters for the request.

Returns:

CompletableFuture<ApiResponse<IntakePayloadAccepted>>

submitMetrics

public IntakePayloadAccepted submitMetrics(MetricsPayload body)
                                    throws ApiException

Submit metrics.

See submitMetricsWithHttpInfo(com.datadog.api.client.v1.model.MetricsPayload, com.datadog.api.client.v1.api.MetricsApi.SubmitMetricsOptionalParameters).

Parameters:

body - (required)

Returns:

IntakePayloadAccepted

Throws:

ApiException - if fails to make API call

submitMetricsAsync

public CompletableFuture<IntakePayloadAccepted> submitMetricsAsync(MetricsPayload body)

Submit metrics.

See submitMetricsWithHttpInfoAsync(com.datadog.api.client.v1.model.MetricsPayload, com.datadog.api.client.v1.api.MetricsApi.SubmitMetricsOptionalParameters).

Parameters:

body - (required)

Returns:

CompletableFuture<IntakePayloadAccepted>

submitMetrics

public IntakePayloadAccepted submitMetrics(MetricsPayload body,
                                           MetricsApi.SubmitMetricsOptionalParameters parameters)
                                    throws ApiException

Submit metrics.

See submitMetricsWithHttpInfo(com.datadog.api.client.v1.model.MetricsPayload, com.datadog.api.client.v1.api.MetricsApi.SubmitMetricsOptionalParameters).

Parameters:

body - (required)

parameters - Optional parameters for the request.

Returns:

IntakePayloadAccepted

Throws:

ApiException - if fails to make API call

submitMetricsAsync

public CompletableFuture<IntakePayloadAccepted> submitMetricsAsync(MetricsPayload body,
                                                                   MetricsApi.SubmitMetricsOptionalParameters parameters)

Submit metrics.

See submitMetricsWithHttpInfoAsync(com.datadog.api.client.v1.model.MetricsPayload, com.datadog.api.client.v1.api.MetricsApi.SubmitMetricsOptionalParameters).

Parameters:

body - (required)

parameters - Optional parameters for the request.

Returns:

CompletableFuture<IntakePayloadAccepted>

submitMetricsWithHttpInfo

public ApiResponse<IntakePayloadAccepted> submitMetricsWithHttpInfo(MetricsPayload body,
                                                                    MetricsApi.SubmitMetricsOptionalParameters parameters)
                                                             throws ApiException

The metrics end-point allows you to post time-series data that can be graphed on Datadog’s dashboards. The maximum payload size is 3.2 megabytes (3200000 bytes). Compressed payloads must have a decompressed size of less than 62 megabytes (62914560 bytes).

If you’re submitting metrics directly to the Datadog API without using DogStatsD, expect:

• 64 bits for the timestamp
• 64 bits for the value
• 40 bytes for the metric names
• 50 bytes for the timeseries
• The full payload is approximately 100 bytes. However, with the DogStatsD API, compression is applied, which reduces the payload size.

Parameters:

body - (required)

parameters - Optional parameters for the request.

Returns:

ApiResponse<IntakePayloadAccepted>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
202	Payload accepted	-
400	Bad Request	-
403	Authentication error	-
408	Request timeout	-
413	Payload too large	-
429	Too many requests	-

submitMetricsWithHttpInfoAsync

public CompletableFuture<ApiResponse<IntakePayloadAccepted>> submitMetricsWithHttpInfoAsync(MetricsPayload body,
                                                                                            MetricsApi.SubmitMetricsOptionalParameters parameters)

Submit metrics.

See submitMetricsWithHttpInfo(com.datadog.api.client.v1.model.MetricsPayload, com.datadog.api.client.v1.api.MetricsApi.SubmitMetricsOptionalParameters).

Parameters:

body - (required)

parameters - Optional parameters for the request.

Returns:

CompletableFuture<ApiResponse<IntakePayloadAccepted>>

updateMetricMetadata

public MetricMetadata updateMetricMetadata(String metricName,
                                           MetricMetadata body)
                                    throws ApiException

Edit metric metadata.

See updateMetricMetadataWithHttpInfo(java.lang.String, com.datadog.api.client.v1.model.MetricMetadata).

Parameters:

metricName - Name of the metric for which to edit metadata. (required)

body - New metadata. (required)

Returns:

MetricMetadata

Throws:

ApiException - if fails to make API call

updateMetricMetadataAsync

public CompletableFuture<MetricMetadata> updateMetricMetadataAsync(String metricName,
                                                                   MetricMetadata body)

Edit metric metadata.

See updateMetricMetadataWithHttpInfoAsync(java.lang.String, com.datadog.api.client.v1.model.MetricMetadata).

Parameters:

metricName - Name of the metric for which to edit metadata. (required)

body - New metadata. (required)

Returns:

CompletableFuture<MetricMetadata>

updateMetricMetadataWithHttpInfo

public ApiResponse<MetricMetadata> updateMetricMetadataWithHttpInfo(String metricName,
                                                                    MetricMetadata body)
                                                             throws ApiException

Edit metadata of a specific metric. Find out more about supported types.

Parameters:

metricName - Name of the metric for which to edit metadata. (required)

body - New metadata. (required)

Returns:

ApiResponse<MetricMetadata>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK	-
400	Bad Request	-
403	Forbidden	-
404	Not Found	-
429	Too many requests	-

updateMetricMetadataWithHttpInfoAsync

public CompletableFuture<ApiResponse<MetricMetadata>> updateMetricMetadataWithHttpInfoAsync(String metricName,
                                                                                            MetricMetadata body)

Edit metric metadata.

See updateMetricMetadataWithHttpInfo(java.lang.String, com.datadog.api.client.v1.model.MetricMetadata).

Parameters:

metricName - Name of the metric for which to edit metadata. (required)

body - New metadata. (required)

Returns:

CompletableFuture<ApiResponse<MetricMetadata>>