com.datadog.api.client.v2.api

Class AppBuilderApi

java.lang.Object

com.datadog.api.client.v2.api.AppBuilderApi

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AppBuilderApi.GetAppOptionalParameters Manage optional parameters to getApp.
static class	AppBuilderApi.ListAppsOptionalParameters Manage optional parameters to listApps.

Constructor Summary

Constructors

Constructor and Description
AppBuilderApi()
AppBuilderApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
CreateAppResponse	createApp(CreateAppRequest body) Create App.
CompletableFuture<CreateAppResponse>	createAppAsync(CreateAppRequest body) Create App.
ApiResponse<CreateAppResponse>	createAppWithHttpInfo(CreateAppRequest body) Create a new app, returning the app ID.
CompletableFuture<ApiResponse<CreateAppResponse>>	createAppWithHttpInfoAsync(CreateAppRequest body) Create App.
DeleteAppResponse	deleteApp(UUID appId) Delete App.
CompletableFuture<DeleteAppResponse>	deleteAppAsync(UUID appId) Delete App.
DeleteAppsResponse	deleteApps(DeleteAppsRequest body) Delete Multiple Apps.
CompletableFuture<DeleteAppsResponse>	deleteAppsAsync(DeleteAppsRequest body) Delete Multiple Apps.
ApiResponse<DeleteAppsResponse>	deleteAppsWithHttpInfo(DeleteAppsRequest body) Delete multiple apps in a single request from a list of app IDs.
CompletableFuture<ApiResponse<DeleteAppsResponse>>	deleteAppsWithHttpInfoAsync(DeleteAppsRequest body) Delete Multiple Apps.
ApiResponse<DeleteAppResponse>	deleteAppWithHttpInfo(UUID appId) Delete a single app.
CompletableFuture<ApiResponse<DeleteAppResponse>>	deleteAppWithHttpInfoAsync(UUID appId) Delete App.
ApiClient	getApiClient() Get the API client.
GetAppResponse	getApp(UUID appId) Get App.
GetAppResponse	getApp(UUID appId, AppBuilderApi.GetAppOptionalParameters parameters) Get App.
CompletableFuture<GetAppResponse>	getAppAsync(UUID appId) Get App.
CompletableFuture<GetAppResponse>	getAppAsync(UUID appId, AppBuilderApi.GetAppOptionalParameters parameters) Get App.
ApiResponse<GetAppResponse>	getAppWithHttpInfo(UUID appId, AppBuilderApi.GetAppOptionalParameters parameters) Get the full definition of an app.
CompletableFuture<ApiResponse<GetAppResponse>>	getAppWithHttpInfoAsync(UUID appId, AppBuilderApi.GetAppOptionalParameters parameters) Get App.
ListAppsResponse	listApps() List Apps.
ListAppsResponse	listApps(AppBuilderApi.ListAppsOptionalParameters parameters) List Apps.
CompletableFuture<ListAppsResponse>	listAppsAsync() List Apps.
CompletableFuture<ListAppsResponse>	listAppsAsync(AppBuilderApi.ListAppsOptionalParameters parameters) List Apps.
ApiResponse<ListAppsResponse>	listAppsWithHttpInfo(AppBuilderApi.ListAppsOptionalParameters parameters) List all apps, with optional filters and sorting.
CompletableFuture<ApiResponse<ListAppsResponse>>	listAppsWithHttpInfoAsync(AppBuilderApi.ListAppsOptionalParameters parameters) List Apps.
PublishAppResponse	publishApp(UUID appId) Publish App.
CompletableFuture<PublishAppResponse>	publishAppAsync(UUID appId) Publish App.
ApiResponse<PublishAppResponse>	publishAppWithHttpInfo(UUID appId) Publish an app for use by other users.
CompletableFuture<ApiResponse<PublishAppResponse>>	publishAppWithHttpInfoAsync(UUID appId) Publish App.
void	setApiClient(ApiClient apiClient) Set the API client.
UnpublishAppResponse	unpublishApp(UUID appId) Unpublish App.
CompletableFuture<UnpublishAppResponse>	unpublishAppAsync(UUID appId) Unpublish App.
ApiResponse<UnpublishAppResponse>	unpublishAppWithHttpInfo(UUID appId) Unpublish an app, removing the live version of the app.
CompletableFuture<ApiResponse<UnpublishAppResponse>>	unpublishAppWithHttpInfoAsync(UUID appId) Unpublish App.
UpdateAppResponse	updateApp(UUID appId, UpdateAppRequest body) Update App.
CompletableFuture<UpdateAppResponse>	updateAppAsync(UUID appId, UpdateAppRequest body) Update App.
ApiResponse<UpdateAppResponse>	updateAppWithHttpInfo(UUID appId, UpdateAppRequest body) Update an existing app.
CompletableFuture<ApiResponse<UpdateAppResponse>>	updateAppWithHttpInfoAsync(UUID appId, UpdateAppRequest body) Update App.

