com.datadog.api.client.v1.api

Class DashboardsApi

java.lang.Object

com.datadog.api.client.v1.api.DashboardsApi

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DashboardsApi.GetPublicDashboardInvitationsOptionalParameters Manage optional parameters to getPublicDashboardInvitations.
static class	DashboardsApi.ListDashboardsOptionalParameters Manage optional parameters to listDashboards.

Constructor Summary

Constructors

Constructor and Description
DashboardsApi()
DashboardsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
Dashboard	createDashboard(Dashboard body) Create a new dashboard.
CompletableFuture<Dashboard>	createDashboardAsync(Dashboard body) Create a new dashboard.
ApiResponse<Dashboard>	createDashboardWithHttpInfo(Dashboard body) Create a dashboard using the specified options.
CompletableFuture<ApiResponse<Dashboard>>	createDashboardWithHttpInfoAsync(Dashboard body) Create a new dashboard.
SharedDashboard	createPublicDashboard(SharedDashboard body) Create a shared dashboard.
CompletableFuture<SharedDashboard>	createPublicDashboardAsync(SharedDashboard body) Create a shared dashboard.
ApiResponse<SharedDashboard>	createPublicDashboardWithHttpInfo(SharedDashboard body) Share a specified private dashboard, generating a URL at which it can be publicly viewed.
CompletableFuture<ApiResponse<SharedDashboard>>	createPublicDashboardWithHttpInfoAsync(SharedDashboard body) Create a shared dashboard.
DashboardDeleteResponse	deleteDashboard(String dashboardId) Delete a dashboard.
CompletableFuture<DashboardDeleteResponse>	deleteDashboardAsync(String dashboardId) Delete a dashboard.
void	deleteDashboards(DashboardBulkDeleteRequest body) Delete dashboards.
CompletableFuture<Void>	deleteDashboardsAsync(DashboardBulkDeleteRequest body) Delete dashboards.
ApiResponse<Void>	deleteDashboardsWithHttpInfo(DashboardBulkDeleteRequest body) Delete dashboards using the specified IDs.
CompletableFuture<ApiResponse<Void>>	deleteDashboardsWithHttpInfoAsync(DashboardBulkDeleteRequest body) Delete dashboards.
ApiResponse<DashboardDeleteResponse>	deleteDashboardWithHttpInfo(String dashboardId) Delete a dashboard using the specified ID.
CompletableFuture<ApiResponse<DashboardDeleteResponse>>	deleteDashboardWithHttpInfoAsync(String dashboardId) Delete a dashboard.
DeleteSharedDashboardResponse	deletePublicDashboard(String token) Revoke a shared dashboard URL.
CompletableFuture<DeleteSharedDashboardResponse>	deletePublicDashboardAsync(String token) Revoke a shared dashboard URL.
void	deletePublicDashboardInvitation(String token, SharedDashboardInvites body) Revoke shared dashboard invitations.
CompletableFuture<Void>	deletePublicDashboardInvitationAsync(String token, SharedDashboardInvites body) Revoke shared dashboard invitations.
ApiResponse<Void>	deletePublicDashboardInvitationWithHttpInfo(String token, SharedDashboardInvites body) Revoke previously sent invitation emails and active sessions used to access a given shared dashboard for specific email addresses.
CompletableFuture<ApiResponse<Void>>	deletePublicDashboardInvitationWithHttpInfoAsync(String token, SharedDashboardInvites body) Revoke shared dashboard invitations.
ApiResponse<DeleteSharedDashboardResponse>	deletePublicDashboardWithHttpInfo(String token) Revoke the public URL for a dashboard (rendering it private) associated with the specified token.
CompletableFuture<ApiResponse<DeleteSharedDashboardResponse>>	deletePublicDashboardWithHttpInfoAsync(String token) Revoke a shared dashboard URL.
ApiClient	getApiClient() Get the API client.
Dashboard	getDashboard(String dashboardId) Get a dashboard.
CompletableFuture<Dashboard>	getDashboardAsync(String dashboardId) Get a dashboard.
ApiResponse<Dashboard>	getDashboardWithHttpInfo(String dashboardId) Get a dashboard using the specified ID.
CompletableFuture<ApiResponse<Dashboard>>	getDashboardWithHttpInfoAsync(String dashboardId) Get a dashboard.
SharedDashboard	getPublicDashboard(String token) Get a shared dashboard.
CompletableFuture<SharedDashboard>	getPublicDashboardAsync(String token) Get a shared dashboard.
SharedDashboardInvites	getPublicDashboardInvitations(String token) Get all invitations for a shared dashboard.
SharedDashboardInvites	getPublicDashboardInvitations(String token, DashboardsApi.GetPublicDashboardInvitationsOptionalParameters parameters) Get all invitations for a shared dashboard.
CompletableFuture<SharedDashboardInvites>	getPublicDashboardInvitationsAsync(String token) Get all invitations for a shared dashboard.
CompletableFuture<SharedDashboardInvites>	getPublicDashboardInvitationsAsync(String token, DashboardsApi.GetPublicDashboardInvitationsOptionalParameters parameters) Get all invitations for a shared dashboard.
ApiResponse<SharedDashboardInvites>	getPublicDashboardInvitationsWithHttpInfo(String token, DashboardsApi.GetPublicDashboardInvitationsOptionalParameters parameters) Describe the invitations that exist for the given shared dashboard (paginated).
CompletableFuture<ApiResponse<SharedDashboardInvites>>	getPublicDashboardInvitationsWithHttpInfoAsync(String token, DashboardsApi.GetPublicDashboardInvitationsOptionalParameters parameters) Get all invitations for a shared dashboard.
ApiResponse<SharedDashboard>	getPublicDashboardWithHttpInfo(String token) Fetch an existing shared dashboard's sharing metadata associated with the specified token.
CompletableFuture<ApiResponse<SharedDashboard>>	getPublicDashboardWithHttpInfoAsync(String token) Get a shared dashboard.
DashboardSummary	listDashboards() Get all dashboards.
DashboardSummary	listDashboards(DashboardsApi.ListDashboardsOptionalParameters parameters) Get all dashboards.
CompletableFuture<DashboardSummary>	listDashboardsAsync() Get all dashboards.
CompletableFuture<DashboardSummary>	listDashboardsAsync(DashboardsApi.ListDashboardsOptionalParameters parameters) Get all dashboards.
ApiResponse<DashboardSummary>	listDashboardsWithHttpInfo(DashboardsApi.ListDashboardsOptionalParameters parameters) Get all dashboards.
CompletableFuture<ApiResponse<DashboardSummary>>	listDashboardsWithHttpInfoAsync(DashboardsApi.ListDashboardsOptionalParameters parameters) Get all dashboards.
PaginationIterable<DashboardSummaryDefinition>	listDashboardsWithPagination() Get all dashboards.
PaginationIterable<DashboardSummaryDefinition>	listDashboardsWithPagination(DashboardsApi.ListDashboardsOptionalParameters parameters) Get all dashboards.
void	restoreDashboards(DashboardRestoreRequest body) Restore deleted dashboards.
CompletableFuture<Void>	restoreDashboardsAsync(DashboardRestoreRequest body) Restore deleted dashboards.
ApiResponse<Void>	restoreDashboardsWithHttpInfo(DashboardRestoreRequest body) Restore dashboards using the specified IDs.
CompletableFuture<ApiResponse<Void>>	restoreDashboardsWithHttpInfoAsync(DashboardRestoreRequest body) Restore deleted dashboards.
SharedDashboardInvites	sendPublicDashboardInvitation(String token, SharedDashboardInvites body) Send shared dashboard invitation email.
CompletableFuture<SharedDashboardInvites>	sendPublicDashboardInvitationAsync(String token, SharedDashboardInvites body) Send shared dashboard invitation email.
ApiResponse<SharedDashboardInvites>	sendPublicDashboardInvitationWithHttpInfo(String token, SharedDashboardInvites body) Send emails to specified email addresses containing links to access a given authenticated shared dashboard.
CompletableFuture<ApiResponse<SharedDashboardInvites>>	sendPublicDashboardInvitationWithHttpInfoAsync(String token, SharedDashboardInvites body) Send shared dashboard invitation email.
void	setApiClient(ApiClient apiClient) Set the API client.
Dashboard	updateDashboard(String dashboardId, Dashboard body) Update a dashboard.
CompletableFuture<Dashboard>	updateDashboardAsync(String dashboardId, Dashboard body) Update a dashboard.
ApiResponse<Dashboard>	updateDashboardWithHttpInfo(String dashboardId, Dashboard body) Update a dashboard using the specified ID.
CompletableFuture<ApiResponse<Dashboard>>	updateDashboardWithHttpInfoAsync(String dashboardId, Dashboard body) Update a dashboard.
SharedDashboard	updatePublicDashboard(String token, SharedDashboardUpdateRequest body) Update a shared dashboard.
CompletableFuture<SharedDashboard>	updatePublicDashboardAsync(String token, SharedDashboardUpdateRequest body) Update a shared dashboard.
ApiResponse<SharedDashboard>	updatePublicDashboardWithHttpInfo(String token, SharedDashboardUpdateRequest body) Update a shared dashboard associated with the specified token.
CompletableFuture<ApiResponse<SharedDashboard>>	updatePublicDashboardWithHttpInfoAsync(String token, SharedDashboardUpdateRequest body) Update a shared dashboard.

