com.datadog.api.client.v2.api

Class DashboardListsApi

java.lang.Object

com.datadog.api.client.v2.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
DashboardListAddItemsResponse	createDashboardListItems(Long dashboardListId, DashboardListAddItemsRequest body) Add Items to a Dashboard List.
CompletableFuture<DashboardListAddItemsResponse>	createDashboardListItemsAsync(Long dashboardListId, DashboardListAddItemsRequest body) Add Items to a Dashboard List.
ApiResponse<DashboardListAddItemsResponse>	createDashboardListItemsWithHttpInfo(Long dashboardListId, DashboardListAddItemsRequest body) Add dashboards to an existing dashboard list.
CompletableFuture<ApiResponse<DashboardListAddItemsResponse>>	createDashboardListItemsWithHttpInfoAsync(Long dashboardListId, DashboardListAddItemsRequest body) Add Items to a Dashboard List.
DashboardListDeleteItemsResponse	deleteDashboardListItems(Long dashboardListId, DashboardListDeleteItemsRequest body) Delete items from a dashboard list.
CompletableFuture<DashboardListDeleteItemsResponse>	deleteDashboardListItemsAsync(Long dashboardListId, DashboardListDeleteItemsRequest body) Delete items from a dashboard list.
ApiResponse<DashboardListDeleteItemsResponse>	deleteDashboardListItemsWithHttpInfo(Long dashboardListId, DashboardListDeleteItemsRequest body) Delete dashboards from an existing dashboard list.
CompletableFuture<ApiResponse<DashboardListDeleteItemsResponse>>	deleteDashboardListItemsWithHttpInfoAsync(Long dashboardListId, DashboardListDeleteItemsRequest body) Delete items from a dashboard list.
ApiClient	getApiClient() Get the API client.
DashboardListItems	getDashboardListItems(Long dashboardListId) Get items of a Dashboard List.
CompletableFuture<DashboardListItems>	getDashboardListItemsAsync(Long dashboardListId) Get items of a Dashboard List.
ApiResponse<DashboardListItems>	getDashboardListItemsWithHttpInfo(Long dashboardListId) Fetch the dashboard list’s dashboard definitions.
CompletableFuture<ApiResponse<DashboardListItems>>	getDashboardListItemsWithHttpInfoAsync(Long dashboardListId) Get items of a Dashboard List.
void	setApiClient(ApiClient apiClient) Set the API client.
DashboardListUpdateItemsResponse	updateDashboardListItems(Long dashboardListId, DashboardListUpdateItemsRequest body) Update items of a dashboard list.
CompletableFuture<DashboardListUpdateItemsResponse>	updateDashboardListItemsAsync(Long dashboardListId, DashboardListUpdateItemsRequest body) Update items of a dashboard list.
ApiResponse<DashboardListUpdateItemsResponse>	updateDashboardListItemsWithHttpInfo(Long dashboardListId, DashboardListUpdateItemsRequest body) Update dashboards of an existing dashboard list.
CompletableFuture<ApiResponse<DashboardListUpdateItemsResponse>>	updateDashboardListItemsWithHttpInfoAsync(Long dashboardListId, DashboardListUpdateItemsRequest body) Update items of 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

createDashboardListItems

public DashboardListAddItemsResponse createDashboardListItems(Long dashboardListId,
                                                              DashboardListAddItemsRequest body)
                                                       throws ApiException

Add Items to a Dashboard List.

See createDashboardListItemsWithHttpInfo(java.lang.Long, com.datadog.api.client.v2.model.DashboardListAddItemsRequest).

Parameters:

dashboardListId - ID of the dashboard list to add items to. (required)

body - Dashboards to add to the dashboard list. (required)

Returns:

DashboardListAddItemsResponse

Throws:

ApiException - if fails to make API call

createDashboardListItemsAsync

public CompletableFuture<DashboardListAddItemsResponse> createDashboardListItemsAsync(Long dashboardListId,
                                                                                      DashboardListAddItemsRequest body)

Add Items to a Dashboard List.

