com.datadog.api.client.v2.api

Class ApmRetentionFiltersApi

java.lang.Object

com.datadog.api.client.v2.api.ApmRetentionFiltersApi

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

Constructor Summary

Constructors

Constructor and Description
ApmRetentionFiltersApi()
ApmRetentionFiltersApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
RetentionFilterCreateResponse	createApmRetentionFilter(RetentionFilterCreateRequest body) Create a retention filter.
CompletableFuture<RetentionFilterCreateResponse>	createApmRetentionFilterAsync(RetentionFilterCreateRequest body) Create a retention filter.
ApiResponse<RetentionFilterCreateResponse>	createApmRetentionFilterWithHttpInfo(RetentionFilterCreateRequest body) Create a retention filter to index spans in your organization.
CompletableFuture<ApiResponse<RetentionFilterCreateResponse>>	createApmRetentionFilterWithHttpInfoAsync(RetentionFilterCreateRequest body) Create a retention filter.
void	deleteApmRetentionFilter(String filterId) Delete a retention filter.
CompletableFuture<Void>	deleteApmRetentionFilterAsync(String filterId) Delete a retention filter.
ApiResponse<Void>	deleteApmRetentionFilterWithHttpInfo(String filterId) Delete a specific retention filter from your organization.
CompletableFuture<ApiResponse<Void>>	deleteApmRetentionFilterWithHttpInfoAsync(String filterId) Delete a retention filter.
ApiClient	getApiClient() Get the API client.
RetentionFilterResponse	getApmRetentionFilter(String filterId) Get a given APM retention filter.
CompletableFuture<RetentionFilterResponse>	getApmRetentionFilterAsync(String filterId) Get a given APM retention filter.
ApiResponse<RetentionFilterResponse>	getApmRetentionFilterWithHttpInfo(String filterId) Get an APM retention filter.
CompletableFuture<ApiResponse<RetentionFilterResponse>>	getApmRetentionFilterWithHttpInfoAsync(String filterId) Get a given APM retention filter.
RetentionFiltersResponse	listApmRetentionFilters() List all APM retention filters.
CompletableFuture<RetentionFiltersResponse>	listApmRetentionFiltersAsync() List all APM retention filters.
ApiResponse<RetentionFiltersResponse>	listApmRetentionFiltersWithHttpInfo() Get the list of APM retention filters.
CompletableFuture<ApiResponse<RetentionFiltersResponse>>	listApmRetentionFiltersWithHttpInfoAsync() List all APM retention filters.
void	reorderApmRetentionFilters(ReorderRetentionFiltersRequest body) Re-order retention filters.
CompletableFuture<Void>	reorderApmRetentionFiltersAsync(ReorderRetentionFiltersRequest body) Re-order retention filters.
ApiResponse<Void>	reorderApmRetentionFiltersWithHttpInfo(ReorderRetentionFiltersRequest body) Re-order the execution order of retention filters.
CompletableFuture<ApiResponse<Void>>	reorderApmRetentionFiltersWithHttpInfoAsync(ReorderRetentionFiltersRequest body) Re-order retention filters.
void	setApiClient(ApiClient apiClient) Set the API client.
RetentionFilterResponse	updateApmRetentionFilter(String filterId, RetentionFilterUpdateRequest body) Update a retention filter.
CompletableFuture<RetentionFilterResponse>	updateApmRetentionFilterAsync(String filterId, RetentionFilterUpdateRequest body) Update a retention filter.
ApiResponse<RetentionFilterResponse>	updateApmRetentionFilterWithHttpInfo(String filterId, RetentionFilterUpdateRequest body) Update a retention filter from your organization.
CompletableFuture<ApiResponse<RetentionFilterResponse>>	updateApmRetentionFilterWithHttpInfoAsync(String filterId, RetentionFilterUpdateRequest body) Update a retention filter.

Methods inherited from class java.lang.Object

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

Constructor Detail

ApmRetentionFiltersApi

public ApmRetentionFiltersApi()

ApmRetentionFiltersApi

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

createApmRetentionFilter

public RetentionFilterCreateResponse createApmRetentionFilter(RetentionFilterCreateRequest body)
                                                       throws ApiException

Create a retention filter.

See createApmRetentionFilterWithHttpInfo(com.datadog.api.client.v2.model.RetentionFilterCreateRequest).

Parameters:

body - The definition of the new retention filter. (required)

Returns:

RetentionFilterCreateResponse

Throws:

ApiException - if fails to make API call

createApmRetentionFilterAsync

public CompletableFuture<RetentionFilterCreateResponse> createApmRetentionFilterAsync(RetentionFilterCreateRequest body)

Create a retention filter.

See createApmRetentionFilterWithHttpInfoAsync(com.datadog.api.client.v2.model.RetentionFilterCreateRequest).

