com.datadog.api.v1.client.api

Class DashboardListsApi

java.lang.Object

com.datadog.api.v1.client.api.DashboardListsApi

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

Constructor Summary

Constructors

Constructor and Description
DashboardListsApi()
DashboardListsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
DashboardList	createDashboardList(DashboardList body) Create a dashboard list
CompletableFuture<DashboardList>	createDashboardListAsync(DashboardList body) Create a dashboard list
ApiResponse<DashboardList>	createDashboardListWithHttpInfo(DashboardList body) Create a dashboard list
CompletableFuture<ApiResponse<DashboardList>>	createDashboardListWithHttpInfoAsync(DashboardList body) Create a dashboard list
DashboardListDeleteResponse	deleteDashboardList(Long listId) Delete a dashboard list
CompletableFuture<DashboardListDeleteResponse>	deleteDashboardListAsync(Long listId) Delete a dashboard list
ApiResponse<DashboardListDeleteResponse>	deleteDashboardListWithHttpInfo(Long listId) Delete a dashboard list
CompletableFuture<ApiResponse<DashboardListDeleteResponse>>	deleteDashboardListWithHttpInfoAsync(Long listId) Delete a dashboard list
ApiClient	getApiClient() Get the API client
DashboardList	getDashboardList(Long listId) Get a dashboard list
CompletableFuture<DashboardList>	getDashboardListAsync(Long listId) Get a dashboard list
ApiResponse<DashboardList>	getDashboardListWithHttpInfo(Long listId) Get a dashboard list
CompletableFuture<ApiResponse<DashboardList>>	getDashboardListWithHttpInfoAsync(Long listId) Get a dashboard list
DashboardListListResponse	listDashboardLists() Get all dashboard lists
CompletableFuture<DashboardListListResponse>	listDashboardListsAsync() Get all dashboard lists
ApiResponse<DashboardListListResponse>	listDashboardListsWithHttpInfo() Get all dashboard lists
CompletableFuture<ApiResponse<DashboardListListResponse>>	listDashboardListsWithHttpInfoAsync() Get all dashboard lists
void	setApiClient(ApiClient apiClient) Set the API client
DashboardList	updateDashboardList(Long listId, DashboardList body) Update a dashboard list
CompletableFuture<DashboardList>	updateDashboardListAsync(Long listId, DashboardList body) Update a dashboard list
ApiResponse<DashboardList>	updateDashboardListWithHttpInfo(Long listId, DashboardList body) Update a dashboard list
CompletableFuture<ApiResponse<DashboardList>>	updateDashboardListWithHttpInfoAsync(Long listId, DashboardList body) Update a dashboard list

Methods inherited from class java.lang.Object

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

Constructor Detail

DashboardListsApi

public DashboardListsApi()

DashboardListsApi

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

createDashboardList

public DashboardList createDashboardList(DashboardList body)
                                  throws ApiException

Create a dashboard list

See createDashboardListWithHttpInfo(com.datadog.api.v1.client.model.DashboardList).

Parameters:

body - Create a dashboard list request body. (required)

Returns:

DashboardList

Throws:

ApiException - if fails to make API call

createDashboardListAsync

public CompletableFuture<DashboardList> createDashboardListAsync(DashboardList body)

Create a dashboard list

See createDashboardListWithHttpInfoAsync(com.datadog.api.v1.client.model.DashboardList).

Parameters:

body - Create a dashboard list request body. (required)

Returns:

CompletableFuture<DashboardList>

createDashboardListWithHttpInfo

public ApiResponse<DashboardList> createDashboardListWithHttpInfo(DashboardList body)
                                                           throws ApiException

Create a dashboard list

Create an empty dashboard list.

Parameters:

body - Create a dashboard list request body. (required)

Returns:

ApiResponse<DashboardList>

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	-

createDashboardListWithHttpInfoAsync

public CompletableFuture<ApiResponse<DashboardList>> createDashboardListWithHttpInfoAsync(DashboardList body)

Create a dashboard list

See createDashboardListWithHttpInfo(com.datadog.api.v1.client.model.DashboardList).

Parameters:

body - Create a dashboard list request body. (required)

Returns:

CompletableFuture<ApiResponse<DashboardList>>

deleteDashboardList

public DashboardListDeleteResponse deleteDashboardList(Long listId)
                                                throws ApiException

Delete a dashboard list

See deleteDashboardListWithHttpInfo(java.lang.Long).

Parameters:

listId - ID of the dashboard list to delete. (required)

Returns:

DashboardListDeleteResponse

Throws:

ApiException - if fails to make API call

deleteDashboardListAsync

public CompletableFuture<DashboardListDeleteResponse> deleteDashboardListAsync(Long listId)

Delete a dashboard list

See deleteDashboardListWithHttpInfoAsync(java.lang.Long).

Parameters:

listId - ID of the dashboard list to delete. (required)

Returns:

CompletableFuture<DashboardListDeleteResponse>

deleteDashboardListWithHttpInfo

