com.datadog.api.client.v2.api

Class WidgetsApi

java.lang.Object

com.datadog.api.client.v2.api.WidgetsApi

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WidgetsApi.SearchWidgetsOptionalParameters Manage optional parameters to searchWidgets.

Constructor Summary

Constructors

Constructor and Description
WidgetsApi()
WidgetsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
WidgetResponse	createWidget(WidgetExperienceType experienceType, CreateOrUpdateWidgetRequest body) Create a widget.
CompletableFuture<WidgetResponse>	createWidgetAsync(WidgetExperienceType experienceType, CreateOrUpdateWidgetRequest body) Create a widget.
ApiResponse<WidgetResponse>	createWidgetWithHttpInfo(WidgetExperienceType experienceType, CreateOrUpdateWidgetRequest body) Create a new widget for a given experience type.
CompletableFuture<ApiResponse<WidgetResponse>>	createWidgetWithHttpInfoAsync(WidgetExperienceType experienceType, CreateOrUpdateWidgetRequest body) Create a widget.
void	deleteWidget(WidgetExperienceType experienceType, UUID uuid) Delete a widget.
CompletableFuture<Void>	deleteWidgetAsync(WidgetExperienceType experienceType, UUID uuid) Delete a widget.
ApiResponse<Void>	deleteWidgetWithHttpInfo(WidgetExperienceType experienceType, UUID uuid) Soft-delete a widget by its UUID for a given experience type.
CompletableFuture<ApiResponse<Void>>	deleteWidgetWithHttpInfoAsync(WidgetExperienceType experienceType, UUID uuid) Delete a widget.
ApiClient	getApiClient() Get the API client.
WidgetResponse	getWidget(WidgetExperienceType experienceType, UUID uuid) Get a widget.
CompletableFuture<WidgetResponse>	getWidgetAsync(WidgetExperienceType experienceType, UUID uuid) Get a widget.
ApiResponse<WidgetResponse>	getWidgetWithHttpInfo(WidgetExperienceType experienceType, UUID uuid) Retrieve a widget by its UUID for a given experience type.
CompletableFuture<ApiResponse<WidgetResponse>>	getWidgetWithHttpInfoAsync(WidgetExperienceType experienceType, UUID uuid) Get a widget.
WidgetListResponse	searchWidgets(WidgetExperienceType experienceType) Search widgets.
WidgetListResponse	searchWidgets(WidgetExperienceType experienceType, WidgetsApi.SearchWidgetsOptionalParameters parameters) Search widgets.
CompletableFuture<WidgetListResponse>	searchWidgetsAsync(WidgetExperienceType experienceType) Search widgets.
CompletableFuture<WidgetListResponse>	searchWidgetsAsync(WidgetExperienceType experienceType, WidgetsApi.SearchWidgetsOptionalParameters parameters) Search widgets.
ApiResponse<WidgetListResponse>	searchWidgetsWithHttpInfo(WidgetExperienceType experienceType, WidgetsApi.SearchWidgetsOptionalParameters parameters) Search and list widgets for a given experience type, with filtering, sorting, and pagination.
CompletableFuture<ApiResponse<WidgetListResponse>>	searchWidgetsWithHttpInfoAsync(WidgetExperienceType experienceType, WidgetsApi.SearchWidgetsOptionalParameters parameters) Search widgets.
void	setApiClient(ApiClient apiClient) Set the API client.
WidgetResponse	updateWidget(WidgetExperienceType experienceType, UUID uuid, CreateOrUpdateWidgetRequest body) Update a widget.
CompletableFuture<WidgetResponse>	updateWidgetAsync(WidgetExperienceType experienceType, UUID uuid, CreateOrUpdateWidgetRequest body) Update a widget.
ApiResponse<WidgetResponse>	updateWidgetWithHttpInfo(WidgetExperienceType experienceType, UUID uuid, CreateOrUpdateWidgetRequest body) Update a widget by its UUID for a given experience type.
CompletableFuture<ApiResponse<WidgetResponse>>	updateWidgetWithHttpInfoAsync(WidgetExperienceType experienceType, UUID uuid, CreateOrUpdateWidgetRequest body) Update a widget.

Methods inherited from class java.lang.Object

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

Constructor Detail

WidgetsApi

public WidgetsApi()

WidgetsApi

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

createWidget

public WidgetResponse createWidget(WidgetExperienceType experienceType,
                                   CreateOrUpdateWidgetRequest body)
                            throws ApiException

Create a widget.

