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

Class LogsArchivesApi

java.lang.Object

com.datadog.api.client.v2.api.LogsArchivesApi

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

Constructor Summary

Constructors

Constructor	Description
LogsArchivesApi()
LogsArchivesApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
void	addReadRoleToArchive(String archiveId, RelationshipToRole body)	Grant role to an archive.
CompletableFuture<Void>	addReadRoleToArchiveAsync(String archiveId, RelationshipToRole body)	Grant role to an archive.
ApiResponse<Void>	addReadRoleToArchiveWithHttpInfo(String archiveId, RelationshipToRole body)	Adds a read role to an archive.
CompletableFuture<ApiResponse<Void>>	addReadRoleToArchiveWithHttpInfoAsync(String archiveId, RelationshipToRole body)	Grant role to an archive.
LogsArchive	createLogsArchive(LogsArchiveCreateRequest body)	Create an archive.
CompletableFuture<LogsArchive>	createLogsArchiveAsync(LogsArchiveCreateRequest body)	Create an archive.
ApiResponse<LogsArchive>	createLogsArchiveWithHttpInfo(LogsArchiveCreateRequest body)	Create an archive in your organization.
CompletableFuture<ApiResponse<LogsArchive>>	createLogsArchiveWithHttpInfoAsync(LogsArchiveCreateRequest body)	Create an archive.
void	deleteLogsArchive(String archiveId)	Delete an archive.
CompletableFuture<Void>	deleteLogsArchiveAsync(String archiveId)	Delete an archive.
ApiResponse<Void>	deleteLogsArchiveWithHttpInfo(String archiveId)	Delete a given archive from your organization.
CompletableFuture<ApiResponse<Void>>	deleteLogsArchiveWithHttpInfoAsync(String archiveId)	Delete an archive.
ApiClient	getApiClient()	Get the API client.
LogsArchive	getLogsArchive(String archiveId)	Get an archive.
CompletableFuture<LogsArchive>	getLogsArchiveAsync(String archiveId)	Get an archive.
LogsArchiveOrder	getLogsArchiveOrder()	Get archive order.
CompletableFuture<LogsArchiveOrder>	getLogsArchiveOrderAsync()	Get archive order.
ApiResponse<LogsArchiveOrder>	getLogsArchiveOrderWithHttpInfo()	Get the current order of your archives.
CompletableFuture<ApiResponse<LogsArchiveOrder>>	getLogsArchiveOrderWithHttpInfoAsync()	Get archive order.
ApiResponse<LogsArchive>	getLogsArchiveWithHttpInfo(String archiveId)	Get a specific archive from your organization.
CompletableFuture<ApiResponse<LogsArchive>>	getLogsArchiveWithHttpInfoAsync(String archiveId)	Get an archive.
RolesResponse	listArchiveReadRoles(String archiveId)	List read roles for an archive.
CompletableFuture<RolesResponse>	listArchiveReadRolesAsync(String archiveId)	List read roles for an archive.
ApiResponse<RolesResponse>	listArchiveReadRolesWithHttpInfo(String archiveId)	Returns all read roles a given archive is restricted to.
CompletableFuture<ApiResponse<RolesResponse>>	listArchiveReadRolesWithHttpInfoAsync(String archiveId)	List read roles for an archive.
LogsArchives	listLogsArchives()	Get all archives.
CompletableFuture<LogsArchives>	listLogsArchivesAsync()	Get all archives.
ApiResponse<LogsArchives>	listLogsArchivesWithHttpInfo()	Get the list of configured logs archives with their definitions.
CompletableFuture<ApiResponse<LogsArchives>>	listLogsArchivesWithHttpInfoAsync()	Get all archives.
void	removeRoleFromArchive(String archiveId, RelationshipToRole body)	Revoke role from an archive.
CompletableFuture<Void>	removeRoleFromArchiveAsync(String archiveId, RelationshipToRole body)	Revoke role from an archive.
ApiResponse<Void>	removeRoleFromArchiveWithHttpInfo(String archiveId, RelationshipToRole body)	Removes a role from an archive.
CompletableFuture<ApiResponse<Void>>	removeRoleFromArchiveWithHttpInfoAsync(String archiveId, RelationshipToRole body)	Revoke role from an archive.
void	setApiClient(ApiClient apiClient)	Set the API client.
LogsArchive	updateLogsArchive(String archiveId, LogsArchiveCreateRequest body)	Update an archive.
CompletableFuture<LogsArchive>	updateLogsArchiveAsync(String archiveId, LogsArchiveCreateRequest body)	Update an archive.
LogsArchiveOrder	updateLogsArchiveOrder(LogsArchiveOrder body)	Update archive order.
CompletableFuture<LogsArchiveOrder>	updateLogsArchiveOrderAsync(LogsArchiveOrder body)	Update archive order.
ApiResponse<LogsArchiveOrder>	updateLogsArchiveOrderWithHttpInfo(LogsArchiveOrder body)	Update the order of your archives.
CompletableFuture<ApiResponse<LogsArchiveOrder>>	updateLogsArchiveOrderWithHttpInfoAsync(LogsArchiveOrder body)	Update archive order.
ApiResponse<LogsArchive>	updateLogsArchiveWithHttpInfo(String archiveId, LogsArchiveCreateRequest body)	Update a given archive configuration.
CompletableFuture<ApiResponse<LogsArchive>>	updateLogsArchiveWithHttpInfoAsync(String archiveId, LogsArchiveCreateRequest body)	Update an archive.

