Package com.datadog.api.client.v1.api

Class LogsIndexesApi

java.lang.Object

com.datadog.api.client.v1.api.LogsIndexesApi

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

Constructor Summary

Constructors

Constructor	Description
LogsIndexesApi()
LogsIndexesApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
LogsIndex	createLogsIndex(LogsIndex body)	Create an index.
CompletableFuture<LogsIndex>	createLogsIndexAsync(LogsIndex body)	Create an index.
ApiResponse<LogsIndex>	createLogsIndexWithHttpInfo(LogsIndex body)	Creates a new index.
CompletableFuture<ApiResponse<LogsIndex>>	createLogsIndexWithHttpInfoAsync(LogsIndex body)	Create an index.
void	deleteLogsIndex(String name)	Delete an index.
CompletableFuture<Void>	deleteLogsIndexAsync(String name)	Delete an index.
ApiResponse<Void>	deleteLogsIndexWithHttpInfo(String name)	Delete an existing index from your organization.
CompletableFuture<ApiResponse<Void>>	deleteLogsIndexWithHttpInfoAsync(String name)	Delete an index.
ApiClient	getApiClient()	Get the API client.
LogsIndex	getLogsIndex(String name)	Get an index.
CompletableFuture<LogsIndex>	getLogsIndexAsync(String name)	Get an index.
LogsIndexesOrder	getLogsIndexOrder()	Get indexes order.
CompletableFuture<LogsIndexesOrder>	getLogsIndexOrderAsync()	Get indexes order.
ApiResponse<LogsIndexesOrder>	getLogsIndexOrderWithHttpInfo()	Get the current order of your log indexes.
CompletableFuture<ApiResponse<LogsIndexesOrder>>	getLogsIndexOrderWithHttpInfoAsync()	Get indexes order.
ApiResponse<LogsIndex>	getLogsIndexWithHttpInfo(String name)	Get one log index from your organization.
CompletableFuture<ApiResponse<LogsIndex>>	getLogsIndexWithHttpInfoAsync(String name)	Get an index.
LogsIndexListResponse	listLogIndexes()	Get all indexes.
CompletableFuture<LogsIndexListResponse>	listLogIndexesAsync()	Get all indexes.
ApiResponse<LogsIndexListResponse>	listLogIndexesWithHttpInfo()	The Index object describes the configuration of a log index.
CompletableFuture<ApiResponse<LogsIndexListResponse>>	listLogIndexesWithHttpInfoAsync()	Get all indexes.
void	setApiClient(ApiClient apiClient)	Set the API client.
LogsIndex	updateLogsIndex(String name, LogsIndexUpdateRequest body)	Update an index.
CompletableFuture<LogsIndex>	updateLogsIndexAsync(String name, LogsIndexUpdateRequest body)	Update an index.
LogsIndexesOrder	updateLogsIndexOrder(LogsIndexesOrder body)	Update indexes order.
CompletableFuture<LogsIndexesOrder>	updateLogsIndexOrderAsync(LogsIndexesOrder body)	Update indexes order.
ApiResponse<LogsIndexesOrder>	updateLogsIndexOrderWithHttpInfo(LogsIndexesOrder body)	This endpoint updates the index order of your organization.
CompletableFuture<ApiResponse<LogsIndexesOrder>>	updateLogsIndexOrderWithHttpInfoAsync(LogsIndexesOrder body)	Update indexes order.
ApiResponse<LogsIndex>	updateLogsIndexWithHttpInfo(String name, LogsIndexUpdateRequest body)	Update an index as identified by its name.
CompletableFuture<ApiResponse<LogsIndex>>	updateLogsIndexWithHttpInfoAsync(String name, LogsIndexUpdateRequest body)	Update an index.

Methods inherited from class java.lang.Object

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

Constructor Details

LogsIndexesApi

public LogsIndexesApi()

LogsIndexesApi

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

createLogsIndex

public LogsIndex createLogsIndex(LogsIndex body)
                          throws ApiException

Create an index.

See createLogsIndexWithHttpInfo(com.datadog.api.client.v1.model.LogsIndex).

Parameters:

body - Object containing the new index. (required)

Returns:

LogsIndex

Throws:

ApiException - if fails to make API call

createLogsIndexAsync

public CompletableFuture<LogsIndex> createLogsIndexAsync(LogsIndex body)

Create an index.

See createLogsIndexWithHttpInfoAsync(com.datadog.api.client.v1.model.LogsIndex).

Parameters:

body - Object containing the new index. (required)

Returns:

CompletableFuture<LogsIndex>

createLogsIndexWithHttpInfo

public ApiResponse<LogsIndex> createLogsIndexWithHttpInfo(LogsIndex body)
                                                   throws ApiException

Creates a new index. Returns the Index object passed in the request body when the request is successful.