Parameters:

body - The definition of the new retention filter. (required)

Returns:

CompletableFuture<RetentionFilterCreateResponse>

createApmRetentionFilterWithHttpInfo

public ApiResponse<RetentionFilterCreateResponse> createApmRetentionFilterWithHttpInfo(RetentionFilterCreateRequest body)
                                                                                throws ApiException

Create a retention filter to index spans in your organization. Returns the retention filter definition when the request is successful.

Default filters with types spans-errors-sampling-processor and spans-appsec-sampling-processor cannot be created.

Parameters:

body - The definition of the new retention filter. (required)

Returns:

ApiResponse<RetentionFilterCreateResponse>

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	-

createApmRetentionFilterWithHttpInfoAsync

public CompletableFuture<ApiResponse<RetentionFilterCreateResponse>> createApmRetentionFilterWithHttpInfoAsync(RetentionFilterCreateRequest body)

Create a retention filter.

See createApmRetentionFilterWithHttpInfo(com.datadog.api.client.v2.model.RetentionFilterCreateRequest).

Parameters:

body - The definition of the new retention filter. (required)

Returns:

CompletableFuture<ApiResponse<RetentionFilterCreateResponse>>

deleteApmRetentionFilter

public void deleteApmRetentionFilter(String filterId)
                              throws ApiException

Delete a retention filter.

See deleteApmRetentionFilterWithHttpInfo(java.lang.String).

Parameters:

filterId - The ID of the retention filter. (required)

Throws:

ApiException - if fails to make API call

deleteApmRetentionFilterAsync

public CompletableFuture<Void> deleteApmRetentionFilterAsync(String filterId)

Delete a retention filter.

See deleteApmRetentionFilterWithHttpInfoAsync(java.lang.String).

Parameters:

filterId - The ID of the retention filter. (required)

Returns:

CompletableFuture

deleteApmRetentionFilterWithHttpInfo

public ApiResponse<Void> deleteApmRetentionFilterWithHttpInfo(String filterId)
                                                       throws ApiException

Delete a specific retention filter from your organization.

Default filters with types spans-errors-sampling-processor and spans-appsec-sampling-processor cannot be deleted.

Parameters:

filterId - The ID of the retention filter. (required)

Returns:

ApiResponse<Void>

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	-

deleteApmRetentionFilterWithHttpInfoAsync

public CompletableFuture<ApiResponse<Void>> deleteApmRetentionFilterWithHttpInfoAsync(String filterId)

Delete a retention filter.

See deleteApmRetentionFilterWithHttpInfo(java.lang.String).

Parameters:

filterId - The ID of the retention filter. (required)

Returns:

CompletableFuture<ApiResponse<Void>>

getApmRetentionFilter

public RetentionFilterResponse getApmRetentionFilter(String filterId)
                                              throws ApiException

Get a given APM retention filter.

See getApmRetentionFilterWithHttpInfo(java.lang.String).

Parameters:

filterId - The ID of the retention filter. (required)

Returns:

RetentionFilterResponse

Throws:

ApiException - if fails to make API call

getApmRetentionFilterAsync

public CompletableFuture<RetentionFilterResponse> getApmRetentionFilterAsync(String filterId)

Get a given APM retention filter.

See getApmRetentionFilterWithHttpInfoAsync(java.lang.String).

Parameters:

filterId - The ID of the retention filter. (required)

Returns:

CompletableFuture<RetentionFilterResponse>

getApmRetentionFilterWithHttpInfo

public ApiResponse<RetentionFilterResponse> getApmRetentionFilterWithHttpInfo(String filterId)
                                                                       throws ApiException

Get an APM retention filter.

Parameters:

filterId - The ID of the retention filter. (required)

Returns:

ApiResponse<RetentionFilterResponse>

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	-

getApmRetentionFilterWithHttpInfoAsync

public CompletableFuture<ApiResponse<RetentionFilterResponse>> getApmRetentionFilterWithHttpInfoAsync(String filterId)

Get a given APM retention filter.

See getApmRetentionFilterWithHttpInfo(java.lang.String).

Parameters:

filterId - The ID of the retention filter. (required)

Returns:

CompletableFuture<ApiResponse<RetentionFilterResponse>>

listApmRetentionFilters

public RetentionFiltersResponse listApmRetentionFilters()
                                                 throws ApiException

List all APM retention filters.

See listApmRetentionFiltersWithHttpInfo().

Returns:

RetentionFiltersResponse

Throws:

ApiException - if fails to make API call

listApmRetentionFiltersAsync

public CompletableFuture<RetentionFiltersResponse> listApmRetentionFiltersAsync()

List all APM retention filters.

See listApmRetentionFiltersWithHttpInfoAsync().

