com.datadog.api.client.v2.api

Class DashboardSecureEmbedApi

java.lang.Object

com.datadog.api.client.v2.api.DashboardSecureEmbedApi

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

Constructor Summary

Constructors

Constructor and Description
DashboardSecureEmbedApi()
DashboardSecureEmbedApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
SecureEmbedCreateResponse	createDashboardSecureEmbed(String dashboardId, SecureEmbedCreateRequest body) Create a secure embed for a dashboard.
CompletableFuture<SecureEmbedCreateResponse>	createDashboardSecureEmbedAsync(String dashboardId, SecureEmbedCreateRequest body) Create a secure embed for a dashboard.
ApiResponse<SecureEmbedCreateResponse>	createDashboardSecureEmbedWithHttpInfo(String dashboardId, SecureEmbedCreateRequest body) Create a secure embed share for a dashboard.
CompletableFuture<ApiResponse<SecureEmbedCreateResponse>>	createDashboardSecureEmbedWithHttpInfoAsync(String dashboardId, SecureEmbedCreateRequest body) Create a secure embed for a dashboard.
void	deleteDashboardSecureEmbed(String dashboardId, String token) Delete a secure embed for a dashboard.
CompletableFuture<Void>	deleteDashboardSecureEmbedAsync(String dashboardId, String token) Delete a secure embed for a dashboard.
ApiResponse<Void>	deleteDashboardSecureEmbedWithHttpInfo(String dashboardId, String token) Delete a secure embed share for a dashboard.
CompletableFuture<ApiResponse<Void>>	deleteDashboardSecureEmbedWithHttpInfoAsync(String dashboardId, String token) Delete a secure embed for a dashboard.
ApiClient	getApiClient() Get the API client.
SecureEmbedGetResponse	getDashboardSecureEmbed(String dashboardId, String token) Get a secure embed for a dashboard.
CompletableFuture<SecureEmbedGetResponse>	getDashboardSecureEmbedAsync(String dashboardId, String token) Get a secure embed for a dashboard.
ApiResponse<SecureEmbedGetResponse>	getDashboardSecureEmbedWithHttpInfo(String dashboardId, String token) Retrieve an existing secure embed configuration for a dashboard.
CompletableFuture<ApiResponse<SecureEmbedGetResponse>>	getDashboardSecureEmbedWithHttpInfoAsync(String dashboardId, String token) Get a secure embed for a dashboard.
void	setApiClient(ApiClient apiClient) Set the API client.
SecureEmbedUpdateResponse	updateDashboardSecureEmbed(String dashboardId, String token, SecureEmbedUpdateRequest body) Update a secure embed for a dashboard.
CompletableFuture<SecureEmbedUpdateResponse>	updateDashboardSecureEmbedAsync(String dashboardId, String token, SecureEmbedUpdateRequest body) Update a secure embed for a dashboard.
ApiResponse<SecureEmbedUpdateResponse>	updateDashboardSecureEmbedWithHttpInfo(String dashboardId, String token, SecureEmbedUpdateRequest body) Partially update a secure embed configuration.
CompletableFuture<ApiResponse<SecureEmbedUpdateResponse>>	updateDashboardSecureEmbedWithHttpInfoAsync(String dashboardId, String token, SecureEmbedUpdateRequest body) Update a secure embed for a dashboard.

Methods inherited from class java.lang.Object

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

Constructor Detail

DashboardSecureEmbedApi

public DashboardSecureEmbedApi()

DashboardSecureEmbedApi

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

createDashboardSecureEmbed

public SecureEmbedCreateResponse createDashboardSecureEmbed(String dashboardId,
                                                            SecureEmbedCreateRequest body)
                                                     throws ApiException

Create a secure embed for a dashboard.

See createDashboardSecureEmbedWithHttpInfo(java.lang.String, com.datadog.api.client.v2.model.SecureEmbedCreateRequest).

Parameters:

dashboardId - The ID of the dashboard. (required)

body - Secure embed creation request body. (required)

Returns:

SecureEmbedCreateResponse

Throws:

ApiException - if fails to make API call

createDashboardSecureEmbedAsync

public CompletableFuture<SecureEmbedCreateResponse> createDashboardSecureEmbedAsync(String dashboardId,
                                                                                    SecureEmbedCreateRequest body)