Methods inherited from class java.lang.Object

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

Constructor Details

LogsArchivesApi

public LogsArchivesApi()

LogsArchivesApi

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

addReadRoleToArchive

public void addReadRoleToArchive(String archiveId,
 RelationshipToRole body)
                          throws ApiException

Grant role to an archive.

See addReadRoleToArchiveWithHttpInfo(java.lang.String, com.datadog.api.client.v2.model.RelationshipToRole).

Parameters:

archiveId - The ID of the archive. (required)

body - (required)

Throws:

ApiException - if fails to make API call

addReadRoleToArchiveAsync

public CompletableFuture<Void> addReadRoleToArchiveAsync(String archiveId,
 RelationshipToRole body)

Grant role to an archive.

See addReadRoleToArchiveWithHttpInfoAsync(java.lang.String, com.datadog.api.client.v2.model.RelationshipToRole).

Parameters:

archiveId - The ID of the archive. (required)

body - (required)

Returns:

CompletableFuture

addReadRoleToArchiveWithHttpInfo

public ApiResponse<Void> addReadRoleToArchiveWithHttpInfo(String archiveId,
 RelationshipToRole body)
                                                   throws ApiException

Adds a read role to an archive. (Roles API)

Parameters:

archiveId - The ID of the archive. (required)

body - (required)

Returns:

ApiResponse<Void>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
204	OK	-
400	Bad Request	-
403	Forbidden	-
404	Not found	-
429	Too many requests	-

addReadRoleToArchiveWithHttpInfoAsync

public CompletableFuture<ApiResponse<Void>> addReadRoleToArchiveWithHttpInfoAsync(String archiveId,
 RelationshipToRole body)

Grant role to an archive.

See addReadRoleToArchiveWithHttpInfo(java.lang.String, com.datadog.api.client.v2.model.RelationshipToRole).

Parameters:

archiveId - The ID of the archive. (required)

body - (required)

Returns:

CompletableFuture<ApiResponse<Void>>

createLogsArchive

public LogsArchive createLogsArchive(LogsArchiveCreateRequest body)
                              throws ApiException

Create an archive.

See createLogsArchiveWithHttpInfo(com.datadog.api.client.v2.model.LogsArchiveCreateRequest).

Parameters:

body - The definition of the new archive. (required)

Returns:

LogsArchive

Throws:

ApiException - if fails to make API call

createLogsArchiveAsync

public CompletableFuture<LogsArchive> createLogsArchiveAsync(LogsArchiveCreateRequest body)

Create an archive.

See createLogsArchiveWithHttpInfoAsync(com.datadog.api.client.v2.model.LogsArchiveCreateRequest).

Parameters:

body - The definition of the new archive. (required)

Returns:

CompletableFuture<LogsArchive>

createLogsArchiveWithHttpInfo

public ApiResponse<LogsArchive> createLogsArchiveWithHttpInfo(LogsArchiveCreateRequest body)
                                                       throws ApiException

Create an archive in your organization.