See createWidgetWithHttpInfo(com.datadog.api.client.v2.model.WidgetExperienceType, com.datadog.api.client.v2.model.CreateOrUpdateWidgetRequest).

Parameters:

experienceType - The experience type for the widget. (required)

body - Widget request body. The definition object's required fields vary by widget.definition.type: every type requires requests, and some types require additional fields (e.g. cloud_cost_summary requires graph_options, geomap requires style and view ). The example below shows a complete cloud_cost_summary payload for the ccm_reports experience type. (required)

Returns:

WidgetResponse

Throws:

ApiException - if fails to make API call

createWidgetAsync

public CompletableFuture<WidgetResponse> createWidgetAsync(WidgetExperienceType experienceType,
                                                           CreateOrUpdateWidgetRequest body)

Create a widget.

See createWidgetWithHttpInfoAsync(com.datadog.api.client.v2.model.WidgetExperienceType, com.datadog.api.client.v2.model.CreateOrUpdateWidgetRequest).

Parameters:

experienceType - The experience type for the widget. (required)

body - Widget request body. The definition object's required fields vary by widget.definition.type: every type requires requests, and some types require additional fields (e.g. cloud_cost_summary requires graph_options, geomap requires style and view ). The example below shows a complete cloud_cost_summary payload for the ccm_reports experience type. (required)

Returns:

CompletableFuture<WidgetResponse>

createWidgetWithHttpInfo

public ApiResponse<WidgetResponse> createWidgetWithHttpInfo(WidgetExperienceType experienceType,
                                                            CreateOrUpdateWidgetRequest body)
                                                     throws ApiException

Create a new widget for a given experience type.

Parameters:

experienceType - The experience type for the widget. (required)

body - Widget request body. The definition object's required fields vary by widget.definition.type: every type requires requests, and some types require additional fields (e.g. cloud_cost_summary requires graph_options, geomap requires style and view ). The example below shows a complete cloud_cost_summary payload for the ccm_reports experience type. (required)

Returns:

ApiResponse<WidgetResponse>

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	-

createWidgetWithHttpInfoAsync

public CompletableFuture<ApiResponse<WidgetResponse>> createWidgetWithHttpInfoAsync(WidgetExperienceType experienceType,
                                                                                    CreateOrUpdateWidgetRequest body)

Create a widget.

See createWidgetWithHttpInfo(com.datadog.api.client.v2.model.WidgetExperienceType, com.datadog.api.client.v2.model.CreateOrUpdateWidgetRequest).

Parameters:

experienceType - The experience type for the widget. (required)

body - Widget request body. The definition object's required fields vary by widget.definition.type: every type requires requests, and some types require additional fields (e.g. cloud_cost_summary requires graph_options, geomap requires style and view ). The example below shows a complete cloud_cost_summary payload for the ccm_reports experience type. (required)

Returns:

CompletableFuture<ApiResponse<WidgetResponse>>

deleteWidget

public void deleteWidget(WidgetExperienceType experienceType,
                         UUID uuid)
                  throws ApiException

Delete a widget.

See deleteWidgetWithHttpInfo(com.datadog.api.client.v2.model.WidgetExperienceType, java.util.UUID).

Parameters:

experienceType - The experience type for the widget. (required)

uuid - The UUID of the widget. (required)

Throws:

ApiException - if fails to make API call

deleteWidgetAsync

public CompletableFuture<Void> deleteWidgetAsync(WidgetExperienceType experienceType,
                                                 UUID uuid)

Delete a widget.

See deleteWidgetWithHttpInfoAsync(com.datadog.api.client.v2.model.WidgetExperienceType, java.util.UUID).

Parameters:

experienceType - The experience type for the widget. (required)

uuid - The UUID of the widget. (required)

Returns:

CompletableFuture

deleteWidgetWithHttpInfo

public ApiResponse<Void> deleteWidgetWithHttpInfo(WidgetExperienceType experienceType,
                                                  UUID uuid)
                                           throws ApiException

Soft-delete a widget by its UUID for a given experience type.

Parameters:

experienceType - The experience type for the widget. (required)