Methods inherited from class java.lang.Object

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

Constructor Detail

DashboardsApi

public DashboardsApi()

DashboardsApi

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

createDashboard

public Dashboard createDashboard(Dashboard body)
                          throws ApiException

Create a new dashboard.

See createDashboardWithHttpInfo(com.datadog.api.client.v1.model.Dashboard).

Parameters:

body - Create a dashboard request body. (required)

Returns:

Dashboard

Throws:

ApiException - if fails to make API call

createDashboardAsync

public CompletableFuture<Dashboard> createDashboardAsync(Dashboard body)

Create a new dashboard.

See createDashboardWithHttpInfoAsync(com.datadog.api.client.v1.model.Dashboard).

Parameters:

body - Create a dashboard request body. (required)

Returns:

CompletableFuture<Dashboard>

createDashboardWithHttpInfo

public ApiResponse<Dashboard> createDashboardWithHttpInfo(Dashboard body)
                                                   throws ApiException

Create a dashboard using the specified options. When defining queries in your widgets, take note of which queries should have the as_count() or as_rate() modifiers appended. Refer to the following documentation for more information on these modifiers.

Parameters:

body - Create a dashboard request body. (required)

Returns:

ApiResponse<Dashboard>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

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

createDashboardWithHttpInfoAsync

