com.datadog.api.client.v2.api

Class RumApi

java.lang.Object

com.datadog.api.client.v2.api.RumApi

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RumApi.ListRUMEventsOptionalParameters Manage optional parameters to listRUMEvents.

Constructor Summary

Constructors

Constructor and Description
RumApi()
RumApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
RUMAnalyticsAggregateResponse	aggregateRUMEvents(RUMAggregateRequest body) Aggregate RUM events.
CompletableFuture<RUMAnalyticsAggregateResponse>	aggregateRUMEventsAsync(RUMAggregateRequest body) Aggregate RUM events.
ApiResponse<RUMAnalyticsAggregateResponse>	aggregateRUMEventsWithHttpInfo(RUMAggregateRequest body) The API endpoint to aggregate RUM events into buckets of computed metrics and timeseries.
CompletableFuture<ApiResponse<RUMAnalyticsAggregateResponse>>	aggregateRUMEventsWithHttpInfoAsync(RUMAggregateRequest body) Aggregate RUM events.
RUMApplicationResponse	createRUMApplication(RUMApplicationCreateRequest body) Create a new RUM application.
CompletableFuture<RUMApplicationResponse>	createRUMApplicationAsync(RUMApplicationCreateRequest body) Create a new RUM application.
ApiResponse<RUMApplicationResponse>	createRUMApplicationWithHttpInfo(RUMApplicationCreateRequest body) Create a new RUM application in your organization.
CompletableFuture<ApiResponse<RUMApplicationResponse>>	createRUMApplicationWithHttpInfoAsync(RUMApplicationCreateRequest body) Create a new RUM application.
void	deleteRUMApplication(String id) Delete a RUM application.
CompletableFuture<Void>	deleteRUMApplicationAsync(String id) Delete a RUM application.
ApiResponse<Void>	deleteRUMApplicationWithHttpInfo(String id) Delete an existing RUM application in your organization.
CompletableFuture<ApiResponse<Void>>	deleteRUMApplicationWithHttpInfoAsync(String id) Delete a RUM application.
ApiClient	getApiClient() Get the API client.
RUMApplicationResponse	getRUMApplication(String id) Get a RUM application.
CompletableFuture<RUMApplicationResponse>	getRUMApplicationAsync(String id) Get a RUM application.
RUMApplicationsResponse	getRUMApplications() List all the RUM applications.
CompletableFuture<RUMApplicationsResponse>	getRUMApplicationsAsync() List all the RUM applications.
ApiResponse<RUMApplicationsResponse>	getRUMApplicationsWithHttpInfo() List all the RUM applications in your organization.
CompletableFuture<ApiResponse<RUMApplicationsResponse>>	getRUMApplicationsWithHttpInfoAsync() List all the RUM applications.
ApiResponse<RUMApplicationResponse>	getRUMApplicationWithHttpInfo(String id) Get the RUM application with given ID in your organization.
CompletableFuture<ApiResponse<RUMApplicationResponse>>	getRUMApplicationWithHttpInfoAsync(String id) Get a RUM application.
RUMEventsResponse	listRUMEvents() Get a list of RUM events.
RUMEventsResponse	listRUMEvents(RumApi.ListRUMEventsOptionalParameters parameters) Get a list of RUM events.
CompletableFuture<RUMEventsResponse>	listRUMEventsAsync() Get a list of RUM events.
CompletableFuture<RUMEventsResponse>	listRUMEventsAsync(RumApi.ListRUMEventsOptionalParameters parameters) Get a list of RUM events.
ApiResponse<RUMEventsResponse>	listRUMEventsWithHttpInfo(RumApi.ListRUMEventsOptionalParameters parameters) List endpoint returns events that match a RUM search query.
CompletableFuture<ApiResponse<RUMEventsResponse>>	listRUMEventsWithHttpInfoAsync(RumApi.ListRUMEventsOptionalParameters parameters) Get a list of RUM events.
PaginationIterable<RUMEvent>	listRUMEventsWithPagination() Get a list of RUM events.
PaginationIterable<RUMEvent>	listRUMEventsWithPagination(RumApi.ListRUMEventsOptionalParameters parameters) Get a list of RUM events.
RUMEventsResponse	searchRUMEvents(RUMSearchEventsRequest body) Search RUM events.
CompletableFuture<RUMEventsResponse>	searchRUMEventsAsync(RUMSearchEventsRequest body) Search RUM events.
ApiResponse<RUMEventsResponse>	searchRUMEventsWithHttpInfo(RUMSearchEventsRequest body) List endpoint returns RUM events that match a RUM search query.
CompletableFuture<ApiResponse<RUMEventsResponse>>	searchRUMEventsWithHttpInfoAsync(RUMSearchEventsRequest body) Search RUM events.
PaginationIterable<RUMEvent>	searchRUMEventsWithPagination(RUMSearchEventsRequest body) Search RUM events.
void	setApiClient(ApiClient apiClient) Set the API client.
RUMApplicationResponse	updateRUMApplication(String id, RUMApplicationUpdateRequest body) Update a RUM application.
CompletableFuture<RUMApplicationResponse>	updateRUMApplicationAsync(String id, RUMApplicationUpdateRequest body) Update a RUM application.
ApiResponse<RUMApplicationResponse>	updateRUMApplicationWithHttpInfo(String id, RUMApplicationUpdateRequest body) Update the RUM application with given ID in your organization.
CompletableFuture<ApiResponse<RUMApplicationResponse>>	updateRUMApplicationWithHttpInfoAsync(String id, RUMApplicationUpdateRequest body) Update a RUM application.