uuid - The UUID of the widget. (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	Not Found	-
429	Too many requests	-

deleteWidgetWithHttpInfoAsync

public CompletableFuture<ApiResponse<Void>> deleteWidgetWithHttpInfoAsync(WidgetExperienceType experienceType,
                                                                          UUID uuid)

Delete a widget.

See deleteWidgetWithHttpInfo(com.datadog.api.client.v2.model.WidgetExperienceType, java.util.UUID).

Parameters:

experienceType - The experience type for the widget. (required)

uuid - The UUID of the widget. (required)

Returns:

CompletableFuture<ApiResponse<Void>>

getWidget

public WidgetResponse getWidget(WidgetExperienceType experienceType,
                                UUID uuid)
                         throws ApiException

Get a widget.

See getWidgetWithHttpInfo(com.datadog.api.client.v2.model.WidgetExperienceType, java.util.UUID).

Parameters:

experienceType - The experience type for the widget. (required)

uuid - The UUID of the widget. (required)

Returns:

WidgetResponse

Throws:

ApiException - if fails to make API call

getWidgetAsync

public CompletableFuture<WidgetResponse> getWidgetAsync(WidgetExperienceType experienceType,
                                                        UUID uuid)

Get a widget.

See getWidgetWithHttpInfoAsync(com.datadog.api.client.v2.model.WidgetExperienceType, java.util.UUID).

Parameters:

experienceType - The experience type for the widget. (required)

uuid - The UUID of the widget. (required)

Returns:

CompletableFuture<WidgetResponse>

getWidgetWithHttpInfo

public ApiResponse<WidgetResponse> getWidgetWithHttpInfo(WidgetExperienceType experienceType,
                                                         UUID uuid)
                                                  throws ApiException

Retrieve a widget by its UUID for a given experience type.

Parameters:

experienceType - The experience type for the widget. (required)

uuid - The UUID of the widget. (required)

Returns:

ApiResponse<WidgetResponse>

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	-

getWidgetWithHttpInfoAsync

public CompletableFuture<ApiResponse<WidgetResponse>> getWidgetWithHttpInfoAsync(WidgetExperienceType experienceType,
                                                                                 UUID uuid)

Get a widget.

See getWidgetWithHttpInfo(com.datadog.api.client.v2.model.WidgetExperienceType, java.util.UUID).

Parameters:

experienceType - The experience type for the widget. (required)

uuid - The UUID of the widget. (required)

Returns:

CompletableFuture<ApiResponse<WidgetResponse>>

searchWidgets

public WidgetListResponse searchWidgets(WidgetExperienceType experienceType)
                                 throws ApiException

Search widgets.

See searchWidgetsWithHttpInfo(com.datadog.api.client.v2.model.WidgetExperienceType, com.datadog.api.client.v2.api.WidgetsApi.SearchWidgetsOptionalParameters).

Parameters:

experienceType - The experience type for the widget. (required)

Returns:

WidgetListResponse

Throws:

ApiException - if fails to make API call

searchWidgetsAsync

public CompletableFuture<WidgetListResponse> searchWidgetsAsync(WidgetExperienceType experienceType)

Search widgets.

See searchWidgetsWithHttpInfoAsync(com.datadog.api.client.v2.model.WidgetExperienceType, com.datadog.api.client.v2.api.WidgetsApi.SearchWidgetsOptionalParameters).

Parameters:

experienceType - The experience type for the widget. (required)

Returns:

CompletableFuture<WidgetListResponse>

searchWidgets

public WidgetListResponse searchWidgets(WidgetExperienceType experienceType,
                                        WidgetsApi.SearchWidgetsOptionalParameters parameters)
                                 throws ApiException

Search widgets.

See searchWidgetsWithHttpInfo(com.datadog.api.client.v2.model.WidgetExperienceType, com.datadog.api.client.v2.api.WidgetsApi.SearchWidgetsOptionalParameters).

Parameters:

experienceType - The experience type for the widget. (required)

parameters - Optional parameters for the request.

Returns:

WidgetListResponse

Throws:

ApiException - if fails to make API call

searchWidgetsAsync

public CompletableFuture<WidgetListResponse> searchWidgetsAsync(WidgetExperienceType experienceType,
                                                                WidgetsApi.SearchWidgetsOptionalParameters parameters)

Search widgets.

See searchWidgetsWithHttpInfoAsync(com.datadog.api.client.v2.model.WidgetExperienceType, com.datadog.api.client.v2.api.WidgetsApi.SearchWidgetsOptionalParameters).

Parameters:

experienceType - The experience type for the widget. (required)

parameters - Optional parameters for the request.

Returns:

CompletableFuture<WidgetListResponse>

searchWidgetsWithHttpInfo

public ApiResponse<WidgetListResponse> searchWidgetsWithHttpInfo(WidgetExperienceType experienceType,
                                                                 WidgetsApi.SearchWidgetsOptionalParameters parameters)
                                                          throws ApiException

Search and list widgets for a given experience type, with filtering, sorting, and pagination.

Response meta carries totals scoped to the current filter: - filtered_total — widgets matching the filter. - created_by_you_total — among the matches, how many the current user created. - favorited_by_you_total — among the matches, how many the current user has favorited. - created_by_anyone_total — total widgets in the experience type, ignoring filters.

Each returned widget includes is_favorited reflecting the current user's favorite status. Favoriting itself is performed through the shared favorites API, not this endpoint.

Parameters:

experienceType - The experience type for the widget. (required)

parameters - Optional parameters for the request.

Returns:

ApiResponse<WidgetListResponse>

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	-

searchWidgetsWithHttpInfoAsync

public CompletableFuture<ApiResponse<WidgetListResponse>> searchWidgetsWithHttpInfoAsync(WidgetExperienceType experienceType,
                                                                                         WidgetsApi.SearchWidgetsOptionalParameters parameters)

Search widgets.

See searchWidgetsWithHttpInfo(com.datadog.api.client.v2.model.WidgetExperienceType, com.datadog.api.client.v2.api.WidgetsApi.SearchWidgetsOptionalParameters).

Parameters:

experienceType - The experience type for the widget. (required)

parameters - Optional parameters for the request.

Returns:

CompletableFuture<ApiResponse<WidgetListResponse>>

updateWidget

public WidgetResponse updateWidget(WidgetExperienceType experienceType,
                                   UUID uuid,
                                   CreateOrUpdateWidgetRequest body)
                            throws ApiException

Update a widget.

See updateWidgetWithHttpInfo(com.datadog.api.client.v2.model.WidgetExperienceType, java.util.UUID, com.datadog.api.client.v2.model.CreateOrUpdateWidgetRequest).

Parameters:

experienceType - The experience type for the widget. (required)

uuid - The UUID of the widget. (required)

body - Widget request body. The definition object's required fields vary by widget.definition.type; see CreateWidget above for a complete worked payload. Update is a full replacement of the widget definition. (required)

Returns:

WidgetResponse

Throws:

ApiException - if fails to make API call

updateWidgetAsync

public CompletableFuture<WidgetResponse> updateWidgetAsync(WidgetExperienceType experienceType,
                                                           UUID uuid,
                                                           CreateOrUpdateWidgetRequest body)

Update a widget.

See updateWidgetWithHttpInfoAsync(com.datadog.api.client.v2.model.WidgetExperienceType, java.util.UUID, com.datadog.api.client.v2.model.CreateOrUpdateWidgetRequest).

Parameters:

experienceType - The experience type for the widget. (required)

uuid - The UUID of the widget. (required)

body - Widget request body. The definition object's required fields vary by widget.definition.type; see CreateWidget above for a complete worked payload. Update is a full replacement of the widget definition. (required)

Returns:

CompletableFuture<WidgetResponse>

updateWidgetWithHttpInfo

public ApiResponse<WidgetResponse> updateWidgetWithHttpInfo(WidgetExperienceType experienceType,
                                                            UUID uuid,
                                                            CreateOrUpdateWidgetRequest body)
                                                     throws ApiException

Update a widget by its UUID for a given experience type. This performs a full replacement of the widget definition.

Parameters:

experienceType - The experience type for the widget. (required)

uuid - The UUID of the widget. (required)

body - Widget request body. The definition object's required fields vary by widget.definition.type; see CreateWidget above for a complete worked payload. Update is a full replacement of the widget definition. (required)

Returns:

ApiResponse<WidgetResponse>

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	-

updateWidgetWithHttpInfoAsync

public CompletableFuture<ApiResponse<WidgetResponse>> updateWidgetWithHttpInfoAsync(WidgetExperienceType experienceType,
                                                                                    UUID uuid,
                                                                                    CreateOrUpdateWidgetRequest body)

Update a widget.

See updateWidgetWithHttpInfo(com.datadog.api.client.v2.model.WidgetExperienceType, java.util.UUID, com.datadog.api.client.v2.model.CreateOrUpdateWidgetRequest).

Parameters:

experienceType - The experience type for the widget. (required)

uuid - The UUID of the widget. (required)

body - Widget request body. The definition object's required fields vary by widget.definition.type; see CreateWidget above for a complete worked payload. Update is a full replacement of the widget definition. (required)

Returns:

CompletableFuture<ApiResponse<WidgetResponse>>