See createDashboardListItemsWithHttpInfoAsync(java.lang.Long, com.datadog.api.client.v2.model.DashboardListAddItemsRequest).

Parameters:

dashboardListId - ID of the dashboard list to add items to. (required)

body - Dashboards to add to the dashboard list. (required)

Returns:

CompletableFuture<DashboardListAddItemsResponse>

createDashboardListItemsWithHttpInfo

public ApiResponse<DashboardListAddItemsResponse> createDashboardListItemsWithHttpInfo(Long dashboardListId,
                                                                                       DashboardListAddItemsRequest body)
                                                                                throws ApiException

Add dashboards to an existing dashboard list.

Parameters:

dashboardListId - ID of the dashboard list to add items to. (required)

body - Dashboards to add to the dashboard list. (required)

Returns:

ApiResponse<DashboardListAddItemsResponse>

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	-

createDashboardListItemsWithHttpInfoAsync

public CompletableFuture<ApiResponse<DashboardListAddItemsResponse>> createDashboardListItemsWithHttpInfoAsync(Long dashboardListId,
                                                                                                               DashboardListAddItemsRequest body)

Add Items to a Dashboard List.

See createDashboardListItemsWithHttpInfo(java.lang.Long, com.datadog.api.client.v2.model.DashboardListAddItemsRequest).

Parameters:

dashboardListId - ID of the dashboard list to add items to. (required)

body - Dashboards to add to the dashboard list. (required)

Returns:

CompletableFuture<ApiResponse<DashboardListAddItemsResponse>>

deleteDashboardListItems

public DashboardListDeleteItemsResponse deleteDashboardListItems(Long dashboardListId,
                                                                 DashboardListDeleteItemsRequest body)
                                                          throws ApiException

Delete items from a dashboard list.

See deleteDashboardListItemsWithHttpInfo(java.lang.Long, com.datadog.api.client.v2.model.DashboardListDeleteItemsRequest).

Parameters:

dashboardListId - ID of the dashboard list to delete items from. (required)

body - Dashboards to delete from the dashboard list. (required)

Returns:

DashboardListDeleteItemsResponse

Throws:

ApiException - if fails to make API call

deleteDashboardListItemsAsync

public CompletableFuture<DashboardListDeleteItemsResponse> deleteDashboardListItemsAsync(Long dashboardListId,
                                                                                         DashboardListDeleteItemsRequest body)

Delete items from a dashboard list.

See deleteDashboardListItemsWithHttpInfoAsync(java.lang.Long, com.datadog.api.client.v2.model.DashboardListDeleteItemsRequest).

Parameters:

dashboardListId - ID of the dashboard list to delete items from. (required)

body - Dashboards to delete from the dashboard list. (required)

Returns:

CompletableFuture<DashboardListDeleteItemsResponse>

deleteDashboardListItemsWithHttpInfo

public ApiResponse<DashboardListDeleteItemsResponse> deleteDashboardListItemsWithHttpInfo(Long dashboardListId,
                                                                                          DashboardListDeleteItemsRequest body)
                                                                                   throws ApiException

Delete dashboards from an existing dashboard list.

Parameters:

dashboardListId - ID of the dashboard list to delete items from. (required)

body - Dashboards to delete from the dashboard list. (required)

Returns:

ApiResponse<DashboardListDeleteItemsResponse>

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	-

deleteDashboardListItemsWithHttpInfoAsync

public CompletableFuture<ApiResponse<DashboardListDeleteItemsResponse>> deleteDashboardListItemsWithHttpInfoAsync(Long dashboardListId,
                                                                                                                  DashboardListDeleteItemsRequest body)

Delete items from a dashboard list.

See deleteDashboardListItemsWithHttpInfo(java.lang.Long, com.datadog.api.client.v2.model.DashboardListDeleteItemsRequest).

Parameters:

dashboardListId - ID of the dashboard list to delete items from. (required)

body - Dashboards to delete from the dashboard list. (required)

Returns:

CompletableFuture<ApiResponse<DashboardListDeleteItemsResponse>>