public ApiResponse<DashboardListDeleteResponse> deleteDashboardListWithHttpInfo(Long listId)
                                                                         throws ApiException

Delete a dashboard list

Delete a dashboard list.

Parameters:

listId - ID of the dashboard list to delete. (required)

Returns:

ApiResponse<DashboardListDeleteResponse>

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	-

deleteDashboardListWithHttpInfoAsync

public CompletableFuture<ApiResponse<DashboardListDeleteResponse>> deleteDashboardListWithHttpInfoAsync(Long listId)

Delete a dashboard list

See deleteDashboardListWithHttpInfo(java.lang.Long).

Parameters:

listId - ID of the dashboard list to delete. (required)

Returns:

CompletableFuture<ApiResponse<DashboardListDeleteResponse>>

getDashboardList

public DashboardList getDashboardList(Long listId)
                               throws ApiException

Get a dashboard list

See getDashboardListWithHttpInfo(java.lang.Long).

Parameters:

listId - ID of the dashboard list to fetch. (required)

Returns:

DashboardList

Throws:

ApiException - if fails to make API call

getDashboardListAsync

public CompletableFuture<DashboardList> getDashboardListAsync(Long listId)

Get a dashboard list

See getDashboardListWithHttpInfoAsync(java.lang.Long).

Parameters:

listId - ID of the dashboard list to fetch. (required)

Returns:

CompletableFuture<DashboardList>

getDashboardListWithHttpInfo

public ApiResponse<DashboardList> getDashboardListWithHttpInfo(Long listId)
                                                        throws ApiException

Get a dashboard list

Fetch an existing dashboard list's definition.

Parameters:

listId - ID of the dashboard list to fetch. (required)

Returns:

ApiResponse<DashboardList>

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	-

getDashboardListWithHttpInfoAsync

public CompletableFuture<ApiResponse<DashboardList>> getDashboardListWithHttpInfoAsync(Long listId)

Get a dashboard list

See getDashboardListWithHttpInfo(java.lang.Long).

Parameters:

listId - ID of the dashboard list to fetch. (required)

Returns:

CompletableFuture<ApiResponse<DashboardList>>

listDashboardLists

public DashboardListListResponse listDashboardLists()
                                             throws ApiException

Get all dashboard lists

See listDashboardListsWithHttpInfo().

Returns:

DashboardListListResponse

Throws:

ApiException - if fails to make API call

listDashboardListsAsync

public CompletableFuture<DashboardListListResponse> listDashboardListsAsync()

Get all dashboard lists

See listDashboardListsWithHttpInfoAsync().

Returns:

CompletableFuture<DashboardListListResponse>

listDashboardListsWithHttpInfo

public ApiResponse<DashboardListListResponse> listDashboardListsWithHttpInfo()
                                                                      throws ApiException

Get all dashboard lists

Fetch all of your existing dashboard list definitions.

Returns:

ApiResponse<DashboardListListResponse>

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	-

listDashboardListsWithHttpInfoAsync

public CompletableFuture<ApiResponse<DashboardListListResponse>> listDashboardListsWithHttpInfoAsync()

Get all dashboard lists

See listDashboardListsWithHttpInfo().

Returns:

CompletableFuture<ApiResponse<DashboardListListResponse>>

updateDashboardList

public DashboardList updateDashboardList(Long listId,
                                         DashboardList body)
                                  throws ApiException

Update a dashboard list

See updateDashboardListWithHttpInfo(java.lang.Long, com.datadog.api.v1.client.model.DashboardList).

Parameters:

listId - ID of the dashboard list to update. (required)

body - Update a dashboard list request body. (required)

Returns:

DashboardList

Throws:

ApiException - if fails to make API call

updateDashboardListAsync

public CompletableFuture<DashboardList> updateDashboardListAsync(Long listId,
                                                                 DashboardList body)

Update a dashboard list

See updateDashboardListWithHttpInfoAsync(java.lang.Long, com.datadog.api.v1.client.model.DashboardList).

Parameters:

listId - ID of the dashboard list to update. (required)

body - Update a dashboard list request body. (required)

Returns:

CompletableFuture<DashboardList>

updateDashboardListWithHttpInfo

public ApiResponse<DashboardList> updateDashboardListWithHttpInfo(Long listId,
                                                                  DashboardList body)
                                                           throws ApiException

Update a dashboard list

Update the name of a dashboard list.

Parameters:

listId - ID of the dashboard list to update. (required)

body - Update a dashboard list request body. (required)

Returns:

ApiResponse<DashboardList>

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	-

updateDashboardListWithHttpInfoAsync

public CompletableFuture<ApiResponse<DashboardList>> updateDashboardListWithHttpInfoAsync(Long listId,
                                                                                          DashboardList body)

Update a dashboard list

See updateDashboardListWithHttpInfo(java.lang.Long, com.datadog.api.v1.client.model.DashboardList).

Parameters:

listId - ID of the dashboard list to update. (required)

body - Update a dashboard list request body. (required)

Returns:

CompletableFuture<ApiResponse<DashboardList>>