public CompletableFuture<ApiResponse<Dashboard>> createDashboardWithHttpInfoAsync(Dashboard body)

Create a new dashboard.

See createDashboardWithHttpInfo(com.datadog.api.client.v1.model.Dashboard).

Parameters:

body - Create a dashboard request body. (required)

Returns:

CompletableFuture<ApiResponse<Dashboard>>

createPublicDashboard

public SharedDashboard createPublicDashboard(SharedDashboard body)
                                      throws ApiException

Create a shared dashboard.

See createPublicDashboardWithHttpInfo(com.datadog.api.client.v1.model.SharedDashboard).

Parameters:

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

Returns:

SharedDashboard

Throws:

ApiException - if fails to make API call

createPublicDashboardAsync

public CompletableFuture<SharedDashboard> createPublicDashboardAsync(SharedDashboard body)

Create a shared dashboard.

See createPublicDashboardWithHttpInfoAsync(com.datadog.api.client.v1.model.SharedDashboard).

Parameters:

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

Returns:

CompletableFuture<SharedDashboard>

createPublicDashboardWithHttpInfo

public ApiResponse<SharedDashboard> createPublicDashboardWithHttpInfo(SharedDashboard body)
                                                               throws ApiException

Share a specified private dashboard, generating a URL at which it can be publicly viewed.

Parameters:

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

Returns:

ApiResponse<SharedDashboard>

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	Dashboard Not Found	-
429	Too many requests	-

createPublicDashboardWithHttpInfoAsync

public CompletableFuture<ApiResponse<SharedDashboard>> createPublicDashboardWithHttpInfoAsync(SharedDashboard body)

Create a shared dashboard.

See createPublicDashboardWithHttpInfo(com.datadog.api.client.v1.model.SharedDashboard).

Parameters:

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

Returns:

CompletableFuture<ApiResponse<SharedDashboard>>

deleteDashboard

public DashboardDeleteResponse deleteDashboard(String dashboardId)
                                        throws ApiException

Delete a dashboard.

See deleteDashboardWithHttpInfo(java.lang.String).

Parameters:

dashboardId - The ID of the dashboard. (required)

Returns:

DashboardDeleteResponse

Throws:

ApiException - if fails to make API call

deleteDashboardAsync

public CompletableFuture<DashboardDeleteResponse> deleteDashboardAsync(String dashboardId)

Delete a dashboard.

See deleteDashboardWithHttpInfoAsync(java.lang.String).

Parameters:

dashboardId - The ID of the dashboard. (required)

Returns:

CompletableFuture<DashboardDeleteResponse>

deleteDashboardWithHttpInfo

public ApiResponse<DashboardDeleteResponse> deleteDashboardWithHttpInfo(String dashboardId)
                                                                 throws ApiException

Delete a dashboard using the specified ID.

Parameters:

dashboardId - The ID of the dashboard. (required)

Returns:

ApiResponse<DashboardDeleteResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

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

deleteDashboardWithHttpInfoAsync

public CompletableFuture<ApiResponse<DashboardDeleteResponse>> deleteDashboardWithHttpInfoAsync(String dashboardId)

Delete a dashboard.

See deleteDashboardWithHttpInfo(java.lang.String).