Methods inherited from class java.lang.Object

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

Constructor Detail

AppBuilderApi

public AppBuilderApi()

AppBuilderApi

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

createApp

public CreateAppResponse createApp(CreateAppRequest body)
                            throws ApiException

Create App.

See createAppWithHttpInfo(com.datadog.api.client.v2.model.CreateAppRequest).

Parameters:

body - (required)

Returns:

CreateAppResponse

Throws:

ApiException - if fails to make API call

createAppAsync

public CompletableFuture<CreateAppResponse> createAppAsync(CreateAppRequest body)

Create App.

See createAppWithHttpInfoAsync(com.datadog.api.client.v2.model.CreateAppRequest).

Parameters:

body - (required)

Returns:

CompletableFuture<CreateAppResponse>

createAppWithHttpInfo

public ApiResponse<CreateAppResponse> createAppWithHttpInfo(CreateAppRequest body)
                                                     throws ApiException

Create a new app, returning the app ID. This API requires a registered application key. Alternatively, you can configure these permissions in the UI.

Parameters:

body - (required)

Returns:

ApiResponse<CreateAppResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
201	Created	-
400	Bad Request	-
403	Forbidden	-
429	Too many requests	-

createAppWithHttpInfoAsync

public CompletableFuture<ApiResponse<CreateAppResponse>> createAppWithHttpInfoAsync(CreateAppRequest body)

Create App.

See createAppWithHttpInfo(com.datadog.api.client.v2.model.CreateAppRequest).

Parameters:

body - (required)

Returns:

CompletableFuture<ApiResponse<CreateAppResponse>>

deleteApp

public DeleteAppResponse deleteApp(UUID appId)
                            throws ApiException

Delete App.

See deleteAppWithHttpInfo(java.util.UUID).

Parameters:

appId - The ID of the app to delete. (required)

Returns:

DeleteAppResponse

Throws:

ApiException - if fails to make API call

deleteAppAsync

public CompletableFuture<DeleteAppResponse> deleteAppAsync(UUID appId)

Delete App.

See deleteAppWithHttpInfoAsync(java.util.UUID).

Parameters:

appId - The ID of the app to delete. (required)

Returns:

CompletableFuture<DeleteAppResponse>

deleteAppWithHttpInfo

public ApiResponse<DeleteAppResponse> deleteAppWithHttpInfo(UUID appId)
                                                     throws ApiException

Delete a single app. This API requires a registered application key. Alternatively, you can configure these permissions in the UI.

Parameters:

appId - The ID of the app to delete. (required)

Returns:

ApiResponse<DeleteAppResponse>

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	-
410	Gone	-
429	Too many requests	-

deleteAppWithHttpInfoAsync

public CompletableFuture<ApiResponse<DeleteAppResponse>> deleteAppWithHttpInfoAsync(UUID appId)

Delete App.

See deleteAppWithHttpInfo(java.util.UUID).

Parameters:

appId - The ID of the app to delete. (required)