Parameters:

body - The definition of the new archive. (required)

Returns:

ApiResponse<LogsArchive>

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	-

createLogsArchiveWithHttpInfoAsync

public CompletableFuture<ApiResponse<LogsArchive>> createLogsArchiveWithHttpInfoAsync(LogsArchiveCreateRequest body)

Create an archive.

See createLogsArchiveWithHttpInfo(com.datadog.api.client.v2.model.LogsArchiveCreateRequest).

Parameters:

body - The definition of the new archive. (required)

Returns:

CompletableFuture<ApiResponse<LogsArchive>>

deleteLogsArchive

public void deleteLogsArchive(String archiveId)
                       throws ApiException

Delete an archive.

See deleteLogsArchiveWithHttpInfo(java.lang.String).

Parameters:

archiveId - The ID of the archive. (required)

Throws:

ApiException - if fails to make API call

deleteLogsArchiveAsync

public CompletableFuture<Void> deleteLogsArchiveAsync(String archiveId)

Delete an archive.

See deleteLogsArchiveWithHttpInfoAsync(java.lang.String).

Parameters:

archiveId - The ID of the archive. (required)

Returns:

CompletableFuture

deleteLogsArchiveWithHttpInfo

public ApiResponse<Void> deleteLogsArchiveWithHttpInfo(String archiveId)
                                                throws ApiException

Delete a given archive from your organization.

Parameters:

archiveId - The ID of the archive. (required)

Returns:

ApiResponse<Void>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
204	OK	-
400	Bad Request	-
403	Forbidden	-
404	Not found	-
429	Too many requests	-

deleteLogsArchiveWithHttpInfoAsync

public CompletableFuture<ApiResponse<Void>> deleteLogsArchiveWithHttpInfoAsync(String archiveId)

Delete an archive.

See deleteLogsArchiveWithHttpInfo(java.lang.String).

Parameters:

archiveId - The ID of the archive. (required)

Returns:

CompletableFuture<ApiResponse<Void>>

getLogsArchive

public LogsArchive getLogsArchive(String archiveId)
                           throws ApiException

Get an archive.

See getLogsArchiveWithHttpInfo(java.lang.String).

Parameters:

archiveId - The ID of the archive. (required)

Returns:

LogsArchive

Throws:

ApiException - if fails to make API call

getLogsArchiveAsync

public CompletableFuture<LogsArchive> getLogsArchiveAsync(String archiveId)

Get an archive.

See getLogsArchiveWithHttpInfoAsync(java.lang.String).

Parameters:

archiveId - The ID of the archive. (required)

Returns:

CompletableFuture<LogsArchive>

getLogsArchiveWithHttpInfo

public ApiResponse<LogsArchive> getLogsArchiveWithHttpInfo(String archiveId)
                                                    throws ApiException

Get a specific archive from your organization.

Parameters:

archiveId - The ID of the archive. (required)

Returns:

ApiResponse<LogsArchive>

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

getLogsArchiveWithHttpInfoAsync

public CompletableFuture<ApiResponse<LogsArchive>> getLogsArchiveWithHttpInfoAsync(String archiveId)

Get an archive.

See getLogsArchiveWithHttpInfo(java.lang.String).

Parameters:

archiveId - The ID of the archive. (required)

Returns:

CompletableFuture<ApiResponse<LogsArchive>>

getLogsArchiveOrder

public LogsArchiveOrder getLogsArchiveOrder()
                                     throws ApiException

Get archive order.

See getLogsArchiveOrderWithHttpInfo().

Returns:

LogsArchiveOrder

Throws:

ApiException - if fails to make API call

getLogsArchiveOrderAsync

public CompletableFuture<LogsArchiveOrder> getLogsArchiveOrderAsync()

Get archive order.

See getLogsArchiveOrderWithHttpInfoAsync().

Returns:

CompletableFuture<LogsArchiveOrder>

getLogsArchiveOrderWithHttpInfo

public ApiResponse<LogsArchiveOrder> getLogsArchiveOrderWithHttpInfo()
                                                              throws ApiException

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

Returns:

ApiResponse<LogsArchiveOrder>

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	-

getLogsArchiveOrderWithHttpInfoAsync