Parameters:

dashboardId - The ID of the dashboard. (required)

Returns:

CompletableFuture<ApiResponse<DashboardDeleteResponse>>

deleteDashboards

public void deleteDashboards(DashboardBulkDeleteRequest body)
                      throws ApiException

Delete dashboards.

See deleteDashboardsWithHttpInfo(com.datadog.api.client.v1.model.DashboardBulkDeleteRequest).

Parameters:

body - Delete dashboards request body. (required)

Throws:

ApiException - if fails to make API call

deleteDashboardsAsync

public CompletableFuture<Void> deleteDashboardsAsync(DashboardBulkDeleteRequest body)

Delete dashboards.

See deleteDashboardsWithHttpInfoAsync(com.datadog.api.client.v1.model.DashboardBulkDeleteRequest).

Parameters:

body - Delete dashboards request body. (required)

Returns:

CompletableFuture

deleteDashboardsWithHttpInfo

public ApiResponse<Void> deleteDashboardsWithHttpInfo(DashboardBulkDeleteRequest body)
                                               throws ApiException

Delete dashboards using the specified IDs. If there are any failures, no dashboards will be deleted (partial success is not allowed).

Parameters:

body - Delete dashboards request body. (required)

Returns:

ApiResponse<Void>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
204	No Content	-
400	Bad Request	-
403	Forbidden	-
404	Dashboards Not Found	-
429	Too many requests	-

deleteDashboardsWithHttpInfoAsync

public CompletableFuture<ApiResponse<Void>> deleteDashboardsWithHttpInfoAsync(DashboardBulkDeleteRequest body)

Delete dashboards.

See deleteDashboardsWithHttpInfo(com.datadog.api.client.v1.model.DashboardBulkDeleteRequest).

Parameters:

body - Delete dashboards request body. (required)

Returns:

CompletableFuture<ApiResponse<Void>>

deletePublicDashboard

public DeleteSharedDashboardResponse deletePublicDashboard(String token)
                                                    throws ApiException

Revoke a shared dashboard URL.

See deletePublicDashboardWithHttpInfo(java.lang.String).

Parameters:

token - The token of the shared dashboard. (required)

Returns:

DeleteSharedDashboardResponse

Throws:

ApiException - if fails to make API call

deletePublicDashboardAsync

public CompletableFuture<DeleteSharedDashboardResponse> deletePublicDashboardAsync(String token)

Revoke a shared dashboard URL.

See deletePublicDashboardWithHttpInfoAsync(java.lang.String).

Parameters:

token - The token of the shared dashboard. (required)

Returns:

CompletableFuture<DeleteSharedDashboardResponse>

deletePublicDashboardWithHttpInfo

public ApiResponse<DeleteSharedDashboardResponse> deletePublicDashboardWithHttpInfo(String token)
                                                                             throws ApiException

Revoke the public URL for a dashboard (rendering it private) associated with the specified token.

Parameters:

token - The token of the shared dashboard. (required)

Returns:

ApiResponse<DeleteSharedDashboardResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

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

deletePublicDashboardWithHttpInfoAsync

public CompletableFuture<ApiResponse<DeleteSharedDashboardResponse>> deletePublicDashboardWithHttpInfoAsync(String token)

Revoke a shared dashboard URL.

See deletePublicDashboardWithHttpInfo(java.lang.String).

Parameters:

token - The token of the shared dashboard. (required)

Returns:

CompletableFuture<ApiResponse<DeleteSharedDashboardResponse>>

deletePublicDashboardInvitation

public void deletePublicDashboardInvitation(String token,
                                            SharedDashboardInvites body)
                                     throws ApiException

Revoke shared dashboard invitations.

See deletePublicDashboardInvitationWithHttpInfo(java.lang.String, com.datadog.api.client.v1.model.SharedDashboardInvites).

Parameters:

token - The token of the shared dashboard. (required)

body - Shared Dashboard Invitation deletion request body. (required)

Throws:

ApiException - if fails to make API call

deletePublicDashboardInvitationAsync

public CompletableFuture<Void> deletePublicDashboardInvitationAsync(String token,
                                                                    SharedDashboardInvites body)

Revoke shared dashboard invitations.

See deletePublicDashboardInvitationWithHttpInfoAsync(java.lang.String, com.datadog.api.client.v1.model.SharedDashboardInvites).

Parameters:

token - The token of the shared dashboard. (required)

body - Shared Dashboard Invitation deletion request body. (required)

Returns:

CompletableFuture

deletePublicDashboardInvitationWithHttpInfo

public ApiResponse<Void> deletePublicDashboardInvitationWithHttpInfo(String token,
                                                                     SharedDashboardInvites body)
                                                              throws ApiException