Returns:

CompletableFuture<ApiResponse<DeleteAppResponse>>

deleteApps

public DeleteAppsResponse deleteApps(DeleteAppsRequest body)
                              throws ApiException

Delete Multiple Apps.

See deleteAppsWithHttpInfo(com.datadog.api.client.v2.model.DeleteAppsRequest).

Parameters:

body - (required)

Returns:

DeleteAppsResponse

Throws:

ApiException - if fails to make API call

deleteAppsAsync

public CompletableFuture<DeleteAppsResponse> deleteAppsAsync(DeleteAppsRequest body)

Delete Multiple Apps.

See deleteAppsWithHttpInfoAsync(com.datadog.api.client.v2.model.DeleteAppsRequest).

Parameters:

body - (required)

Returns:

CompletableFuture<DeleteAppsResponse>

deleteAppsWithHttpInfo

public ApiResponse<DeleteAppsResponse> deleteAppsWithHttpInfo(DeleteAppsRequest body)
                                                       throws ApiException

Delete multiple apps in a single request from a list of app IDs. This API requires a registered application key. Alternatively, you can configure these permissions in the UI.

Parameters:

body - (required)

Returns:

ApiResponse<DeleteAppsResponse>

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	-

deleteAppsWithHttpInfoAsync

public CompletableFuture<ApiResponse<DeleteAppsResponse>> deleteAppsWithHttpInfoAsync(DeleteAppsRequest body)

Delete Multiple Apps.

See deleteAppsWithHttpInfo(com.datadog.api.client.v2.model.DeleteAppsRequest).

Parameters:

body - (required)

Returns:

CompletableFuture<ApiResponse<DeleteAppsResponse>>

getApp

public GetAppResponse getApp(UUID appId)
                      throws ApiException

Get App.

See getAppWithHttpInfo(java.util.UUID, com.datadog.api.client.v2.api.AppBuilderApi.GetAppOptionalParameters).

Parameters:

appId - The ID of the app to retrieve. (required)

Returns:

GetAppResponse

Throws:

ApiException - if fails to make API call

getAppAsync

public CompletableFuture<GetAppResponse> getAppAsync(UUID appId)

Get App.

See getAppWithHttpInfoAsync(java.util.UUID, com.datadog.api.client.v2.api.AppBuilderApi.GetAppOptionalParameters).

Parameters:

appId - The ID of the app to retrieve. (required)

Returns:

CompletableFuture<GetAppResponse>

getApp

public GetAppResponse getApp(UUID appId,
                             AppBuilderApi.GetAppOptionalParameters parameters)
                      throws ApiException

Get App.

See getAppWithHttpInfo(java.util.UUID, com.datadog.api.client.v2.api.AppBuilderApi.GetAppOptionalParameters).

Parameters:

appId - The ID of the app to retrieve. (required)

parameters - Optional parameters for the request.

Returns:

GetAppResponse

Throws:

ApiException - if fails to make API call

getAppAsync

public CompletableFuture<GetAppResponse> getAppAsync(UUID appId,
                                                     AppBuilderApi.GetAppOptionalParameters parameters)

Get App.

See getAppWithHttpInfoAsync(java.util.UUID, com.datadog.api.client.v2.api.AppBuilderApi.GetAppOptionalParameters).

Parameters:

appId - The ID of the app to retrieve. (required)

parameters - Optional parameters for the request.

Returns:

CompletableFuture<GetAppResponse>

getAppWithHttpInfo

public ApiResponse<GetAppResponse> getAppWithHttpInfo(UUID appId,
                                                      AppBuilderApi.GetAppOptionalParameters parameters)
                                               throws ApiException

Get the full definition of an app. This API requires a registered application key. Alternatively, you can configure these permissions in the UI.

Parameters:

appId - The ID of the app to retrieve. (required)

parameters - Optional parameters for the request.

Returns:

ApiResponse<GetAppResponse>

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	-
410	Gone	-
429	Too many requests	-