getDashboardListItems

public DashboardListItems getDashboardListItems(Long dashboardListId)
                                         throws ApiException

Get items of a Dashboard List.

See getDashboardListItemsWithHttpInfo(java.lang.Long).

Parameters:

dashboardListId - ID of the dashboard list to get items from. (required)

Returns:

DashboardListItems

Throws:

ApiException - if fails to make API call

getDashboardListItemsAsync

public CompletableFuture<DashboardListItems> getDashboardListItemsAsync(Long dashboardListId)

Get items of a Dashboard List.

See getDashboardListItemsWithHttpInfoAsync(java.lang.Long).

Parameters:

dashboardListId - ID of the dashboard list to get items from. (required)

Returns:

CompletableFuture<DashboardListItems>

getDashboardListItemsWithHttpInfo

public ApiResponse<DashboardListItems> getDashboardListItemsWithHttpInfo(Long dashboardListId)
                                                                  throws ApiException

Fetch the dashboard list’s dashboard definitions.

Parameters:

dashboardListId - ID of the dashboard list to get items from. (required)

Returns:

ApiResponse<DashboardListItems>

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	-

getDashboardListItemsWithHttpInfoAsync

public CompletableFuture<ApiResponse<DashboardListItems>> getDashboardListItemsWithHttpInfoAsync(Long dashboardListId)

Get items of a Dashboard List.

See getDashboardListItemsWithHttpInfo(java.lang.Long).

Parameters:

dashboardListId - ID of the dashboard list to get items from. (required)

Returns:

CompletableFuture<ApiResponse<DashboardListItems>>

updateDashboardListItems

public DashboardListUpdateItemsResponse updateDashboardListItems(Long dashboardListId,
                                                                 DashboardListUpdateItemsRequest body)
                                                          throws ApiException

Update items of a dashboard list.

See updateDashboardListItemsWithHttpInfo(java.lang.Long, com.datadog.api.client.v2.model.DashboardListUpdateItemsRequest).

Parameters:

dashboardListId - ID of the dashboard list to update items from. (required)

body - New dashboards of the dashboard list. (required)

Returns:

DashboardListUpdateItemsResponse

Throws:

ApiException - if fails to make API call

updateDashboardListItemsAsync

public CompletableFuture<DashboardListUpdateItemsResponse> updateDashboardListItemsAsync(Long dashboardListId,
                                                                                         DashboardListUpdateItemsRequest body)

Update items of a dashboard list.

See updateDashboardListItemsWithHttpInfoAsync(java.lang.Long, com.datadog.api.client.v2.model.DashboardListUpdateItemsRequest).

Parameters:

dashboardListId - ID of the dashboard list to update items from. (required)

body - New dashboards of the dashboard list. (required)

Returns:

CompletableFuture<DashboardListUpdateItemsResponse>

updateDashboardListItemsWithHttpInfo

public ApiResponse<DashboardListUpdateItemsResponse> updateDashboardListItemsWithHttpInfo(Long dashboardListId,
                                                                                          DashboardListUpdateItemsRequest body)
                                                                                   throws ApiException

Update dashboards of an existing dashboard list.

Parameters:

dashboardListId - ID of the dashboard list to update items from. (required)

body - New dashboards of the dashboard list. (required)

Returns:

ApiResponse<DashboardListUpdateItemsResponse>

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	-

updateDashboardListItemsWithHttpInfoAsync

public CompletableFuture<ApiResponse<DashboardListUpdateItemsResponse>> updateDashboardListItemsWithHttpInfoAsync(Long dashboardListId,
                                                                                                                  DashboardListUpdateItemsRequest body)

Update items of a dashboard list.

See updateDashboardListItemsWithHttpInfo(java.lang.Long, com.datadog.api.client.v2.model.DashboardListUpdateItemsRequest).

Parameters:

dashboardListId - ID of the dashboard list to update items from. (required)

body - New dashboards of the dashboard list. (required)

Returns:

CompletableFuture<ApiResponse<DashboardListUpdateItemsResponse>>