Revoke previously sent invitation emails and active sessions used to access a given shared dashboard for specific email addresses.

Parameters:

token - The token of the shared dashboard. (required)

body - Shared Dashboard Invitation deletion request 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	-
403	Forbidden	-
404	Not Found	-
429	Too many requests	-

deletePublicDashboardInvitationWithHttpInfoAsync

public CompletableFuture<ApiResponse<Void>> deletePublicDashboardInvitationWithHttpInfoAsync(String token,
                                                                                             SharedDashboardInvites body)

Revoke shared dashboard invitations.

See deletePublicDashboardInvitationWithHttpInfo(java.lang.String, com.datadog.api.client.v1.model.SharedDashboardInvites).

Parameters:

token - The token of the shared dashboard. (required)

body - Shared Dashboard Invitation deletion request body. (required)

Returns:

CompletableFuture<ApiResponse<Void>>

getDashboard

public Dashboard getDashboard(String dashboardId)
                       throws ApiException

Get a dashboard.

See getDashboardWithHttpInfo(java.lang.String).

Parameters:

dashboardId - The ID of the dashboard. (required)

Returns:

Dashboard

Throws:

ApiException - if fails to make API call

getDashboardAsync

public CompletableFuture<Dashboard> getDashboardAsync(String dashboardId)

Get a dashboard.

See getDashboardWithHttpInfoAsync(java.lang.String).

Parameters:

dashboardId - The ID of the dashboard. (required)

Returns:

CompletableFuture<Dashboard>

getDashboardWithHttpInfo

public ApiResponse<Dashboard> getDashboardWithHttpInfo(String dashboardId)
                                                throws ApiException

Get a dashboard using the specified ID.

Parameters:

dashboardId - The ID of the dashboard. (required)

Returns:

ApiResponse<Dashboard>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

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

getDashboardWithHttpInfoAsync

public CompletableFuture<ApiResponse<Dashboard>> getDashboardWithHttpInfoAsync(String dashboardId)

Get a dashboard.

See getDashboardWithHttpInfo(java.lang.String).

Parameters:

dashboardId - The ID of the dashboard. (required)

Returns:

CompletableFuture<ApiResponse<Dashboard>>

getPublicDashboard

public SharedDashboard getPublicDashboard(String token)
                                   throws ApiException

Get a shared dashboard.

See getPublicDashboardWithHttpInfo(java.lang.String).

Parameters:

token - The token of the shared dashboard. Generated when a dashboard is shared. (required)

Returns:

SharedDashboard

Throws:

ApiException - if fails to make API call

getPublicDashboardAsync

public CompletableFuture<SharedDashboard> getPublicDashboardAsync(String token)

Get a shared dashboard.

See getPublicDashboardWithHttpInfoAsync(java.lang.String).

Parameters:

token - The token of the shared dashboard. Generated when a dashboard is shared. (required)

Returns:

CompletableFuture<SharedDashboard>

getPublicDashboardWithHttpInfo

public ApiResponse<SharedDashboard> getPublicDashboardWithHttpInfo(String token)
                                                            throws ApiException

Fetch an existing shared dashboard's sharing metadata associated with the specified token.

Parameters:

token - The token of the shared dashboard. Generated when a dashboard is shared. (required)

Returns:

ApiResponse<SharedDashboard>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

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

getPublicDashboardWithHttpInfoAsync

public CompletableFuture<ApiResponse<SharedDashboard>> getPublicDashboardWithHttpInfoAsync(String token)

Get a shared dashboard.

See getPublicDashboardWithHttpInfo(java.lang.String).

Parameters:

token - The token of the shared dashboard. Generated when a dashboard is shared. (required)

Returns:

CompletableFuture<ApiResponse<SharedDashboard>>

getPublicDashboardInvitations

public SharedDashboardInvites getPublicDashboardInvitations(String token)
                                                     throws ApiException

Get all invitations for a shared dashboard.

See getPublicDashboardInvitationsWithHttpInfo(java.lang.String, com.datadog.api.client.v1.api.DashboardsApi.GetPublicDashboardInvitationsOptionalParameters).

Parameters:

token - Token of the shared dashboard for which to fetch invitations. (required)

Returns:

SharedDashboardInvites

Throws:

ApiException - if fails to make API call

getPublicDashboardInvitationsAsync

public CompletableFuture<SharedDashboardInvites> getPublicDashboardInvitationsAsync(String token)

Get all invitations for a shared dashboard.

See getPublicDashboardInvitationsWithHttpInfoAsync(java.lang.String, com.datadog.api.client.v1.api.DashboardsApi.GetPublicDashboardInvitationsOptionalParameters).