getAppWithHttpInfoAsync

public CompletableFuture<ApiResponse<GetAppResponse>> getAppWithHttpInfoAsync(UUID appId,
                                                                              AppBuilderApi.GetAppOptionalParameters parameters)

Get App.

See getAppWithHttpInfo(java.util.UUID, com.datadog.api.client.v2.api.AppBuilderApi.GetAppOptionalParameters).

Parameters:

appId - The ID of the app to retrieve. (required)

parameters - Optional parameters for the request.

Returns:

CompletableFuture<ApiResponse<GetAppResponse>>

listApps

public ListAppsResponse listApps()
                          throws ApiException

List Apps.

See listAppsWithHttpInfo(com.datadog.api.client.v2.api.AppBuilderApi.ListAppsOptionalParameters).

Returns:

ListAppsResponse

Throws:

ApiException - if fails to make API call

listAppsAsync

public CompletableFuture<ListAppsResponse> listAppsAsync()

List Apps.

See listAppsWithHttpInfoAsync(com.datadog.api.client.v2.api.AppBuilderApi.ListAppsOptionalParameters).

Returns:

CompletableFuture<ListAppsResponse>

listApps

public ListAppsResponse listApps(AppBuilderApi.ListAppsOptionalParameters parameters)
                          throws ApiException

List Apps.

See listAppsWithHttpInfo(com.datadog.api.client.v2.api.AppBuilderApi.ListAppsOptionalParameters).

Parameters:

parameters - Optional parameters for the request.

Returns:

ListAppsResponse

Throws:

ApiException - if fails to make API call

listAppsAsync

public CompletableFuture<ListAppsResponse> listAppsAsync(AppBuilderApi.ListAppsOptionalParameters parameters)

List Apps.

See listAppsWithHttpInfoAsync(com.datadog.api.client.v2.api.AppBuilderApi.ListAppsOptionalParameters).

Parameters:

parameters - Optional parameters for the request.

Returns:

CompletableFuture<ListAppsResponse>

listAppsWithHttpInfo

public ApiResponse<ListAppsResponse> listAppsWithHttpInfo(AppBuilderApi.ListAppsOptionalParameters parameters)
                                                   throws ApiException

List all apps, with optional filters and sorting. This endpoint is paginated. Only basic app information such as the app ID, name, and description is returned by this endpoint. This API requires a registered application key. Alternatively, you can configure these permissions in the UI.

Parameters:

parameters - Optional parameters for the request.

Returns:

ApiResponse<ListAppsResponse>

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	-

listAppsWithHttpInfoAsync

public CompletableFuture<ApiResponse<ListAppsResponse>> listAppsWithHttpInfoAsync(AppBuilderApi.ListAppsOptionalParameters parameters)

List Apps.

See listAppsWithHttpInfo(com.datadog.api.client.v2.api.AppBuilderApi.ListAppsOptionalParameters).

Parameters:

parameters - Optional parameters for the request.

Returns:

CompletableFuture<ApiResponse<ListAppsResponse>>

publishApp

public PublishAppResponse publishApp(UUID appId)
                              throws ApiException

Publish App.

See publishAppWithHttpInfo(java.util.UUID).

Parameters:

appId - The ID of the app to publish. (required)

Returns:

PublishAppResponse

Throws:

ApiException - if fails to make API call

publishAppAsync

public CompletableFuture<PublishAppResponse> publishAppAsync(UUID appId)

Publish App.

See publishAppWithHttpInfoAsync(java.util.UUID).

Parameters:

appId - The ID of the app to publish. (required)

Returns:

CompletableFuture<PublishAppResponse>

publishAppWithHttpInfo

public ApiResponse<PublishAppResponse> publishAppWithHttpInfo(UUID appId)
                                                       throws ApiException

Publish an app for use by other users. To ensure the app is accessible to the correct users, you also need to set a Restriction Policy on the app if a policy does not yet exist. This API requires a registered application key. Alternatively, you can configure these permissions in the UI.