Methods inherited from class java.lang.Object

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

Constructor Detail

RumApi

public RumApi()

RumApi

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

aggregateRUMEvents

public RUMAnalyticsAggregateResponse aggregateRUMEvents(RUMAggregateRequest body)
                                                 throws ApiException

Aggregate RUM events.

See aggregateRUMEventsWithHttpInfo(com.datadog.api.client.v2.model.RUMAggregateRequest).

Parameters:

body - (required)

Returns:

RUMAnalyticsAggregateResponse

Throws:

ApiException - if fails to make API call

aggregateRUMEventsAsync

public CompletableFuture<RUMAnalyticsAggregateResponse> aggregateRUMEventsAsync(RUMAggregateRequest body)

Aggregate RUM events.

See aggregateRUMEventsWithHttpInfoAsync(com.datadog.api.client.v2.model.RUMAggregateRequest).

Parameters:

body - (required)

Returns:

CompletableFuture<RUMAnalyticsAggregateResponse>

aggregateRUMEventsWithHttpInfo

public ApiResponse<RUMAnalyticsAggregateResponse> aggregateRUMEventsWithHttpInfo(RUMAggregateRequest body)
                                                                          throws ApiException

The API endpoint to aggregate RUM events into buckets of computed metrics and timeseries.

Parameters:

body - (required)

Returns:

ApiResponse<RUMAnalyticsAggregateResponse>

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

aggregateRUMEventsWithHttpInfoAsync

public CompletableFuture<ApiResponse<RUMAnalyticsAggregateResponse>> aggregateRUMEventsWithHttpInfoAsync(RUMAggregateRequest body)

Aggregate RUM events.

See aggregateRUMEventsWithHttpInfo(com.datadog.api.client.v2.model.RUMAggregateRequest).

Parameters:

body - (required)

Returns:

CompletableFuture<ApiResponse<RUMAnalyticsAggregateResponse>>

createRUMApplication

public RUMApplicationResponse createRUMApplication(RUMApplicationCreateRequest body)
                                            throws ApiException

Create a new RUM application.

See createRUMApplicationWithHttpInfo(com.datadog.api.client.v2.model.RUMApplicationCreateRequest).

Parameters:

body - (required)

Returns:

RUMApplicationResponse

Throws:

ApiException - if fails to make API call

createRUMApplicationAsync

public CompletableFuture<RUMApplicationResponse> createRUMApplicationAsync(RUMApplicationCreateRequest body)

Create a new RUM application.