Parameters:

body - Object containing the new index. (required)

Returns:

ApiResponse<LogsIndex>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK	-
400	Invalid Parameter Error	-
403	Forbidden	-
422	Unprocessable Entity	-
429	Too many requests	-

createLogsIndexWithHttpInfoAsync

public CompletableFuture<ApiResponse<LogsIndex>> createLogsIndexWithHttpInfoAsync(LogsIndex body)

Create an index.

See createLogsIndexWithHttpInfo(com.datadog.api.client.v1.model.LogsIndex).

Parameters:

body - Object containing the new index. (required)

Returns:

CompletableFuture<ApiResponse<LogsIndex>>

deleteLogsIndex

public void deleteLogsIndex(String name)
                     throws ApiException

Delete an index.

See deleteLogsIndexWithHttpInfo(java.lang.String).

Parameters:

name - Name of the log index. (required)

Throws:

ApiException - if fails to make API call

deleteLogsIndexAsync

public CompletableFuture<Void> deleteLogsIndexAsync(String name)

Delete an index.

See deleteLogsIndexWithHttpInfoAsync(java.lang.String).

Parameters:

name - Name of the log index. (required)

Returns:

CompletableFuture

deleteLogsIndexWithHttpInfo

public ApiResponse<Void> deleteLogsIndexWithHttpInfo(String name)
                                              throws ApiException

Delete an existing index from your organization. Index deletions are permanent and cannot be reverted. You cannot recreate an index with the same name as deleted ones.

Parameters:

