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

Class RumMetricsApi

java.lang.Object

com.datadog.api.client.v2.api.RumMetricsApi

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

Constructor Summary

Constructors

Constructor	Description
RumMetricsApi()
RumMetricsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
RumMetricResponse	createRumMetric(RumMetricCreateRequest body)	Create a RUM-based metric.
CompletableFuture<RumMetricResponse>	createRumMetricAsync(RumMetricCreateRequest body)	Create a RUM-based metric.
ApiResponse<RumMetricResponse>	createRumMetricWithHttpInfo(RumMetricCreateRequest body)	Create a metric based on your organization's RUM data.
CompletableFuture<ApiResponse<RumMetricResponse>>	createRumMetricWithHttpInfoAsync(RumMetricCreateRequest body)	Create a RUM-based metric.
void	deleteRumMetric(String metricId)	Delete a RUM-based metric.
CompletableFuture<Void>	deleteRumMetricAsync(String metricId)	Delete a RUM-based metric.
ApiResponse<Void>	deleteRumMetricWithHttpInfo(String metricId)	Delete a specific RUM-based metric from your organization.
CompletableFuture<ApiResponse<Void>>	deleteRumMetricWithHttpInfoAsync(String metricId)	Delete a RUM-based metric.
ApiClient	getApiClient()	Get the API client.
RumMetricResponse	getRumMetric(String metricId)	Get a RUM-based metric.
CompletableFuture<RumMetricResponse>	getRumMetricAsync(String metricId)	Get a RUM-based metric.
ApiResponse<RumMetricResponse>	getRumMetricWithHttpInfo(String metricId)	Get a specific RUM-based metric from your organization.
CompletableFuture<ApiResponse<RumMetricResponse>>	getRumMetricWithHttpInfoAsync(String metricId)	Get a RUM-based metric.
RumMetricsResponse	listRumMetrics()	Get all RUM-based metrics.
CompletableFuture<RumMetricsResponse>	listRumMetricsAsync()	Get all RUM-based metrics.
ApiResponse<RumMetricsResponse>	listRumMetricsWithHttpInfo()	Get the list of configured RUM-based metrics with their definitions.
CompletableFuture<ApiResponse<RumMetricsResponse>>	listRumMetricsWithHttpInfoAsync()	Get all RUM-based metrics.
void	setApiClient(ApiClient apiClient)	Set the API client.
RumMetricResponse	updateRumMetric(String metricId, RumMetricUpdateRequest body)	Update a RUM-based metric.
CompletableFuture<RumMetricResponse>	updateRumMetricAsync(String metricId, RumMetricUpdateRequest body)	Update a RUM-based metric.
ApiResponse<RumMetricResponse>	updateRumMetricWithHttpInfo(String metricId, RumMetricUpdateRequest body)	Update a specific RUM-based metric from your organization.
CompletableFuture<ApiResponse<RumMetricResponse>>	updateRumMetricWithHttpInfoAsync(String metricId, RumMetricUpdateRequest body)	Update a RUM-based metric.

Methods inherited from class java.lang.Object

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

Constructor Details

RumMetricsApi

public RumMetricsApi()

RumMetricsApi

