Package com.datadog.api.client.v2.api

Class SpansMetricsApi

java.lang.Object

com.datadog.api.client.v2.api.SpansMetricsApi

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

Constructor Summary

Constructors

Constructor	Description
SpansMetricsApi()
SpansMetricsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
SpansMetricResponse	createSpansMetric(SpansMetricCreateRequest body)	Create a span-based metric.
CompletableFuture<SpansMetricResponse>	createSpansMetricAsync(SpansMetricCreateRequest body)	Create a span-based metric.
ApiResponse<SpansMetricResponse>	createSpansMetricWithHttpInfo(SpansMetricCreateRequest body)	Create a metric based on your ingested spans in your organization.
CompletableFuture<ApiResponse<SpansMetricResponse>>	createSpansMetricWithHttpInfoAsync(SpansMetricCreateRequest body)	Create a span-based metric.
void	deleteSpansMetric(String metricId)	Delete a span-based metric.
CompletableFuture<Void>	deleteSpansMetricAsync(String metricId)	Delete a span-based metric.
ApiResponse<Void>	deleteSpansMetricWithHttpInfo(String metricId)	Delete a specific span-based metric from your organization.
CompletableFuture<ApiResponse<Void>>	deleteSpansMetricWithHttpInfoAsync(String metricId)	Delete a span-based metric.
ApiClient	getApiClient()	Get the API client.
SpansMetricResponse	getSpansMetric(String metricId)	Get a span-based metric.
CompletableFuture<SpansMetricResponse>	getSpansMetricAsync(String metricId)	Get a span-based metric.
ApiResponse<SpansMetricResponse>	getSpansMetricWithHttpInfo(String metricId)	Get a specific span-based metric from your organization.
CompletableFuture<ApiResponse<SpansMetricResponse>>	getSpansMetricWithHttpInfoAsync(String metricId)	Get a span-based metric.
SpansMetricsResponse	listSpansMetrics()	Get all span-based metrics.
CompletableFuture<SpansMetricsResponse>	listSpansMetricsAsync()	Get all span-based metrics.
ApiResponse<SpansMetricsResponse>	listSpansMetricsWithHttpInfo()	Get the list of configured span-based metrics with their definitions.
CompletableFuture<ApiResponse<SpansMetricsResponse>>	listSpansMetricsWithHttpInfoAsync()	Get all span-based metrics.
void	setApiClient(ApiClient apiClient)	Set the API client.
SpansMetricResponse	updateSpansMetric(String metricId, SpansMetricUpdateRequest body)	Update a span-based metric.
CompletableFuture<SpansMetricResponse>	updateSpansMetricAsync(String metricId, SpansMetricUpdateRequest body)	Update a span-based metric.
ApiResponse<SpansMetricResponse>	updateSpansMetricWithHttpInfo(String metricId, SpansMetricUpdateRequest body)	Update a specific span-based metric from your organization.
CompletableFuture<ApiResponse<SpansMetricResponse>>	updateSpansMetricWithHttpInfoAsync(String metricId, SpansMetricUpdateRequest body)	Update a span-based metric.

Methods inherited from class java.lang.Object

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

Constructor Details

SpansMetricsApi

public SpansMetricsApi()

SpansMetricsApi

public SpansMetricsApi(ApiClient apiClient)

Method Details

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

createSpansMetric

public SpansMetricResponse createSpansMetric(SpansMetricCreateRequest body)
                                      throws ApiException

Create a span-based metric.

See createSpansMetricWithHttpInfo(com.datadog.api.client.v2.model.SpansMetricCreateRequest).

Parameters:

body - The definition of the new span-based metric. (required)

Returns:

SpansMetricResponse

Throws:

ApiException - if fails to make API call

createSpansMetricAsync

public CompletableFuture<SpansMetricResponse> createSpansMetricAsync(SpansMetricCreateRequest body)

Create a span-based metric.

See createSpansMetricWithHttpInfoAsync(com.datadog.api.client.v2.model.SpansMetricCreateRequest).

Parameters:

body - The definition of the new span-based metric. (required)

Returns:

CompletableFuture<SpansMetricResponse>

createSpansMetricWithHttpInfo

public ApiResponse<SpansMetricResponse> createSpansMetricWithHttpInfo(SpansMetricCreateRequest body)
                                                               throws ApiException

Create a metric based on your ingested spans in your organization. Returns the span-based metric object from the request body when the request is successful.

Parameters:

body - The definition of the new span-based metric. (required)

Returns:

ApiResponse<SpansMetricResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK	-
400	Bad Request	-
403	Not Authorized	-
409	Conflict	-
429	Too many requests	-

createSpansMetricWithHttpInfoAsync

public CompletableFuture<ApiResponse<SpansMetricResponse>> createSpansMetricWithHttpInfoAsync(SpansMetricCreateRequest body)

Create a span-based metric.

See createSpansMetricWithHttpInfo(com.datadog.api.client.v2.model.SpansMetricCreateRequest).

Parameters:

body - The definition of the new span-based metric. (required)

Returns:

CompletableFuture<ApiResponse<SpansMetricResponse>>

deleteSpansMetric

public void deleteSpansMetric(String metricId)
                       throws ApiException

Delete a span-based metric.

See deleteSpansMetricWithHttpInfo(java.lang.String).

Parameters:

metricId - The name of the span-based metric. (required)

Throws:

ApiException - if fails to make API call

deleteSpansMetricAsync

public CompletableFuture<Void> deleteSpansMetricAsync(String metricId)

Delete a span-based metric.