public CompletableFuture<ApiResponse<LogsArchiveOrder>> getLogsArchiveOrderWithHttpInfoAsync()

Get archive order.

See getLogsArchiveOrderWithHttpInfo().

Returns:

CompletableFuture<ApiResponse<LogsArchiveOrder>>

listArchiveReadRoles

public RolesResponse listArchiveReadRoles(String archiveId)
                                   throws ApiException

List read roles for an archive.

See listArchiveReadRolesWithHttpInfo(java.lang.String).

Parameters:

archiveId - The ID of the archive. (required)

Returns:

RolesResponse

Throws:

ApiException - if fails to make API call

listArchiveReadRolesAsync

public CompletableFuture<RolesResponse> listArchiveReadRolesAsync(String archiveId)

List read roles for an archive.

See listArchiveReadRolesWithHttpInfoAsync(java.lang.String).

Parameters:

archiveId - The ID of the archive. (required)

Returns:

CompletableFuture<RolesResponse>

listArchiveReadRolesWithHttpInfo

public ApiResponse<RolesResponse> listArchiveReadRolesWithHttpInfo(String archiveId)
                                                            throws ApiException

Returns all read roles a given archive is restricted to.

Parameters:

archiveId - The ID of the archive. (required)

Returns:

ApiResponse<RolesResponse>

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

listArchiveReadRolesWithHttpInfoAsync

public CompletableFuture<ApiResponse<RolesResponse>> listArchiveReadRolesWithHttpInfoAsync(String archiveId)

List read roles for an archive.

See listArchiveReadRolesWithHttpInfo(java.lang.String).

Parameters:

archiveId - The ID of the archive. (required)

Returns:

CompletableFuture<ApiResponse<RolesResponse>>

listLogsArchives

public LogsArchives listLogsArchives()
                              throws ApiException

Get all archives.

See listLogsArchivesWithHttpInfo().

Returns:

LogsArchives

Throws:

ApiException - if fails to make API call

listLogsArchivesAsync

public CompletableFuture<LogsArchives> listLogsArchivesAsync()

Get all archives.

See listLogsArchivesWithHttpInfoAsync().

Returns:

CompletableFuture<LogsArchives>

listLogsArchivesWithHttpInfo

public ApiResponse<LogsArchives> listLogsArchivesWithHttpInfo()
                                                       throws ApiException

Get the list of configured logs archives with their definitions.

Returns:

ApiResponse<LogsArchives>

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	-

listLogsArchivesWithHttpInfoAsync

public CompletableFuture<ApiResponse<LogsArchives>> listLogsArchivesWithHttpInfoAsync()

Get all archives.

See listLogsArchivesWithHttpInfo().

Returns:

CompletableFuture<ApiResponse<LogsArchives>>

removeRoleFromArchive

public void removeRoleFromArchive(String archiveId,
 RelationshipToRole body)
                           throws ApiException

Revoke role from an archive.

See removeRoleFromArchiveWithHttpInfo(java.lang.String, com.datadog.api.client.v2.model.RelationshipToRole).

Parameters:

archiveId - The ID of the archive. (required)

body - (required)

Throws:

ApiException - if fails to make API call

removeRoleFromArchiveAsync

public CompletableFuture<Void> removeRoleFromArchiveAsync(String archiveId,
 RelationshipToRole body)

Revoke role from an archive.

See removeRoleFromArchiveWithHttpInfoAsync(java.lang.String, com.datadog.api.client.v2.model.RelationshipToRole).

Parameters:

archiveId - The ID of the archive. (required)

body - (required)

Returns:

CompletableFuture

removeRoleFromArchiveWithHttpInfo

public ApiResponse<Void> removeRoleFromArchiveWithHttpInfo(String archiveId,
 RelationshipToRole body)
                                                    throws ApiException

Removes a role from an archive. (Roles API)

Parameters:

archiveId - The ID of the archive. (required)

body - (required)

Returns:

ApiResponse<Void>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
204	OK	-
400	Bad Request	-
403	Forbidden	-
404	Not found	-
429	Too many requests	-

removeRoleFromArchiveWithHttpInfoAsync

public CompletableFuture<ApiResponse<Void>> removeRoleFromArchiveWithHttpInfoAsync(String archiveId,
 RelationshipToRole body)

Revoke role from an archive.