Create a secure embed for a dashboard.

See createDashboardSecureEmbedWithHttpInfoAsync(java.lang.String, com.datadog.api.client.v2.model.SecureEmbedCreateRequest).

Parameters:

dashboardId - The ID of the dashboard. (required)

body - Secure embed creation request body. (required)

Returns:

CompletableFuture<SecureEmbedCreateResponse>

createDashboardSecureEmbedWithHttpInfo

public ApiResponse<SecureEmbedCreateResponse> createDashboardSecureEmbedWithHttpInfo(String dashboardId,
                                                                                     SecureEmbedCreateRequest body)
                                                                              throws ApiException

Create a secure embed share for a dashboard. The response includes a one-time credential used for HMAC-SHA256 signing. Store it securely — it cannot be retrieved again.

Parameters:

dashboardId - The ID of the dashboard. (required)

body - Secure embed creation request body. (required)

Returns:

ApiResponse<SecureEmbedCreateResponse>

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	-
409	Conflict — max 1000 share URLs per dashboard exceeded	-
429	Too many requests	-

createDashboardSecureEmbedWithHttpInfoAsync

public CompletableFuture<ApiResponse<SecureEmbedCreateResponse>> createDashboardSecureEmbedWithHttpInfoAsync(String dashboardId,
                                                                                                             SecureEmbedCreateRequest body)

Create a secure embed for a dashboard.

See createDashboardSecureEmbedWithHttpInfo(java.lang.String, com.datadog.api.client.v2.model.SecureEmbedCreateRequest).

Parameters:

dashboardId - The ID of the dashboard. (required)

body - Secure embed creation request body. (required)

Returns:

CompletableFuture<ApiResponse<SecureEmbedCreateResponse>>

deleteDashboardSecureEmbed

public void deleteDashboardSecureEmbed(String dashboardId,
                                       String token)
                                throws ApiException

Delete a secure embed for a dashboard.

See deleteDashboardSecureEmbedWithHttpInfo(java.lang.String, java.lang.String).

Parameters:

dashboardId - The ID of the dashboard. (required)

token - The share token identifying the secure embed. (required)

Throws:

ApiException - if fails to make API call

deleteDashboardSecureEmbedAsync

public CompletableFuture<Void> deleteDashboardSecureEmbedAsync(String dashboardId,
                                                               String token)

Delete a secure embed for a dashboard.

See deleteDashboardSecureEmbedWithHttpInfoAsync(java.lang.String, java.lang.String).

Parameters:

dashboardId - The ID of the dashboard. (required)

token - The share token identifying the secure embed. (required)

Returns:

CompletableFuture

deleteDashboardSecureEmbedWithHttpInfo

public ApiResponse<Void> deleteDashboardSecureEmbedWithHttpInfo(String dashboardId,
                                                                String token)
                                                         throws ApiException

Delete a secure embed share for a dashboard.

Parameters:

dashboardId - The ID of the dashboard. (required)

