@Generated(value="https://github.com/DataDog/datadog-api-client-java/blob/master/.generator") public class MetricsApi extends Object
| Modifier and Type | Class and Description |
|---|---|
static class |
MetricsApi.EstimateMetricsOutputSeriesOptionalParameters
Manage optional parameters to estimateMetricsOutputSeries.
|
static class |
MetricsApi.ListActiveMetricConfigurationsOptionalParameters
Manage optional parameters to listActiveMetricConfigurations.
|
static class |
MetricsApi.ListTagConfigurationsOptionalParameters
Manage optional parameters to listTagConfigurations.
|
static class |
MetricsApi.SubmitMetricsOptionalParameters
Manage optional parameters to submitMetrics.
|
| Constructor and Description |
|---|
MetricsApi() |
MetricsApi(ApiClient apiClient) |
public MetricsApi()
public MetricsApi(ApiClient apiClient)
public ApiClient getApiClient()
public void setApiClient(ApiClient apiClient)
apiClient - an instance of API clientpublic MetricBulkTagConfigResponse createBulkTagsMetricsConfiguration(MetricBulkTagConfigCreateRequest body) throws ApiException
body - (required)ApiException - if fails to make API callpublic CompletableFuture<MetricBulkTagConfigResponse> createBulkTagsMetricsConfigurationAsync(MetricBulkTagConfigCreateRequest body)
body - (required)public ApiResponse<MetricBulkTagConfigResponse> createBulkTagsMetricsConfigurationWithHttpInfo(MetricBulkTagConfigCreateRequest body) throws ApiException
exclude_tags_mode value will set
all metrics that match the prefix to the same exclusion state, metric tag configurations do not
support mixed inclusion and exclusion for tags on the same metric. Can only be used with
application keys of users with the Manage Tags for Metrics permission.body - (required)ApiException - if fails to make API call| Status Code | Description | Response Headers |
| 202 | Accepted | - |
| 400 | Bad Request | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 429 | Too Many Requests | - |
public CompletableFuture<ApiResponse<MetricBulkTagConfigResponse>> createBulkTagsMetricsConfigurationWithHttpInfoAsync(MetricBulkTagConfigCreateRequest body)
body - (required)public MetricTagConfigurationResponse createTagConfiguration(String metricName, MetricTagConfigurationCreateRequest body) throws ApiException
metricName - The name of the metric. (required)body - (required)ApiException - if fails to make API callpublic CompletableFuture<MetricTagConfigurationResponse> createTagConfigurationAsync(String metricName, MetricTagConfigurationCreateRequest body)
metricName - The name of the metric. (required)body - (required)public ApiResponse<MetricTagConfigurationResponse> createTagConfigurationWithHttpInfo(String metricName, MetricTagConfigurationCreateRequest body) throws ApiException
exclude_tags_mode
to true the behavior is changed from an allow-list to a deny-list, and tags in the
defined list will not be queryable. Can only be used with application keys of users with the
Manage Tags for Metrics permission.metricName - The name of the metric. (required)body - (required)ApiException - if fails to make API call| Status Code | Description | Response Headers |
| 201 | Created | - |
| 400 | Bad Request | - |
| 403 | Forbidden | - |
| 409 | Conflict | - |
| 429 | Too Many Requests | - |
public CompletableFuture<ApiResponse<MetricTagConfigurationResponse>> createTagConfigurationWithHttpInfoAsync(String metricName, MetricTagConfigurationCreateRequest body)
metricName - The name of the metric. (required)body - (required)public MetricBulkTagConfigResponse deleteBulkTagsMetricsConfiguration(MetricBulkTagConfigDeleteRequest body) throws ApiException
body - (required)ApiException - if fails to make API callpublic CompletableFuture<MetricBulkTagConfigResponse> deleteBulkTagsMetricsConfigurationAsync(MetricBulkTagConfigDeleteRequest body)
body - (required)public ApiResponse<MetricBulkTagConfigResponse> deleteBulkTagsMetricsConfigurationWithHttpInfo(MetricBulkTagConfigDeleteRequest body) throws ApiException
Manage Tags for Metrics
permission.body - (required)ApiException - if fails to make API call| Status Code | Description | Response Headers |
| 202 | Accepted | - |
| 400 | Bad Request | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 429 | Too Many Requests | - |
public CompletableFuture<ApiResponse<MetricBulkTagConfigResponse>> deleteBulkTagsMetricsConfigurationWithHttpInfoAsync(MetricBulkTagConfigDeleteRequest body)
body - (required)public void deleteTagConfiguration(String metricName) throws ApiException
metricName - The name of the metric. (required)ApiException - if fails to make API callpublic CompletableFuture<Void> deleteTagConfigurationAsync(String metricName)
See deleteTagConfigurationWithHttpInfoAsync(java.lang.String).
metricName - The name of the metric. (required)public ApiResponse<Void> deleteTagConfigurationWithHttpInfo(String metricName) throws ApiException
Manage Tags for Metrics permission.metricName - The name of the metric. (required)ApiException - if fails to make API call| Status Code | Description | Response Headers |
| 204 | No Content | - |
| 403 | Forbidden | - |
| 404 | Not found | - |
| 429 | Too Many Requests | - |
public CompletableFuture<ApiResponse<Void>> deleteTagConfigurationWithHttpInfoAsync(String metricName)
metricName - The name of the metric. (required)public MetricEstimateResponse estimateMetricsOutputSeries(String metricName) throws ApiException
metricName - The name of the metric. (required)ApiException - if fails to make API callpublic CompletableFuture<MetricEstimateResponse> estimateMetricsOutputSeriesAsync(String metricName)
metricName - The name of the metric. (required)public MetricEstimateResponse estimateMetricsOutputSeries(String metricName, MetricsApi.EstimateMetricsOutputSeriesOptionalParameters parameters) throws ApiException
metricName - The name of the metric. (required)parameters - Optional parameters for the request.ApiException - if fails to make API callpublic CompletableFuture<MetricEstimateResponse> estimateMetricsOutputSeriesAsync(String metricName, MetricsApi.EstimateMetricsOutputSeriesOptionalParameters parameters)
metricName - The name of the metric. (required)parameters - Optional parameters for the request.public ApiResponse<MetricEstimateResponse> estimateMetricsOutputSeriesWithHttpInfo(String metricName, MetricsApi.EstimateMetricsOutputSeriesOptionalParameters parameters) throws ApiException
metricName - The name of the metric. (required)parameters - Optional parameters for the request.ApiException - if fails to make API call| Status Code | Description | Response Headers |
| 200 | Success | - |
| 400 | API error response. | - |
| 403 | API error response. | - |
| 404 | API error response. | - |
| 429 | Too Many Requests | - |
public CompletableFuture<ApiResponse<MetricEstimateResponse>> estimateMetricsOutputSeriesWithHttpInfoAsync(String metricName, MetricsApi.EstimateMetricsOutputSeriesOptionalParameters parameters)
metricName - The name of the metric. (required)parameters - Optional parameters for the request.public MetricSuggestedTagsAndAggregationsResponse listActiveMetricConfigurations(String metricName) throws ApiException
metricName - The name of the metric. (required)ApiException - if fails to make API callpublic CompletableFuture<MetricSuggestedTagsAndAggregationsResponse> listActiveMetricConfigurationsAsync(String metricName)
metricName - The name of the metric. (required)public MetricSuggestedTagsAndAggregationsResponse listActiveMetricConfigurations(String metricName, MetricsApi.ListActiveMetricConfigurationsOptionalParameters parameters) throws ApiException
metricName - The name of the metric. (required)parameters - Optional parameters for the request.ApiException - if fails to make API callpublic CompletableFuture<MetricSuggestedTagsAndAggregationsResponse> listActiveMetricConfigurationsAsync(String metricName, MetricsApi.ListActiveMetricConfigurationsOptionalParameters parameters)
metricName - The name of the metric. (required)parameters - Optional parameters for the request.public ApiResponse<MetricSuggestedTagsAndAggregationsResponse> listActiveMetricConfigurationsWithHttpInfo(String metricName, MetricsApi.ListActiveMetricConfigurationsOptionalParameters parameters) throws ApiException
metricName - The name of the metric. (required)parameters - Optional parameters for the request.ApiException - if fails to make API call| Status Code | Description | Response Headers |
| 200 | Success | - |
| 400 | Bad Request | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 429 | Too Many Requests | - |
public CompletableFuture<ApiResponse<MetricSuggestedTagsAndAggregationsResponse>> listActiveMetricConfigurationsWithHttpInfoAsync(String metricName, MetricsApi.ListActiveMetricConfigurationsOptionalParameters parameters)
metricName - The name of the metric. (required)parameters - Optional parameters for the request.public MetricAssetsResponse listMetricAssets(String metricName) throws ApiException
metricName - The name of the metric. (required)ApiException - if fails to make API callpublic CompletableFuture<MetricAssetsResponse> listMetricAssetsAsync(String metricName)
metricName - The name of the metric. (required)public ApiResponse<MetricAssetsResponse> listMetricAssetsWithHttpInfo(String metricName) throws ApiException
metricName - The name of the metric. (required)ApiException - if fails to make API call| Status Code | Description | Response Headers |
| 200 | Success | - |
| 400 | API error response. | - |
| 403 | API error response. | - |
| 404 | API error response. | - |
| 429 | Too Many Requests | - |
public CompletableFuture<ApiResponse<MetricAssetsResponse>> listMetricAssetsWithHttpInfoAsync(String metricName)
metricName - The name of the metric. (required)public MetricTagConfigurationResponse listTagConfigurationByName(String metricName) throws ApiException
See listTagConfigurationByNameWithHttpInfo(java.lang.String).
metricName - The name of the metric. (required)ApiException - if fails to make API callpublic CompletableFuture<MetricTagConfigurationResponse> listTagConfigurationByNameAsync(String metricName)
See listTagConfigurationByNameWithHttpInfoAsync(java.lang.String).
metricName - The name of the metric. (required)public ApiResponse<MetricTagConfigurationResponse> listTagConfigurationByNameWithHttpInfo(String metricName) throws ApiException
metricName - The name of the metric. (required)ApiException - if fails to make API call| Status Code | Description | Response Headers |
| 200 | Success | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 429 | Too Many Requests | - |
public CompletableFuture<ApiResponse<MetricTagConfigurationResponse>> listTagConfigurationByNameWithHttpInfoAsync(String metricName)
See listTagConfigurationByNameWithHttpInfo(java.lang.String).
metricName - The name of the metric. (required)public MetricsAndMetricTagConfigurationsResponse listTagConfigurations() throws ApiException
ApiException - if fails to make API callpublic CompletableFuture<MetricsAndMetricTagConfigurationsResponse> listTagConfigurationsAsync()
public MetricsAndMetricTagConfigurationsResponse listTagConfigurations(MetricsApi.ListTagConfigurationsOptionalParameters parameters) throws ApiException
parameters - Optional parameters for the request.ApiException - if fails to make API callpublic CompletableFuture<MetricsAndMetricTagConfigurationsResponse> listTagConfigurationsAsync(MetricsApi.ListTagConfigurationsOptionalParameters parameters)
parameters - Optional parameters for the request.public ApiResponse<MetricsAndMetricTagConfigurationsResponse> listTagConfigurationsWithHttpInfo(MetricsApi.ListTagConfigurationsOptionalParameters parameters) throws ApiException
parameters - Optional parameters for the request.ApiException - if fails to make API call| Status Code | Description | Response Headers |
| 200 | Success | - |
| 400 | Bad Request | - |
| 403 | Forbidden | - |
| 429 | Too Many Requests | - |
public CompletableFuture<ApiResponse<MetricsAndMetricTagConfigurationsResponse>> listTagConfigurationsWithHttpInfoAsync(MetricsApi.ListTagConfigurationsOptionalParameters parameters)
parameters - Optional parameters for the request.public MetricAllTagsResponse listTagsByMetricName(String metricName) throws ApiException
metricName - The name of the metric. (required)ApiException - if fails to make API callpublic CompletableFuture<MetricAllTagsResponse> listTagsByMetricNameAsync(String metricName)
See listTagsByMetricNameWithHttpInfoAsync(java.lang.String).
metricName - The name of the metric. (required)public ApiResponse<MetricAllTagsResponse> listTagsByMetricNameWithHttpInfo(String metricName) throws ApiException
metricName - The name of the metric. (required)ApiException - if fails to make API call| Status Code | Description | Response Headers |
| 200 | Success | - |
| 400 | Bad Request | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 429 | Too Many Requests | - |
public CompletableFuture<ApiResponse<MetricAllTagsResponse>> listTagsByMetricNameWithHttpInfoAsync(String metricName)
metricName - The name of the metric. (required)public MetricVolumesResponse listVolumesByMetricName(String metricName) throws ApiException
metricName - The name of the metric. (required)ApiException - if fails to make API callpublic CompletableFuture<MetricVolumesResponse> listVolumesByMetricNameAsync(String metricName)
See listVolumesByMetricNameWithHttpInfoAsync(java.lang.String).
metricName - The name of the metric. (required)public ApiResponse<MetricVolumesResponse> listVolumesByMetricNameWithHttpInfo(String metricName) throws ApiException
Custom metrics generated in-app from other products will return null for
ingested volumes.
metricName - The name of the metric. (required)ApiException - if fails to make API call| Status Code | Description | Response Headers |
| 200 | Success | - |
| 400 | Bad Request | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 429 | Too Many Requests | - |
public CompletableFuture<ApiResponse<MetricVolumesResponse>> listVolumesByMetricNameWithHttpInfoAsync(String metricName)
metricName - The name of the metric. (required)public ScalarFormulaQueryResponse queryScalarData(ScalarFormulaQueryRequest body) throws ApiException
See queryScalarDataWithHttpInfo(com.datadog.api.client.v2.model.ScalarFormulaQueryRequest).
body - (required)ApiException - if fails to make API callpublic CompletableFuture<ScalarFormulaQueryResponse> queryScalarDataAsync(ScalarFormulaQueryRequest body)
See queryScalarDataWithHttpInfoAsync(com.datadog.api.client.v2.model.ScalarFormulaQueryRequest).
body - (required)public ApiResponse<ScalarFormulaQueryResponse> queryScalarDataWithHttpInfo(ScalarFormulaQueryRequest body) throws ApiException
body - (required)ApiException - if fails to make API call| Status Code | Description | Response Headers |
| 200 | OK | - |
| 400 | Bad Request | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 429 | Too many requests | - |
public CompletableFuture<ApiResponse<ScalarFormulaQueryResponse>> queryScalarDataWithHttpInfoAsync(ScalarFormulaQueryRequest body)
See queryScalarDataWithHttpInfo(com.datadog.api.client.v2.model.ScalarFormulaQueryRequest).
body - (required)public TimeseriesFormulaQueryResponse queryTimeseriesData(TimeseriesFormulaQueryRequest body) throws ApiException
See queryTimeseriesDataWithHttpInfo(com.datadog.api.client.v2.model.TimeseriesFormulaQueryRequest).
body - (required)ApiException - if fails to make API callpublic CompletableFuture<TimeseriesFormulaQueryResponse> queryTimeseriesDataAsync(TimeseriesFormulaQueryRequest body)
See queryTimeseriesDataWithHttpInfoAsync(com.datadog.api.client.v2.model.TimeseriesFormulaQueryRequest).
body - (required)public ApiResponse<TimeseriesFormulaQueryResponse> queryTimeseriesDataWithHttpInfo(TimeseriesFormulaQueryRequest body) throws ApiException
body - (required)ApiException - if fails to make API call| Status Code | Description | Response Headers |
| 200 | OK | - |
| 400 | Bad Request | - |
| 401 | Unauthorized | - |
| 403 | Forbidden | - |
| 429 | Too many requests | - |
public CompletableFuture<ApiResponse<TimeseriesFormulaQueryResponse>> queryTimeseriesDataWithHttpInfoAsync(TimeseriesFormulaQueryRequest body)
See queryTimeseriesDataWithHttpInfo(com.datadog.api.client.v2.model.TimeseriesFormulaQueryRequest).
body - (required)public IntakePayloadAccepted submitMetrics(MetricPayload body) throws ApiException
body - (required)ApiException - if fails to make API callpublic CompletableFuture<IntakePayloadAccepted> submitMetricsAsync(MetricPayload body)
body - (required)public IntakePayloadAccepted submitMetrics(MetricPayload body, MetricsApi.SubmitMetricsOptionalParameters parameters) throws ApiException
body - (required)parameters - Optional parameters for the request.ApiException - if fails to make API callpublic CompletableFuture<IntakePayloadAccepted> submitMetricsAsync(MetricPayload body, MetricsApi.SubmitMetricsOptionalParameters parameters)
body - (required)parameters - Optional parameters for the request.public ApiResponse<IntakePayloadAccepted> submitMetricsWithHttpInfo(MetricPayload body, MetricsApi.SubmitMetricsOptionalParameters parameters) throws ApiException
If you’re submitting metrics directly to the Datadog API without using DogStatsD, expect:
Host name is one of the resources in the Resources field.
body - (required)parameters - Optional parameters for the request.ApiException - if fails to make API call| 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 | - |
public CompletableFuture<ApiResponse<IntakePayloadAccepted>> submitMetricsWithHttpInfoAsync(MetricPayload body, MetricsApi.SubmitMetricsOptionalParameters parameters)
body - (required)parameters - Optional parameters for the request.public MetricTagConfigurationResponse updateTagConfiguration(String metricName, MetricTagConfigurationUpdateRequest body) throws ApiException
metricName - The name of the metric. (required)body - (required)ApiException - if fails to make API callpublic CompletableFuture<MetricTagConfigurationResponse> updateTagConfigurationAsync(String metricName, MetricTagConfigurationUpdateRequest body)
metricName - The name of the metric. (required)body - (required)public ApiResponse<MetricTagConfigurationResponse> updateTagConfigurationWithHttpInfo(String metricName, MetricTagConfigurationUpdateRequest body) throws ApiException
exclude_tags_mode
to true the behavior is changed from an allow-list to a deny-list, and tags in the
defined list will not be queryable. Can only be used with application keys from users with the
Manage Tags for Metrics permission. This endpoint requires a tag configuration to
be created first.metricName - The name of the metric. (required)body - (required)ApiException - if fails to make API call| Status Code | Description | Response Headers |
| 200 | OK | - |
| 400 | Bad Request | - |
| 403 | Forbidden | - |
| 422 | Unprocessable Entity | - |
| 429 | Too Many Requests | - |
public CompletableFuture<ApiResponse<MetricTagConfigurationResponse>> updateTagConfigurationWithHttpInfoAsync(String metricName, MetricTagConfigurationUpdateRequest body)
metricName - The name of the metric. (required)body - (required)Copyright © 2024. All rights reserved.