Parameters:

token - Token of the shared dashboard for which to fetch invitations. (required)

Returns:

CompletableFuture<SharedDashboardInvites>

getPublicDashboardInvitations

public SharedDashboardInvites getPublicDashboardInvitations(String token,
                                                            DashboardsApi.GetPublicDashboardInvitationsOptionalParameters parameters)
                                                     throws ApiException

Get all invitations for a shared dashboard.

See getPublicDashboardInvitationsWithHttpInfo(java.lang.String, com.datadog.api.client.v1.api.DashboardsApi.GetPublicDashboardInvitationsOptionalParameters).

Parameters:

token - Token of the shared dashboard for which to fetch invitations. (required)

parameters - Optional parameters for the request.

Returns:

SharedDashboardInvites

Throws:

ApiException - if fails to make API call

getPublicDashboardInvitationsAsync

public CompletableFuture<SharedDashboardInvites> getPublicDashboardInvitationsAsync(String token,
                                                                                    DashboardsApi.GetPublicDashboardInvitationsOptionalParameters parameters)

Get all invitations for a shared dashboard.

See getPublicDashboardInvitationsWithHttpInfoAsync(java.lang.String, com.datadog.api.client.v1.api.DashboardsApi.GetPublicDashboardInvitationsOptionalParameters).

Parameters:

token - Token of the shared dashboard for which to fetch invitations. (required)

parameters - Optional parameters for the request.

Returns:

CompletableFuture<SharedDashboardInvites>

getPublicDashboardInvitationsWithHttpInfo

public ApiResponse<SharedDashboardInvites> getPublicDashboardInvitationsWithHttpInfo(String token,
                                                                                     DashboardsApi.GetPublicDashboardInvitationsOptionalParameters parameters)
                                                                              throws ApiException

Describe the invitations that exist for the given shared dashboard (paginated).

Parameters:

token - Token of the shared dashboard for which to fetch invitations. (required)

parameters - Optional parameters for the request.

Returns:

ApiResponse<SharedDashboardInvites>

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	-

getPublicDashboardInvitationsWithHttpInfoAsync

public CompletableFuture<ApiResponse<SharedDashboardInvites>> getPublicDashboardInvitationsWithHttpInfoAsync(String token,
                                                                                                             DashboardsApi.GetPublicDashboardInvitationsOptionalParameters parameters)

Get all invitations for a shared dashboard.

See getPublicDashboardInvitationsWithHttpInfo(java.lang.String, com.datadog.api.client.v1.api.DashboardsApi.GetPublicDashboardInvitationsOptionalParameters).

Parameters:

token - Token of the shared dashboard for which to fetch invitations. (required)

parameters - Optional parameters for the request.

Returns:

CompletableFuture<ApiResponse<SharedDashboardInvites>>

listDashboards

public DashboardSummary listDashboards()
                                throws ApiException

Get all dashboards.

See listDashboardsWithHttpInfo(com.datadog.api.client.v1.api.DashboardsApi.ListDashboardsOptionalParameters).

Returns:

DashboardSummary

Throws:

ApiException - if fails to make API call

listDashboardsAsync

public CompletableFuture<DashboardSummary> listDashboardsAsync()

Get all dashboards.

See listDashboardsWithHttpInfoAsync(com.datadog.api.client.v1.api.DashboardsApi.ListDashboardsOptionalParameters).

Returns:

CompletableFuture<DashboardSummary>

listDashboards

public DashboardSummary listDashboards(DashboardsApi.ListDashboardsOptionalParameters parameters)
                                throws ApiException

Get all dashboards.

See listDashboardsWithHttpInfo(com.datadog.api.client.v1.api.DashboardsApi.ListDashboardsOptionalParameters).

Parameters:

parameters - Optional parameters for the request.

Returns:

DashboardSummary

Throws:

ApiException - if fails to make API call

listDashboardsAsync

public CompletableFuture<DashboardSummary> listDashboardsAsync(DashboardsApi.ListDashboardsOptionalParameters parameters)

Get all dashboards.

See listDashboardsWithHttpInfoAsync(com.datadog.api.client.v1.api.DashboardsApi.ListDashboardsOptionalParameters).

Parameters:

parameters - Optional parameters for the request.

Returns:

CompletableFuture<DashboardSummary>

listDashboardsWithPagination

public PaginationIterable<DashboardSummaryDefinition> listDashboardsWithPagination()

Get all dashboards.

See listDashboardsWithHttpInfo(com.datadog.api.client.v1.api.DashboardsApi.ListDashboardsOptionalParameters).

Returns:

PaginationIterable<DashboardSummaryDefinition>