token - The share token identifying the secure embed. (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	-
403	Forbidden	-
404	Not Found	-
429	Too many requests	-

deleteDashboardSecureEmbedWithHttpInfoAsync

public CompletableFuture<ApiResponse<Void>> deleteDashboardSecureEmbedWithHttpInfoAsync(String dashboardId,
                                                                                        String token)

Delete a secure embed for a dashboard.

See deleteDashboardSecureEmbedWithHttpInfo(java.lang.String, java.lang.String).

Parameters:

dashboardId - The ID of the dashboard. (required)

token - The share token identifying the secure embed. (required)

Returns:

CompletableFuture<ApiResponse<Void>>

getDashboardSecureEmbed

public SecureEmbedGetResponse getDashboardSecureEmbed(String dashboardId,
                                                      String token)
                                               throws ApiException

Get a secure embed for a dashboard.

See getDashboardSecureEmbedWithHttpInfo(java.lang.String, java.lang.String).

Parameters:

dashboardId - The ID of the dashboard. (required)

token - The share token identifying the secure embed. (required)

Returns:

SecureEmbedGetResponse

Throws:

ApiException - if fails to make API call

getDashboardSecureEmbedAsync

public CompletableFuture<SecureEmbedGetResponse> getDashboardSecureEmbedAsync(String dashboardId,
                                                                              String token)

Get a secure embed for a dashboard.

See getDashboardSecureEmbedWithHttpInfoAsync(java.lang.String, java.lang.String).

Parameters:

dashboardId - The ID of the dashboard. (required)

token - The share token identifying the secure embed. (required)

Returns:

CompletableFuture<SecureEmbedGetResponse>

getDashboardSecureEmbedWithHttpInfo

public ApiResponse<SecureEmbedGetResponse> getDashboardSecureEmbedWithHttpInfo(String dashboardId,
                                                                               String token)
                                                                        throws ApiException

Retrieve an existing secure embed configuration for a dashboard.

Parameters:

dashboardId - The ID of the dashboard. (required)

token - The share token identifying the secure embed. (required)

Returns:

ApiResponse<SecureEmbedGetResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

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

getDashboardSecureEmbedWithHttpInfoAsync

public CompletableFuture<ApiResponse<SecureEmbedGetResponse>> getDashboardSecureEmbedWithHttpInfoAsync(String dashboardId,
                                                                                                       String token)

Get a secure embed for a dashboard.

See getDashboardSecureEmbedWithHttpInfo(java.lang.String, java.lang.String).

Parameters:

dashboardId - The ID of the dashboard. (required)

token - The share token identifying the secure embed. (required)

Returns:

CompletableFuture<ApiResponse<SecureEmbedGetResponse>>

updateDashboardSecureEmbed

public SecureEmbedUpdateResponse updateDashboardSecureEmbed(String dashboardId,
                                                            String token,
                                                            SecureEmbedUpdateRequest body)
                                                     throws ApiException

Update a secure embed for a dashboard.

See updateDashboardSecureEmbedWithHttpInfo(java.lang.String, java.lang.String, com.datadog.api.client.v2.model.SecureEmbedUpdateRequest).

Parameters:

dashboardId - The ID of the dashboard. (required)

token - The share token identifying the secure embed. (required)

body - Secure embed update request body. (required)

Returns:

SecureEmbedUpdateResponse

Throws:

ApiException - if fails to make API call

updateDashboardSecureEmbedAsync

public CompletableFuture<SecureEmbedUpdateResponse> updateDashboardSecureEmbedAsync(String dashboardId,
                                                                                    String token,
                                                                                    SecureEmbedUpdateRequest body)

Update a secure embed for a dashboard.

See updateDashboardSecureEmbedWithHttpInfoAsync(java.lang.String, java.lang.String, com.datadog.api.client.v2.model.SecureEmbedUpdateRequest).

Parameters:

dashboardId - The ID of the dashboard. (required)

token - The share token identifying the secure embed. (required)

body - Secure embed update request body. (required)

Returns:

CompletableFuture<SecureEmbedUpdateResponse>

updateDashboardSecureEmbedWithHttpInfo

public ApiResponse<SecureEmbedUpdateResponse> updateDashboardSecureEmbedWithHttpInfo(String dashboardId,
                                                                                     String token,
                                                                                     SecureEmbedUpdateRequest body)
                                                                              throws ApiException

Partially update a secure embed configuration. All fields are optional (PATCH semantics).

Parameters:

dashboardId - The ID of the dashboard. (required)

token - The share token identifying the secure embed. (required)

body - Secure embed update request body. (required)

Returns:

ApiResponse<SecureEmbedUpdateResponse>

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	-

updateDashboardSecureEmbedWithHttpInfoAsync

public CompletableFuture<ApiResponse<SecureEmbedUpdateResponse>> updateDashboardSecureEmbedWithHttpInfoAsync(String dashboardId,
                                                                                                             String token,
                                                                                                             SecureEmbedUpdateRequest body)

Update a secure embed for a dashboard.

See updateDashboardSecureEmbedWithHttpInfo(java.lang.String, java.lang.String, com.datadog.api.client.v2.model.SecureEmbedUpdateRequest).

Parameters:

dashboardId - The ID of the dashboard. (required)

token - The share token identifying the secure embed. (required)

body - Secure embed update request body. (required)

Returns:

CompletableFuture<ApiResponse<SecureEmbedUpdateResponse>>