Returns:

CompletableFuture<RetentionFiltersResponse>

listApmRetentionFiltersWithHttpInfo

public ApiResponse<RetentionFiltersResponse> listApmRetentionFiltersWithHttpInfo()
                                                                          throws ApiException

Get the list of APM retention filters.

Returns:

ApiResponse<RetentionFiltersResponse>

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	-

listApmRetentionFiltersWithHttpInfoAsync

public CompletableFuture<ApiResponse<RetentionFiltersResponse>> listApmRetentionFiltersWithHttpInfoAsync()

List all APM retention filters.

See listApmRetentionFiltersWithHttpInfo().

Returns:

CompletableFuture<ApiResponse<RetentionFiltersResponse>>

reorderApmRetentionFilters

public void reorderApmRetentionFilters(ReorderRetentionFiltersRequest body)
                                throws ApiException

Re-order retention filters.

See reorderApmRetentionFiltersWithHttpInfo(com.datadog.api.client.v2.model.ReorderRetentionFiltersRequest).

Parameters:

body - The list of retention filters in the new order. (required)

Throws:

ApiException - if fails to make API call

reorderApmRetentionFiltersAsync

public CompletableFuture<Void> reorderApmRetentionFiltersAsync(ReorderRetentionFiltersRequest body)

Re-order retention filters.

See reorderApmRetentionFiltersWithHttpInfoAsync(com.datadog.api.client.v2.model.ReorderRetentionFiltersRequest).

Parameters:

body - The list of retention filters in the new order. (required)

Returns:

CompletableFuture

reorderApmRetentionFiltersWithHttpInfo

public ApiResponse<Void> reorderApmRetentionFiltersWithHttpInfo(ReorderRetentionFiltersRequest body)
                                                         throws ApiException

Re-order the execution order of retention filters.

Parameters:

body - The list of retention filters in the new order. (required)

Returns:

ApiResponse<Void>

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	-

reorderApmRetentionFiltersWithHttpInfoAsync

public CompletableFuture<ApiResponse<Void>> reorderApmRetentionFiltersWithHttpInfoAsync(ReorderRetentionFiltersRequest body)

Re-order retention filters.

See reorderApmRetentionFiltersWithHttpInfo(com.datadog.api.client.v2.model.ReorderRetentionFiltersRequest).

Parameters:

body - The list of retention filters in the new order. (required)

Returns:

CompletableFuture<ApiResponse<Void>>

updateApmRetentionFilter

public RetentionFilterResponse updateApmRetentionFilter(String filterId,
                                                        RetentionFilterUpdateRequest body)
                                                 throws ApiException

Update a retention filter.

See updateApmRetentionFilterWithHttpInfo(java.lang.String, com.datadog.api.client.v2.model.RetentionFilterUpdateRequest).

Parameters:

filterId - The ID of the retention filter. (required)

body - The updated definition of the retention filter. (required)

Returns:

RetentionFilterResponse

Throws:

ApiException - if fails to make API call

updateApmRetentionFilterAsync

public CompletableFuture<RetentionFilterResponse> updateApmRetentionFilterAsync(String filterId,
                                                                                RetentionFilterUpdateRequest body)

Update a retention filter.

See updateApmRetentionFilterWithHttpInfoAsync(java.lang.String, com.datadog.api.client.v2.model.RetentionFilterUpdateRequest).

Parameters:

filterId - The ID of the retention filter. (required)

body - The updated definition of the retention filter. (required)

Returns:

CompletableFuture<RetentionFilterResponse>

updateApmRetentionFilterWithHttpInfo

public ApiResponse<RetentionFilterResponse> updateApmRetentionFilterWithHttpInfo(String filterId,
                                                                                 RetentionFilterUpdateRequest body)
                                                                          throws ApiException

Update a retention filter from your organization.

Default filters (filters with types spans-errors-sampling-processor and spans-appsec-sampling-processor) cannot be renamed or removed.

Parameters:

filterId - The ID of the retention filter. (required)

body - The updated definition of the retention filter. (required)

Returns:

ApiResponse<RetentionFilterResponse>

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	-

updateApmRetentionFilterWithHttpInfoAsync

public CompletableFuture<ApiResponse<RetentionFilterResponse>> updateApmRetentionFilterWithHttpInfoAsync(String filterId,
                                                                                                         RetentionFilterUpdateRequest body)

Update a retention filter.

See updateApmRetentionFilterWithHttpInfo(java.lang.String, com.datadog.api.client.v2.model.RetentionFilterUpdateRequest).

Parameters:

filterId - The ID of the retention filter. (required)

body - The updated definition of the retention filter. (required)

Returns:

CompletableFuture<ApiResponse<RetentionFilterResponse>>