listDashboardsWithPagination

public PaginationIterable<DashboardSummaryDefinition> listDashboardsWithPagination(DashboardsApi.ListDashboardsOptionalParameters parameters)

Get all dashboards.

See listDashboardsWithHttpInfo(com.datadog.api.client.v1.api.DashboardsApi.ListDashboardsOptionalParameters).

Returns:

DashboardSummary

listDashboardsWithHttpInfo

public ApiResponse<DashboardSummary> listDashboardsWithHttpInfo(DashboardsApi.ListDashboardsOptionalParameters parameters)
                                                         throws ApiException

Get all dashboards.

Note: This query will only return custom created or cloned dashboards. This query will not return preset dashboards.

Parameters:

parameters - Optional parameters for the request.

Returns:

ApiResponse<DashboardSummary>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

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

listDashboardsWithHttpInfoAsync

public CompletableFuture<ApiResponse<DashboardSummary>> listDashboardsWithHttpInfoAsync(DashboardsApi.ListDashboardsOptionalParameters parameters)

Get all dashboards.

See listDashboardsWithHttpInfo(com.datadog.api.client.v1.api.DashboardsApi.ListDashboardsOptionalParameters).

Parameters:

parameters - Optional parameters for the request.

Returns:

CompletableFuture<ApiResponse<DashboardSummary>>

restoreDashboards

public void restoreDashboards(DashboardRestoreRequest body)
                       throws ApiException

Restore deleted dashboards.

See restoreDashboardsWithHttpInfo(com.datadog.api.client.v1.model.DashboardRestoreRequest).

Parameters:

body - Restore dashboards request body. (required)

Throws:

ApiException - if fails to make API call

restoreDashboardsAsync

public CompletableFuture<Void> restoreDashboardsAsync(DashboardRestoreRequest body)

Restore deleted dashboards.

See restoreDashboardsWithHttpInfoAsync(com.datadog.api.client.v1.model.DashboardRestoreRequest).

Parameters:

body - Restore dashboards request body. (required)

Returns:

CompletableFuture

restoreDashboardsWithHttpInfo

public ApiResponse<Void> restoreDashboardsWithHttpInfo(DashboardRestoreRequest body)
                                                throws ApiException

Restore dashboards using the specified IDs. If there are any failures, no dashboards will be restored (partial success is not allowed).

Parameters:

body - Restore dashboards request body. (required)

Returns:

ApiResponse<Void>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
204	No Content	-
400	Bad Request	-
403	Forbidden	-
404	Dashboards Not Found	-
429	Too many requests	-

restoreDashboardsWithHttpInfoAsync

public CompletableFuture<ApiResponse<Void>> restoreDashboardsWithHttpInfoAsync(DashboardRestoreRequest body)

Restore deleted dashboards.

See restoreDashboardsWithHttpInfo(com.datadog.api.client.v1.model.DashboardRestoreRequest).

Parameters:

body - Restore dashboards request body. (required)

Returns:

CompletableFuture<ApiResponse<Void>>

sendPublicDashboardInvitation

public SharedDashboardInvites sendPublicDashboardInvitation(String token,
                                                            SharedDashboardInvites body)
                                                     throws ApiException

Send shared dashboard invitation email.

See sendPublicDashboardInvitationWithHttpInfo(java.lang.String, com.datadog.api.client.v1.model.SharedDashboardInvites).

Parameters:

token - The token of the shared dashboard. (required)

body - Shared Dashboard Invitation request body. (required)

Returns:

SharedDashboardInvites

Throws:

ApiException - if fails to make API call

sendPublicDashboardInvitationAsync

public CompletableFuture<SharedDashboardInvites> sendPublicDashboardInvitationAsync(String token,
                                                                                    SharedDashboardInvites body)

Send shared dashboard invitation email.

See sendPublicDashboardInvitationWithHttpInfoAsync(java.lang.String, com.datadog.api.client.v1.model.SharedDashboardInvites).

Parameters:

token - The token of the shared dashboard. (required)

body - Shared Dashboard Invitation request body. (required)

Returns:

CompletableFuture<SharedDashboardInvites>

sendPublicDashboardInvitationWithHttpInfo

public ApiResponse<SharedDashboardInvites> sendPublicDashboardInvitationWithHttpInfo(String token,
                                                                                     SharedDashboardInvites body)
                                                                              throws ApiException

Send emails to specified email addresses containing links to access a given authenticated shared dashboard. Email addresses must already belong to the authenticated shared dashboard's share_list.

Parameters:

token - The token of the shared dashboard. (required)

body - Shared Dashboard Invitation request body. (required)

Returns:

ApiResponse<SharedDashboardInvites>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

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