Parameters:

appId - The ID of the app to publish. (required)

Returns:

ApiResponse<PublishAppResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

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

publishAppWithHttpInfoAsync

public CompletableFuture<ApiResponse<PublishAppResponse>> publishAppWithHttpInfoAsync(UUID appId)

Publish App.

See publishAppWithHttpInfo(java.util.UUID).

Parameters:

appId - The ID of the app to publish. (required)

Returns:

CompletableFuture<ApiResponse<PublishAppResponse>>

unpublishApp

public UnpublishAppResponse unpublishApp(UUID appId)
                                  throws ApiException

Unpublish App.

See unpublishAppWithHttpInfo(java.util.UUID).

Parameters:

appId - The ID of the app to unpublish. (required)

Returns:

UnpublishAppResponse

Throws:

ApiException - if fails to make API call

unpublishAppAsync

public CompletableFuture<UnpublishAppResponse> unpublishAppAsync(UUID appId)

Unpublish App.

See unpublishAppWithHttpInfoAsync(java.util.UUID).

Parameters:

appId - The ID of the app to unpublish. (required)

Returns:

CompletableFuture<UnpublishAppResponse>

unpublishAppWithHttpInfo

public ApiResponse<UnpublishAppResponse> unpublishAppWithHttpInfo(UUID appId)
                                                           throws ApiException

Unpublish an app, removing the live version of the app. Unpublishing creates a new instance of a deployment object on the app, with a nil app_version_id ( 00000000-0000-0000-0000-000000000000). The app can still be updated and published again in the future. This API requires a registered application key. Alternatively, you can configure these permissions in the UI.

Parameters:

appId - The ID of the app to unpublish. (required)

Returns:

ApiResponse<UnpublishAppResponse>

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	-

unpublishAppWithHttpInfoAsync

public CompletableFuture<ApiResponse<UnpublishAppResponse>> unpublishAppWithHttpInfoAsync(UUID appId)

Unpublish App.

See unpublishAppWithHttpInfo(java.util.UUID).

Parameters:

appId - The ID of the app to unpublish. (required)

Returns:

CompletableFuture<ApiResponse<UnpublishAppResponse>>

updateApp

public UpdateAppResponse updateApp(UUID appId,
                                   UpdateAppRequest body)
                            throws ApiException

Update App.

See updateAppWithHttpInfo(java.util.UUID, com.datadog.api.client.v2.model.UpdateAppRequest).

Parameters:

appId - The ID of the app to update. (required)

body - (required)

Returns:

UpdateAppResponse

Throws:

ApiException - if fails to make API call

updateAppAsync

public CompletableFuture<UpdateAppResponse> updateAppAsync(UUID appId,
                                                           UpdateAppRequest body)

Update App.

See updateAppWithHttpInfoAsync(java.util.UUID, com.datadog.api.client.v2.model.UpdateAppRequest).

Parameters:

appId - The ID of the app to update. (required)

body - (required)

Returns:

CompletableFuture<UpdateAppResponse>

updateAppWithHttpInfo

public ApiResponse<UpdateAppResponse> updateAppWithHttpInfo(UUID appId,
                                                            UpdateAppRequest body)
                                                     throws ApiException

Update an existing app. This creates a new version of the app. This API requires a registered application key. Alternatively, you can configure these permissions in the UI.

Parameters:

appId - The ID of the app to update. (required)

body - (required)

Returns:

ApiResponse<UpdateAppResponse>

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	-

updateAppWithHttpInfoAsync

public CompletableFuture<ApiResponse<UpdateAppResponse>> updateAppWithHttpInfoAsync(UUID appId,
                                                                                    UpdateAppRequest body)

Update App.

See updateAppWithHttpInfo(java.util.UUID, com.datadog.api.client.v2.model.UpdateAppRequest).

Parameters:

appId - The ID of the app to update. (required)

body - (required)

Returns:

CompletableFuture<ApiResponse<UpdateAppResponse>>