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

Class DashboardSharingApi

java.lang.Object

com.datadog.api.client.v2.api.DashboardSharingApi

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

Constructor Summary

Constructors

Constructor	Description
DashboardSharingApi()
DashboardSharingApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
ApiClient	getApiClient()	Get the API client.
ListSharedDashboardsResponse	listSharedDashboardsByDashboardId(String dashboardId)	List shared dashboards for a dashboard.
CompletableFuture<ListSharedDashboardsResponse>	listSharedDashboardsByDashboardIdAsync(String dashboardId)	List shared dashboards for a dashboard.
ApiResponse<ListSharedDashboardsResponse>	listSharedDashboardsByDashboardIdWithHttpInfo(String dashboardId)	Retrieve shared dashboards associated with the specified dashboard.
CompletableFuture<ApiResponse<ListSharedDashboardsResponse>>	listSharedDashboardsByDashboardIdWithHttpInfoAsync(String dashboardId)	List shared dashboards for a dashboard.
void	setApiClient(ApiClient apiClient)	Set the API client.

Methods inherited from class java.lang.Object

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

Constructor Details

DashboardSharingApi

public DashboardSharingApi()

DashboardSharingApi

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

listSharedDashboardsByDashboardId

public ListSharedDashboardsResponse listSharedDashboardsByDashboardId(String dashboardId)
                                                               throws ApiException

List shared dashboards for a dashboard.

See listSharedDashboardsByDashboardIdWithHttpInfo(java.lang.String).

Parameters:

dashboardId - ID of the dashboard. (required)

Returns:

ListSharedDashboardsResponse

Throws:

ApiException - if fails to make API call

listSharedDashboardsByDashboardIdAsync

public CompletableFuture<ListSharedDashboardsResponse> listSharedDashboardsByDashboardIdAsync(String dashboardId)

List shared dashboards for a dashboard.

See listSharedDashboardsByDashboardIdWithHttpInfoAsync(java.lang.String).

Parameters:

dashboardId - ID of the dashboard. (required)

Returns:

CompletableFuture<ListSharedDashboardsResponse>

listSharedDashboardsByDashboardIdWithHttpInfo

public ApiResponse<ListSharedDashboardsResponse> listSharedDashboardsByDashboardIdWithHttpInfo(String dashboardId)
                                                                                        throws ApiException

Retrieve shared dashboards associated with the specified dashboard.

Parameters:

dashboardId - ID of the dashboard. (required)

Returns:

ApiResponse<ListSharedDashboardsResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

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

listSharedDashboardsByDashboardIdWithHttpInfoAsync

public CompletableFuture<ApiResponse<ListSharedDashboardsResponse>> listSharedDashboardsByDashboardIdWithHttpInfoAsync(String dashboardId)

List shared dashboards for a dashboard.

See listSharedDashboardsByDashboardIdWithHttpInfo(java.lang.String).

Parameters:

dashboardId - ID of the dashboard. (required)

Returns:

CompletableFuture<ApiResponse<ListSharedDashboardsResponse>>