See removeRoleFromArchiveWithHttpInfo(java.lang.String, com.datadog.api.client.v2.model.RelationshipToRole).

Parameters:

archiveId - The ID of the archive. (required)

body - (required)

Returns:

CompletableFuture<ApiResponse<Void>>

updateLogsArchive

public LogsArchive updateLogsArchive(String archiveId,
 LogsArchiveCreateRequest body)
                              throws ApiException

Update an archive.

See updateLogsArchiveWithHttpInfo(java.lang.String, com.datadog.api.client.v2.model.LogsArchiveCreateRequest).

Parameters:

archiveId - The ID of the archive. (required)

body - New definition of the archive. (required)

Returns:

LogsArchive

Throws:

ApiException - if fails to make API call

updateLogsArchiveAsync

public CompletableFuture<LogsArchive> updateLogsArchiveAsync(String archiveId,
 LogsArchiveCreateRequest body)

Update an archive.

See updateLogsArchiveWithHttpInfoAsync(java.lang.String, com.datadog.api.client.v2.model.LogsArchiveCreateRequest).

Parameters:

archiveId - The ID of the archive. (required)

body - New definition of the archive. (required)

Returns:

CompletableFuture<LogsArchive>

updateLogsArchiveWithHttpInfo

public ApiResponse<LogsArchive> updateLogsArchiveWithHttpInfo(String archiveId,
 LogsArchiveCreateRequest body)
                                                       throws ApiException

Update a given archive configuration.

Note: Using this method updates your archive configuration by replacing your current configuration with the new one sent to your Datadog organization.

Parameters:

archiveId - The ID of the archive. (required)

body - New definition of the archive. (required)

Returns:

ApiResponse<LogsArchive>

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

updateLogsArchiveWithHttpInfoAsync

public CompletableFuture<ApiResponse<LogsArchive>> updateLogsArchiveWithHttpInfoAsync(String archiveId,
 LogsArchiveCreateRequest body)

Update an archive.

See updateLogsArchiveWithHttpInfo(java.lang.String, com.datadog.api.client.v2.model.LogsArchiveCreateRequest).

Parameters:

archiveId - The ID of the archive. (required)

body - New definition of the archive. (required)

Returns:

CompletableFuture<ApiResponse<LogsArchive>>

updateLogsArchiveOrder

public LogsArchiveOrder updateLogsArchiveOrder(LogsArchiveOrder body)
                                        throws ApiException

Update archive order.

See updateLogsArchiveOrderWithHttpInfo(com.datadog.api.client.v2.model.LogsArchiveOrder).

Parameters:

body - An object containing the new ordered list of archive IDs. (required)

Returns:

LogsArchiveOrder

Throws:

ApiException - if fails to make API call

updateLogsArchiveOrderAsync

public CompletableFuture<LogsArchiveOrder> updateLogsArchiveOrderAsync(LogsArchiveOrder body)

Update archive order.

See updateLogsArchiveOrderWithHttpInfoAsync(com.datadog.api.client.v2.model.LogsArchiveOrder).

Parameters:

body - An object containing the new ordered list of archive IDs. (required)

Returns:

CompletableFuture<LogsArchiveOrder>

updateLogsArchiveOrderWithHttpInfo

public ApiResponse<LogsArchiveOrder> updateLogsArchiveOrderWithHttpInfo(LogsArchiveOrder body)
                                                                 throws ApiException

Update the order of your archives. Since logs are processed sequentially, reordering an archive may change the structure and content of the data processed by other archives.

Note: Using the PUT method updates your archive's order by replacing the current order with the new one.

Parameters:

body - An object containing the new ordered list of archive IDs. (required)

Returns:

ApiResponse<LogsArchiveOrder>

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

updateLogsArchiveOrderWithHttpInfoAsync

public CompletableFuture<ApiResponse<LogsArchiveOrder>> updateLogsArchiveOrderWithHttpInfoAsync(LogsArchiveOrder body)

Update archive order.

See updateLogsArchiveOrderWithHttpInfo(com.datadog.api.client.v2.model.LogsArchiveOrder).

Parameters:

body - An object containing the new ordered list of archive IDs. (required)

Returns:

CompletableFuture<ApiResponse<LogsArchiveOrder>>