See deleteSpansMetricWithHttpInfoAsync(java.lang.String).

Parameters:

metricId - The name of the span-based metric. (required)

Returns:

CompletableFuture

deleteSpansMetricWithHttpInfo

public ApiResponse<Void> deleteSpansMetricWithHttpInfo(String metricId)
                                                throws ApiException

Delete a specific span-based metric from your organization.

Parameters:

metricId - The name of the span-based metric. (required)

Returns:

ApiResponse<Void>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
204	OK	-
403	Not Authorized	-
404	Not Found	-
429	Too many requests	-

deleteSpansMetricWithHttpInfoAsync

public CompletableFuture<ApiResponse<Void>> deleteSpansMetricWithHttpInfoAsync(String metricId)

Delete a span-based metric.

See deleteSpansMetricWithHttpInfo(java.lang.String).

Parameters:

metricId - The name of the span-based metric. (required)

Returns:

CompletableFuture<ApiResponse<Void>>

getSpansMetric

public SpansMetricResponse getSpansMetric(String metricId)
                                   throws ApiException

Get a span-based metric.

See getSpansMetricWithHttpInfo(java.lang.String).

Parameters:

metricId - The name of the span-based metric. (required)

Returns:

SpansMetricResponse

Throws:

ApiException - if fails to make API call

getSpansMetricAsync

public CompletableFuture<SpansMetricResponse> getSpansMetricAsync(String metricId)

Get a span-based metric.

See getSpansMetricWithHttpInfoAsync(java.lang.String).

Parameters:

metricId - The name of the span-based metric. (required)

Returns:

CompletableFuture<SpansMetricResponse>

getSpansMetricWithHttpInfo

public ApiResponse<SpansMetricResponse> getSpansMetricWithHttpInfo(String metricId)
                                                            throws ApiException

Get a specific span-based metric from your organization.

Parameters:

metricId - The name of the span-based metric. (required)

Returns:

ApiResponse<SpansMetricResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

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

getSpansMetricWithHttpInfoAsync

public CompletableFuture<ApiResponse<SpansMetricResponse>> getSpansMetricWithHttpInfoAsync(String metricId)

Get a span-based metric.

See getSpansMetricWithHttpInfo(java.lang.String).

Parameters:

metricId - The name of the span-based metric. (required)

Returns:

CompletableFuture<ApiResponse<SpansMetricResponse>>

listSpansMetrics

public SpansMetricsResponse listSpansMetrics()
                                      throws ApiException

Get all span-based metrics.

See listSpansMetricsWithHttpInfo().

Returns:

SpansMetricsResponse

Throws:

ApiException - if fails to make API call

listSpansMetricsAsync

public CompletableFuture<SpansMetricsResponse> listSpansMetricsAsync()

Get all span-based metrics.

See listSpansMetricsWithHttpInfoAsync().

Returns:

CompletableFuture<SpansMetricsResponse>

listSpansMetricsWithHttpInfo

public ApiResponse<SpansMetricsResponse> listSpansMetricsWithHttpInfo()
                                                               throws ApiException

Get the list of configured span-based metrics with their definitions.

Returns:

ApiResponse<SpansMetricsResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK	-
403	Not Authorized	-
429	Too many requests	-

listSpansMetricsWithHttpInfoAsync

public CompletableFuture<ApiResponse<SpansMetricsResponse>> listSpansMetricsWithHttpInfoAsync()

Get all span-based metrics.

See listSpansMetricsWithHttpInfo().

Returns:

CompletableFuture<ApiResponse<SpansMetricsResponse>>

updateSpansMetric

public SpansMetricResponse updateSpansMetric(String metricId,
 SpansMetricUpdateRequest body)
                                      throws ApiException

Update a span-based metric.

See updateSpansMetricWithHttpInfo(java.lang.String, com.datadog.api.client.v2.model.SpansMetricUpdateRequest).

Parameters:

metricId - The name of the span-based metric. (required)

body - New definition of the span-based metric. (required)

Returns:

SpansMetricResponse

Throws:

ApiException - if fails to make API call

updateSpansMetricAsync

public CompletableFuture<SpansMetricResponse> updateSpansMetricAsync(String metricId,
 SpansMetricUpdateRequest body)

Update a span-based metric.

See updateSpansMetricWithHttpInfoAsync(java.lang.String, com.datadog.api.client.v2.model.SpansMetricUpdateRequest).

Parameters:

metricId - The name of the span-based metric. (required)

body - New definition of the span-based metric. (required)

Returns:

CompletableFuture<SpansMetricResponse>

updateSpansMetricWithHttpInfo

public ApiResponse<SpansMetricResponse> updateSpansMetricWithHttpInfo(String metricId,
 SpansMetricUpdateRequest body)
                                                               throws ApiException

Update a specific span-based metric from your organization. Returns the span-based metric object from the request body when the request is successful.

Parameters:

metricId - The name of the span-based metric. (required)

body - New definition of the span-based metric. (required)

Returns:

ApiResponse<SpansMetricResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

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

updateSpansMetricWithHttpInfoAsync

public CompletableFuture<ApiResponse<SpansMetricResponse>> updateSpansMetricWithHttpInfoAsync(String metricId,
 SpansMetricUpdateRequest body)

Update a span-based metric.

See updateSpansMetricWithHttpInfo(java.lang.String, com.datadog.api.client.v2.model.SpansMetricUpdateRequest).

Parameters:

metricId - The name of the span-based metric. (required)

body - New definition of the span-based metric. (required)

Returns:

CompletableFuture<ApiResponse<SpansMetricResponse>>