public RumMetricsApi(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

createRumMetric

public RumMetricResponse createRumMetric(RumMetricCreateRequest body)
                                  throws ApiException

Create a RUM-based metric.

See createRumMetricWithHttpInfo(com.datadog.api.client.v2.model.RumMetricCreateRequest).

Parameters:

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

Returns:

RumMetricResponse

Throws:

ApiException - if fails to make API call

createRumMetricAsync

public CompletableFuture<RumMetricResponse> createRumMetricAsync(RumMetricCreateRequest body)

Create a RUM-based metric.

See createRumMetricWithHttpInfoAsync(com.datadog.api.client.v2.model.RumMetricCreateRequest).

Parameters:

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

Returns:

CompletableFuture<RumMetricResponse>

createRumMetricWithHttpInfo

public ApiResponse<RumMetricResponse> createRumMetricWithHttpInfo(RumMetricCreateRequest body)
                                                           throws ApiException

Create a metric based on your organization's RUM data. Returns the RUM-based metric object from the request body when the request is successful.

Parameters:

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

Returns:

ApiResponse<RumMetricResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

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

createRumMetricWithHttpInfoAsync

public CompletableFuture<ApiResponse<RumMetricResponse>> createRumMetricWithHttpInfoAsync(RumMetricCreateRequest body)

Create a RUM-based metric.

See createRumMetricWithHttpInfo(com.datadog.api.client.v2.model.RumMetricCreateRequest).

Parameters:

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

Returns:

CompletableFuture<ApiResponse<RumMetricResponse>>

deleteRumMetric

public void deleteRumMetric(String metricId)
                     throws ApiException

Delete a RUM-based metric.

See deleteRumMetricWithHttpInfo(java.lang.String).

Parameters:

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

Throws:

ApiException - if fails to make API call

deleteRumMetricAsync

public CompletableFuture<Void> deleteRumMetricAsync(String metricId)

Delete a RUM-based metric.

See deleteRumMetricWithHttpInfoAsync(java.lang.String).

Parameters:

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

Returns:

CompletableFuture

deleteRumMetricWithHttpInfo

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

Delete a specific RUM-based metric from your organization.

Parameters:

metricId - The name of the RUM-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	No Content	-
403	Not Authorized	-
404	Not Found	-
429	Too many requests	-

deleteRumMetricWithHttpInfoAsync

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

Delete a RUM-based metric.

See deleteRumMetricWithHttpInfo(java.lang.String).

Parameters:

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

Returns:

CompletableFuture<ApiResponse<Void>>

getRumMetric

public RumMetricResponse getRumMetric(String metricId)
                               throws ApiException

Get a RUM-based metric.

See getRumMetricWithHttpInfo(java.lang.String).

Parameters:

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

Returns:

RumMetricResponse

Throws:

ApiException - if fails to make API call

getRumMetricAsync

public CompletableFuture<RumMetricResponse> getRumMetricAsync(String metricId)

Get a RUM-based metric.

See getRumMetricWithHttpInfoAsync(java.lang.String).

Parameters:

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

Returns:

CompletableFuture<RumMetricResponse>

getRumMetricWithHttpInfo

public ApiResponse<RumMetricResponse> getRumMetricWithHttpInfo(String metricId)
                                                        throws ApiException

Get a specific RUM-based metric from your organization.

Parameters:

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

Returns:

ApiResponse<RumMetricResponse>

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	-

getRumMetricWithHttpInfoAsync

public CompletableFuture<ApiResponse<RumMetricResponse>> getRumMetricWithHttpInfoAsync(String metricId)

Get a RUM-based metric.

See getRumMetricWithHttpInfo(java.lang.String).

Parameters:

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

Returns:

CompletableFuture<ApiResponse<RumMetricResponse>>

listRumMetrics

public RumMetricsResponse listRumMetrics()
                                  throws ApiException

Get all RUM-based metrics.

See listRumMetricsWithHttpInfo().

Returns:

RumMetricsResponse

Throws:

ApiException - if fails to make API call

listRumMetricsAsync

public CompletableFuture<RumMetricsResponse> listRumMetricsAsync()

Get all RUM-based metrics.

See listRumMetricsWithHttpInfoAsync().

Returns:

CompletableFuture<RumMetricsResponse>

listRumMetricsWithHttpInfo

public ApiResponse<RumMetricsResponse> listRumMetricsWithHttpInfo()
                                                           throws ApiException

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

Returns:

ApiResponse<RumMetricsResponse>

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	-

listRumMetricsWithHttpInfoAsync

public CompletableFuture<ApiResponse<RumMetricsResponse>> listRumMetricsWithHttpInfoAsync()

Get all RUM-based metrics.

See listRumMetricsWithHttpInfo().

Returns:

CompletableFuture<ApiResponse<RumMetricsResponse>>

updateRumMetric

public RumMetricResponse updateRumMetric(String metricId,
 RumMetricUpdateRequest body)
                                  throws ApiException

Update a RUM-based metric.

See updateRumMetricWithHttpInfo(java.lang.String, com.datadog.api.client.v2.model.RumMetricUpdateRequest).

Parameters:

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

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

Returns:

RumMetricResponse

Throws:

ApiException - if fails to make API call

updateRumMetricAsync

public CompletableFuture<RumMetricResponse> updateRumMetricAsync(String metricId,
 RumMetricUpdateRequest body)

Update a RUM-based metric.

See updateRumMetricWithHttpInfoAsync(java.lang.String, com.datadog.api.client.v2.model.RumMetricUpdateRequest).

Parameters:

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

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

Returns:

CompletableFuture<RumMetricResponse>

updateRumMetricWithHttpInfo

public ApiResponse<RumMetricResponse> updateRumMetricWithHttpInfo(String metricId,
 RumMetricUpdateRequest body)
                                                           throws ApiException

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

Parameters:

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

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

Returns:

ApiResponse<RumMetricResponse>

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	-
409	Conflict	-
429	Too many requests	-

updateRumMetricWithHttpInfoAsync

public CompletableFuture<ApiResponse<RumMetricResponse>> updateRumMetricWithHttpInfoAsync(String metricId,
 RumMetricUpdateRequest body)

Update a RUM-based metric.

See updateRumMetricWithHttpInfo(java.lang.String, com.datadog.api.client.v2.model.RumMetricUpdateRequest).

Parameters:

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

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

Returns:

CompletableFuture<ApiResponse<RumMetricResponse>>