sendPublicDashboardInvitationWithHttpInfoAsync

public CompletableFuture<ApiResponse<SharedDashboardInvites>> sendPublicDashboardInvitationWithHttpInfoAsync(String token,
                                                                                                             SharedDashboardInvites body)

Send shared dashboard invitation email.

See sendPublicDashboardInvitationWithHttpInfo(java.lang.String, com.datadog.api.client.v1.model.SharedDashboardInvites).

Parameters:

token - The token of the shared dashboard. (required)

body - Shared Dashboard Invitation request body. (required)

Returns:

CompletableFuture<ApiResponse<SharedDashboardInvites>>

updateDashboard

public Dashboard updateDashboard(String dashboardId,
                                 Dashboard body)
                          throws ApiException

Update a dashboard.

See updateDashboardWithHttpInfo(java.lang.String, com.datadog.api.client.v1.model.Dashboard).

Parameters:

dashboardId - The ID of the dashboard. (required)

body - Update Dashboard request body. (required)

Returns:

Dashboard

Throws:

ApiException - if fails to make API call

updateDashboardAsync

public CompletableFuture<Dashboard> updateDashboardAsync(String dashboardId,
                                                         Dashboard body)

Update a dashboard.

See updateDashboardWithHttpInfoAsync(java.lang.String, com.datadog.api.client.v1.model.Dashboard).

Parameters:

dashboardId - The ID of the dashboard. (required)

body - Update Dashboard request body. (required)

Returns:

CompletableFuture<Dashboard>

updateDashboardWithHttpInfo

public ApiResponse<Dashboard> updateDashboardWithHttpInfo(String dashboardId,
                                                          Dashboard body)
                                                   throws ApiException

Update a dashboard using the specified ID.

Parameters:

dashboardId - The ID of the dashboard. (required)

body - Update Dashboard request body. (required)

Returns:

ApiResponse<Dashboard>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK	-
400	Bad Request	-
403	Authentication Error	-
404	Item Not Found	-
429	Too many requests	-

updateDashboardWithHttpInfoAsync

public CompletableFuture<ApiResponse<Dashboard>> updateDashboardWithHttpInfoAsync(String dashboardId,
                                                                                  Dashboard body)

Update a dashboard.

See updateDashboardWithHttpInfo(java.lang.String, com.datadog.api.client.v1.model.Dashboard).

Parameters:

dashboardId - The ID of the dashboard. (required)

body - Update Dashboard request body. (required)

Returns:

CompletableFuture<ApiResponse<Dashboard>>

updatePublicDashboard

public SharedDashboard updatePublicDashboard(String token,
                                             SharedDashboardUpdateRequest body)
                                      throws ApiException

Update a shared dashboard.

See updatePublicDashboardWithHttpInfo(java.lang.String, com.datadog.api.client.v1.model.SharedDashboardUpdateRequest).

Parameters:

token - The token of the shared dashboard. (required)

body - Update Dashboard request body. (required)

Returns:

SharedDashboard

Throws:

ApiException - if fails to make API call

updatePublicDashboardAsync

public CompletableFuture<SharedDashboard> updatePublicDashboardAsync(String token,
                                                                     SharedDashboardUpdateRequest body)

Update a shared dashboard.

See updatePublicDashboardWithHttpInfoAsync(java.lang.String, com.datadog.api.client.v1.model.SharedDashboardUpdateRequest).

Parameters:

token - The token of the shared dashboard. (required)

body - Update Dashboard request body. (required)

Returns:

CompletableFuture<SharedDashboard>

updatePublicDashboardWithHttpInfo

public ApiResponse<SharedDashboard> updatePublicDashboardWithHttpInfo(String token,
                                                                      SharedDashboardUpdateRequest body)
                                                               throws ApiException

Update a shared dashboard associated with the specified token.

Parameters:

token - The token of the shared dashboard. (required)

body - Update Dashboard request body. (required)

Returns:

ApiResponse<SharedDashboard>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK	-
400	Bad Request	-
403	Authentication Error	-
404	Item Not Found	-
429	Too many requests	-

updatePublicDashboardWithHttpInfoAsync

public CompletableFuture<ApiResponse<SharedDashboard>> updatePublicDashboardWithHttpInfoAsync(String token,
                                                                                              SharedDashboardUpdateRequest body)

Update a shared dashboard.

See updatePublicDashboardWithHttpInfo(java.lang.String, com.datadog.api.client.v1.model.SharedDashboardUpdateRequest).

Parameters:

token - The token of the shared dashboard. (required)

body - Update Dashboard request body. (required)

Returns:

CompletableFuture<ApiResponse<SharedDashboard>>