name - Name of the log index. (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	Forbidden	-
404	Not Found	-
429	Too many requests	-

deleteLogsIndexWithHttpInfoAsync

public CompletableFuture<ApiResponse<Void>> deleteLogsIndexWithHttpInfoAsync(String name)

Delete an index.

See deleteLogsIndexWithHttpInfo(java.lang.String).

Parameters:

name - Name of the log index. (required)

Returns:

CompletableFuture<ApiResponse<Void>>

getLogsIndex

public LogsIndex getLogsIndex(String name)
                       throws ApiException

Get an index.

See getLogsIndexWithHttpInfo(java.lang.String).

Parameters:

name - Name of the log index. (required)

Returns:

LogsIndex

Throws:

ApiException - if fails to make API call

getLogsIndexAsync

public CompletableFuture<LogsIndex> getLogsIndexAsync(String name)

Get an index.

See getLogsIndexWithHttpInfoAsync(java.lang.String).

Parameters:

name - Name of the log index. (required)

Returns:

CompletableFuture<LogsIndex>

getLogsIndexWithHttpInfo

public ApiResponse<LogsIndex> getLogsIndexWithHttpInfo(String name)
                                                throws ApiException

Get one log index from your organization. This endpoint takes no JSON arguments.

Parameters:

name - Name of the log index. (required)

Returns:

ApiResponse<LogsIndex>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

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

getLogsIndexWithHttpInfoAsync

public CompletableFuture<ApiResponse<LogsIndex>> getLogsIndexWithHttpInfoAsync(String name)

Get an index.

See getLogsIndexWithHttpInfo(java.lang.String).

Parameters:

name - Name of the log index. (required)

Returns:

CompletableFuture<ApiResponse<LogsIndex>>

getLogsIndexOrder

public LogsIndexesOrder getLogsIndexOrder()
                                   throws ApiException

Get indexes order.

See getLogsIndexOrderWithHttpInfo().

Returns:

LogsIndexesOrder

Throws:

ApiException - if fails to make API call

getLogsIndexOrderAsync

public CompletableFuture<LogsIndexesOrder> getLogsIndexOrderAsync()

Get indexes order.

See getLogsIndexOrderWithHttpInfoAsync().

Returns:

CompletableFuture<LogsIndexesOrder>

getLogsIndexOrderWithHttpInfo

public ApiResponse<LogsIndexesOrder> getLogsIndexOrderWithHttpInfo()
                                                            throws ApiException

Get the current order of your log indexes. This endpoint takes no JSON arguments.

Returns:

ApiResponse<LogsIndexesOrder>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

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

getLogsIndexOrderWithHttpInfoAsync

public CompletableFuture<ApiResponse<LogsIndexesOrder>> getLogsIndexOrderWithHttpInfoAsync()

Get indexes order.

See getLogsIndexOrderWithHttpInfo().

Returns:

CompletableFuture<ApiResponse<LogsIndexesOrder>>

listLogIndexes

public LogsIndexListResponse listLogIndexes()
                                     throws ApiException

Get all indexes.

See listLogIndexesWithHttpInfo().

Returns:

LogsIndexListResponse

Throws:

ApiException - if fails to make API call

listLogIndexesAsync

public CompletableFuture<LogsIndexListResponse> listLogIndexesAsync()

Get all indexes.

See listLogIndexesWithHttpInfoAsync().

Returns:

CompletableFuture<LogsIndexListResponse>

listLogIndexesWithHttpInfo

public ApiResponse<LogsIndexListResponse> listLogIndexesWithHttpInfo()
                                                              throws ApiException

The Index object describes the configuration of a log index. This endpoint returns an array of the LogIndex objects of your organization.

Returns:

ApiResponse<LogsIndexListResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

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

listLogIndexesWithHttpInfoAsync

public CompletableFuture<ApiResponse<LogsIndexListResponse>> listLogIndexesWithHttpInfoAsync()

Get all indexes.

See listLogIndexesWithHttpInfo().

Returns:

CompletableFuture<ApiResponse<LogsIndexListResponse>>

updateLogsIndex

public LogsIndex updateLogsIndex(String name,
 LogsIndexUpdateRequest body)
                          throws ApiException

Update an index.

See updateLogsIndexWithHttpInfo(java.lang.String, com.datadog.api.client.v1.model.LogsIndexUpdateRequest).

Parameters:

name - Name of the log index. (required)

body - Object containing the new LogsIndexUpdateRequest. (required)

Returns:

LogsIndex

Throws:

ApiException - if fails to make API call

updateLogsIndexAsync

public CompletableFuture<LogsIndex> updateLogsIndexAsync(String name,
 LogsIndexUpdateRequest body)

Update an index.

See updateLogsIndexWithHttpInfoAsync(java.lang.String, com.datadog.api.client.v1.model.LogsIndexUpdateRequest).

Parameters:

name - Name of the log index. (required)

body - Object containing the new LogsIndexUpdateRequest. (required)

Returns:

CompletableFuture<LogsIndex>

updateLogsIndexWithHttpInfo

public ApiResponse<LogsIndex> updateLogsIndexWithHttpInfo(String name,
 LogsIndexUpdateRequest body)
                                                   throws ApiException

Update an index as identified by its name. Returns the Index object passed in the request body when the request is successful.

Using the PUT method updates your index's configuration by replacing your current configuration with the new one sent to your Datadog organization.

Parameters:

name - Name of the log index. (required)

body - Object containing the new LogsIndexUpdateRequest. (required)

Returns:

ApiResponse<LogsIndex>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK	-
400	Invalid Parameter Error	-
403	Forbidden	-
429	Too Many Requests	-

updateLogsIndexWithHttpInfoAsync

public CompletableFuture<ApiResponse<LogsIndex>> updateLogsIndexWithHttpInfoAsync(String name,
 LogsIndexUpdateRequest body)

Update an index.

See updateLogsIndexWithHttpInfo(java.lang.String, com.datadog.api.client.v1.model.LogsIndexUpdateRequest).

Parameters:

name - Name of the log index. (required)

body - Object containing the new LogsIndexUpdateRequest. (required)

Returns:

CompletableFuture<ApiResponse<LogsIndex>>

updateLogsIndexOrder

public LogsIndexesOrder updateLogsIndexOrder(LogsIndexesOrder body)
                                      throws ApiException

Update indexes order.

See updateLogsIndexOrderWithHttpInfo(com.datadog.api.client.v1.model.LogsIndexesOrder).

Parameters:

body - Object containing the new ordered list of index names (required)

Returns:

LogsIndexesOrder

Throws:

ApiException - if fails to make API call

updateLogsIndexOrderAsync

public CompletableFuture<LogsIndexesOrder> updateLogsIndexOrderAsync(LogsIndexesOrder body)

Update indexes order.

See updateLogsIndexOrderWithHttpInfoAsync(com.datadog.api.client.v1.model.LogsIndexesOrder).

Parameters:

body - Object containing the new ordered list of index names (required)

Returns:

CompletableFuture<LogsIndexesOrder>

updateLogsIndexOrderWithHttpInfo

public ApiResponse<LogsIndexesOrder> updateLogsIndexOrderWithHttpInfo(LogsIndexesOrder body)
                                                               throws ApiException

This endpoint updates the index order of your organization. It returns the index order object passed in the request body when the request is successful.

Parameters:

body - Object containing the new ordered list of index names (required)

Returns:

ApiResponse<LogsIndexesOrder>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

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

updateLogsIndexOrderWithHttpInfoAsync

public CompletableFuture<ApiResponse<LogsIndexesOrder>> updateLogsIndexOrderWithHttpInfoAsync(LogsIndexesOrder body)

Update indexes order.

See updateLogsIndexOrderWithHttpInfo(com.datadog.api.client.v1.model.LogsIndexesOrder).

Parameters:

body - Object containing the new ordered list of index names (required)

Returns:

CompletableFuture<ApiResponse<LogsIndexesOrder>>