See createRUMApplicationWithHttpInfoAsync(com.datadog.api.client.v2.model.RUMApplicationCreateRequest).

Parameters:

body - (required)

Returns:

CompletableFuture<RUMApplicationResponse>

createRUMApplicationWithHttpInfo

public ApiResponse<RUMApplicationResponse> createRUMApplicationWithHttpInfo(RUMApplicationCreateRequest body)
                                                                     throws ApiException

Create a new RUM application in your organization.

Parameters:

body - (required)

Returns:

ApiResponse<RUMApplicationResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

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

createRUMApplicationWithHttpInfoAsync

public CompletableFuture<ApiResponse<RUMApplicationResponse>> createRUMApplicationWithHttpInfoAsync(RUMApplicationCreateRequest body)

Create a new RUM application.

See createRUMApplicationWithHttpInfo(com.datadog.api.client.v2.model.RUMApplicationCreateRequest).

Parameters:

body - (required)

Returns:

CompletableFuture<ApiResponse<RUMApplicationResponse>>

deleteRUMApplication

public void deleteRUMApplication(String id)
                          throws ApiException

Delete a RUM application.

See deleteRUMApplicationWithHttpInfo(java.lang.String).

Parameters:

id - RUM application ID. (required)

Throws:

ApiException - if fails to make API call

deleteRUMApplicationAsync

public CompletableFuture<Void> deleteRUMApplicationAsync(String id)

Delete a RUM application.

See deleteRUMApplicationWithHttpInfoAsync(java.lang.String).

Parameters:

id - RUM application ID. (required)

Returns:

CompletableFuture

deleteRUMApplicationWithHttpInfo

public ApiResponse<Void> deleteRUMApplicationWithHttpInfo(String id)
                                                   throws ApiException

Delete an existing RUM application in your organization.

Parameters:

id - RUM application ID. (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	-
404	Not Found	-
429	Too many requests	-

deleteRUMApplicationWithHttpInfoAsync

public CompletableFuture<ApiResponse<Void>> deleteRUMApplicationWithHttpInfoAsync(String id)

Delete a RUM application.

See deleteRUMApplicationWithHttpInfo(java.lang.String).

Parameters:

id - RUM application ID. (required)

Returns:

CompletableFuture<ApiResponse<Void>>

getRUMApplication

public RUMApplicationResponse getRUMApplication(String id)
                                         throws ApiException

Get a RUM application.

See getRUMApplicationWithHttpInfo(java.lang.String).

Parameters:

id - RUM application ID. (required)

Returns:

RUMApplicationResponse

Throws:

ApiException - if fails to make API call

getRUMApplicationAsync

public CompletableFuture<RUMApplicationResponse> getRUMApplicationAsync(String id)

Get a RUM application.

See getRUMApplicationWithHttpInfoAsync(java.lang.String).

Parameters:

id - RUM application ID. (required)

Returns:

CompletableFuture<RUMApplicationResponse>

getRUMApplicationWithHttpInfo

public ApiResponse<RUMApplicationResponse> getRUMApplicationWithHttpInfo(String id)
                                                                  throws ApiException

Get the RUM application with given ID in your organization.

Parameters:

id - RUM application ID. (required)

Returns:

ApiResponse<RUMApplicationResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

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

getRUMApplicationWithHttpInfoAsync

public CompletableFuture<ApiResponse<RUMApplicationResponse>> getRUMApplicationWithHttpInfoAsync(String id)

Get a RUM application.

See getRUMApplicationWithHttpInfo(java.lang.String).

Parameters:

id - RUM application ID. (required)

Returns:

CompletableFuture<ApiResponse<RUMApplicationResponse>>

getRUMApplications

public RUMApplicationsResponse getRUMApplications()
                                           throws ApiException

List all the RUM applications.

See getRUMApplicationsWithHttpInfo().

Returns:

RUMApplicationsResponse

Throws:

ApiException - if fails to make API call

getRUMApplicationsAsync

public CompletableFuture<RUMApplicationsResponse> getRUMApplicationsAsync()

List all the RUM applications.

See getRUMApplicationsWithHttpInfoAsync().

Returns:

CompletableFuture<RUMApplicationsResponse>

getRUMApplicationsWithHttpInfo

public ApiResponse<RUMApplicationsResponse> getRUMApplicationsWithHttpInfo()
                                                                    throws ApiException

List all the RUM applications in your organization.

Returns:

ApiResponse<RUMApplicationsResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

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

getRUMApplicationsWithHttpInfoAsync

public CompletableFuture<ApiResponse<RUMApplicationsResponse>> getRUMApplicationsWithHttpInfoAsync()

List all the RUM applications.

See getRUMApplicationsWithHttpInfo().

Returns:

CompletableFuture<ApiResponse<RUMApplicationsResponse>>

listRUMEvents

public RUMEventsResponse listRUMEvents()
                                throws ApiException

Get a list of RUM events.

See listRUMEventsWithHttpInfo(com.datadog.api.client.v2.api.RumApi.ListRUMEventsOptionalParameters).

Returns:

RUMEventsResponse

Throws:

ApiException - if fails to make API call

listRUMEventsAsync

public CompletableFuture<RUMEventsResponse> listRUMEventsAsync()

Get a list of RUM events.

See listRUMEventsWithHttpInfoAsync(com.datadog.api.client.v2.api.RumApi.ListRUMEventsOptionalParameters).

Returns:

CompletableFuture<RUMEventsResponse>

listRUMEvents

public RUMEventsResponse listRUMEvents(RumApi.ListRUMEventsOptionalParameters parameters)
                                throws ApiException

Get a list of RUM events.

See listRUMEventsWithHttpInfo(com.datadog.api.client.v2.api.RumApi.ListRUMEventsOptionalParameters).

Parameters:

parameters - Optional parameters for the request.

Returns:

RUMEventsResponse

Throws:

ApiException - if fails to make API call

listRUMEventsAsync

public CompletableFuture<RUMEventsResponse> listRUMEventsAsync(RumApi.ListRUMEventsOptionalParameters parameters)

Get a list of RUM events.

See listRUMEventsWithHttpInfoAsync(com.datadog.api.client.v2.api.RumApi.ListRUMEventsOptionalParameters).

Parameters:

parameters - Optional parameters for the request.

Returns:

CompletableFuture<RUMEventsResponse>

listRUMEventsWithPagination

public PaginationIterable<RUMEvent> listRUMEventsWithPagination()

Get a list of RUM events.

See listRUMEventsWithHttpInfo(com.datadog.api.client.v2.api.RumApi.ListRUMEventsOptionalParameters).

Returns:

PaginationIterable<RUMEvent>

listRUMEventsWithPagination

public PaginationIterable<RUMEvent> listRUMEventsWithPagination(RumApi.ListRUMEventsOptionalParameters parameters)

Get a list of RUM events.

See listRUMEventsWithHttpInfo(com.datadog.api.client.v2.api.RumApi.ListRUMEventsOptionalParameters).

Returns:

RUMEventsResponse

listRUMEventsWithHttpInfo

public ApiResponse<RUMEventsResponse> listRUMEventsWithHttpInfo(RumApi.ListRUMEventsOptionalParameters parameters)
                                                         throws ApiException

List endpoint returns events that match a RUM search query. Results are paginated.

Use this endpoint to see your latest RUM events.

Parameters:

parameters - Optional parameters for the request.

Returns:

ApiResponse<RUMEventsResponse>

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

listRUMEventsWithHttpInfoAsync

public CompletableFuture<ApiResponse<RUMEventsResponse>> listRUMEventsWithHttpInfoAsync(RumApi.ListRUMEventsOptionalParameters parameters)

Get a list of RUM events.

See listRUMEventsWithHttpInfo(com.datadog.api.client.v2.api.RumApi.ListRUMEventsOptionalParameters).

Parameters:

parameters - Optional parameters for the request.

Returns:

CompletableFuture<ApiResponse<RUMEventsResponse>>

searchRUMEvents

public RUMEventsResponse searchRUMEvents(RUMSearchEventsRequest body)
                                  throws ApiException

Search RUM events.

See searchRUMEventsWithHttpInfo(com.datadog.api.client.v2.model.RUMSearchEventsRequest).

Parameters:

body - (required)

Returns:

RUMEventsResponse

Throws:

ApiException - if fails to make API call

searchRUMEventsAsync

public CompletableFuture<RUMEventsResponse> searchRUMEventsAsync(RUMSearchEventsRequest body)

Search RUM events.

See searchRUMEventsWithHttpInfoAsync(com.datadog.api.client.v2.model.RUMSearchEventsRequest).

Parameters:

body - (required)

Returns:

CompletableFuture<RUMEventsResponse>

searchRUMEventsWithPagination

public PaginationIterable<RUMEvent> searchRUMEventsWithPagination(RUMSearchEventsRequest body)

Search RUM events.

See searchRUMEventsWithHttpInfo(com.datadog.api.client.v2.model.RUMSearchEventsRequest).

Parameters:

body - (required)

Returns:

PaginationIterable<RUMEvent>

searchRUMEventsWithHttpInfo

public ApiResponse<RUMEventsResponse> searchRUMEventsWithHttpInfo(RUMSearchEventsRequest body)
                                                           throws ApiException

List endpoint returns RUM events that match a RUM search query. Results are paginated.

Use this endpoint to build complex RUM events filtering and search.

Parameters:

body - (required)

Returns:

ApiResponse<RUMEventsResponse>

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

searchRUMEventsWithHttpInfoAsync

public CompletableFuture<ApiResponse<RUMEventsResponse>> searchRUMEventsWithHttpInfoAsync(RUMSearchEventsRequest body)

Search RUM events.

See searchRUMEventsWithHttpInfo(com.datadog.api.client.v2.model.RUMSearchEventsRequest).

Parameters:

body - (required)

Returns:

CompletableFuture<ApiResponse<RUMEventsResponse>>

updateRUMApplication

public RUMApplicationResponse updateRUMApplication(String id,
                                                   RUMApplicationUpdateRequest body)
                                            throws ApiException

Update a RUM application.

See updateRUMApplicationWithHttpInfo(java.lang.String, com.datadog.api.client.v2.model.RUMApplicationUpdateRequest).

Parameters:

id - RUM application ID. (required)

body - (required)

Returns:

RUMApplicationResponse

Throws:

ApiException - if fails to make API call

updateRUMApplicationAsync

public CompletableFuture<RUMApplicationResponse> updateRUMApplicationAsync(String id,
                                                                           RUMApplicationUpdateRequest body)

Update a RUM application.

See updateRUMApplicationWithHttpInfoAsync(java.lang.String, com.datadog.api.client.v2.model.RUMApplicationUpdateRequest).

Parameters:

id - RUM application ID. (required)

body - (required)

Returns:

CompletableFuture<RUMApplicationResponse>

updateRUMApplicationWithHttpInfo

public ApiResponse<RUMApplicationResponse> updateRUMApplicationWithHttpInfo(String id,
                                                                            RUMApplicationUpdateRequest body)
                                                                     throws ApiException

Update the RUM application with given ID in your organization.

Parameters:

id - RUM application ID. (required)

body - (required)

Returns:

ApiResponse<RUMApplicationResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK	-
400	Bad Request	-
404	Not Found	-
422	Unprocessable Entity.	-
429	Too many requests	-

updateRUMApplicationWithHttpInfoAsync

public CompletableFuture<ApiResponse<RUMApplicationResponse>> updateRUMApplicationWithHttpInfoAsync(String id,
                                                                                                    RUMApplicationUpdateRequest body)

Update a RUM application.

See updateRUMApplicationWithHttpInfo(java.lang.String, com.datadog.api.client.v2.model.RUMApplicationUpdateRequest).

Parameters:

id - RUM application ID. (required)

body - (required)

Returns:

CompletableFuture<ApiResponse<RUMApplicationResponse>>