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

Class ApiManagementApi

java.lang.Object

com.datadog.api.client.v2.api.ApiManagementApi

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ApiManagementApi.CreateOpenAPIOptionalParameters	Manage optional parameters to createOpenAPI.
static class	ApiManagementApi.ListAPIsOptionalParameters	Manage optional parameters to listAPIs.
static class	ApiManagementApi.UpdateOpenAPIOptionalParameters	Manage optional parameters to updateOpenAPI.

Constructor Summary

Constructors

Constructor	Description
ApiManagementApi()
ApiManagementApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
CreateOpenAPIResponse	createOpenAPI()	Deprecated.
CreateOpenAPIResponse	createOpenAPI(ApiManagementApi.CreateOpenAPIOptionalParameters parameters)	Deprecated.
CompletableFuture<CreateOpenAPIResponse>	createOpenAPIAsync()	Deprecated.
CompletableFuture<CreateOpenAPIResponse>	createOpenAPIAsync(ApiManagementApi.CreateOpenAPIOptionalParameters parameters)	Deprecated.
ApiResponse<CreateOpenAPIResponse>	createOpenAPIWithHttpInfo(ApiManagementApi.CreateOpenAPIOptionalParameters parameters)	Deprecated.
CompletableFuture<ApiResponse<CreateOpenAPIResponse>>	createOpenAPIWithHttpInfoAsync(ApiManagementApi.CreateOpenAPIOptionalParameters parameters)	Deprecated.
void	deleteOpenAPI(UUID id)	Deprecated.
CompletableFuture<Void>	deleteOpenAPIAsync(UUID id)	Deprecated.
ApiResponse<Void>	deleteOpenAPIWithHttpInfo(UUID id)	Deprecated.
CompletableFuture<ApiResponse<Void>>	deleteOpenAPIWithHttpInfoAsync(UUID id)	Deprecated.
ApiClient	getApiClient()	Get the API client.
File	getOpenAPI(UUID id)	Deprecated.
CompletableFuture<File>	getOpenAPIAsync(UUID id)	Deprecated.
ApiResponse<File>	getOpenAPIWithHttpInfo(UUID id)	Deprecated.
CompletableFuture<ApiResponse<File>>	getOpenAPIWithHttpInfoAsync(UUID id)	Deprecated.
ListAPIsResponse	listAPIs()	Deprecated.
ListAPIsResponse	listAPIs(ApiManagementApi.ListAPIsOptionalParameters parameters)	Deprecated.
CompletableFuture<ListAPIsResponse>	listAPIsAsync()	Deprecated.
CompletableFuture<ListAPIsResponse>	listAPIsAsync(ApiManagementApi.ListAPIsOptionalParameters parameters)	Deprecated.
ApiResponse<ListAPIsResponse>	listAPIsWithHttpInfo(ApiManagementApi.ListAPIsOptionalParameters parameters)	Deprecated.
CompletableFuture<ApiResponse<ListAPIsResponse>>	listAPIsWithHttpInfoAsync(ApiManagementApi.ListAPIsOptionalParameters parameters)	Deprecated.
void	setApiClient(ApiClient apiClient)	Set the API client.
UpdateOpenAPIResponse	updateOpenAPI(UUID id)	Deprecated.
UpdateOpenAPIResponse	updateOpenAPI(UUID id, ApiManagementApi.UpdateOpenAPIOptionalParameters parameters)	Deprecated.
CompletableFuture<UpdateOpenAPIResponse>	updateOpenAPIAsync(UUID id)	Deprecated.
CompletableFuture<UpdateOpenAPIResponse>	updateOpenAPIAsync(UUID id, ApiManagementApi.UpdateOpenAPIOptionalParameters parameters)	Deprecated.
ApiResponse<UpdateOpenAPIResponse>	updateOpenAPIWithHttpInfo(UUID id, ApiManagementApi.UpdateOpenAPIOptionalParameters parameters)	Deprecated.
CompletableFuture<ApiResponse<UpdateOpenAPIResponse>>	updateOpenAPIWithHttpInfoAsync(UUID id, ApiManagementApi.UpdateOpenAPIOptionalParameters parameters)	Deprecated.

Methods inherited from class java.lang.Object

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

Constructor Details

ApiManagementApi

public ApiManagementApi()

ApiManagementApi

public ApiManagementApi(ApiClient apiClient)

Method Details

getApiClient

public ApiClient getApiClient()

Get the API client.

Returns:

API client

setApiClient

public void setApiClient(ApiClient apiClient)

Set the API client.

Parameters:

apiClient - an instance of API client

createOpenAPI

@Deprecated
public CreateOpenAPIResponse createOpenAPI()
                                    throws ApiException

Deprecated.

Create a new API.

See createOpenAPIWithHttpInfo(com.datadog.api.client.v2.api.ApiManagementApi.CreateOpenAPIOptionalParameters).

Returns:

CreateOpenAPIResponse

Throws:

ApiException - if fails to make API call

createOpenAPIAsync

@Deprecated
public CompletableFuture<CreateOpenAPIResponse> createOpenAPIAsync()

Deprecated.

Create a new API.

See createOpenAPIWithHttpInfoAsync(com.datadog.api.client.v2.api.ApiManagementApi.CreateOpenAPIOptionalParameters).

Returns:

CompletableFuture<CreateOpenAPIResponse>

createOpenAPI

@Deprecated
public CreateOpenAPIResponse createOpenAPI(ApiManagementApi.CreateOpenAPIOptionalParameters parameters)
                                    throws ApiException

Deprecated.

Create a new API.

See createOpenAPIWithHttpInfo(com.datadog.api.client.v2.api.ApiManagementApi.CreateOpenAPIOptionalParameters).

Parameters:

parameters - Optional parameters for the request.

Returns:

CreateOpenAPIResponse

Throws:

ApiException - if fails to make API call

createOpenAPIAsync

@Deprecated
public CompletableFuture<CreateOpenAPIResponse> createOpenAPIAsync(ApiManagementApi.CreateOpenAPIOptionalParameters parameters)

Deprecated.

Create a new API.

See createOpenAPIWithHttpInfoAsync(com.datadog.api.client.v2.api.ApiManagementApi.CreateOpenAPIOptionalParameters).

Parameters:

parameters - Optional parameters for the request.

Returns:

CompletableFuture<CreateOpenAPIResponse>

createOpenAPIWithHttpInfo

@Deprecated
public ApiResponse<CreateOpenAPIResponse> createOpenAPIWithHttpInfo(ApiManagementApi.CreateOpenAPIOptionalParameters parameters)
                                                             throws ApiException

Deprecated.

Create a new API from the OpenAPI specification given. See the API Catalog documentation for additional information about the possible metadata. It returns the created API ID.

Parameters:

parameters - Optional parameters for the request.

Returns:

ApiResponse<CreateOpenAPIResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
201	API created successfully	-
400	Bad request	-
403	Forbidden	-
429	Too many requests	-

createOpenAPIWithHttpInfoAsync

@Deprecated
public CompletableFuture<ApiResponse<CreateOpenAPIResponse>> createOpenAPIWithHttpInfoAsync(ApiManagementApi.CreateOpenAPIOptionalParameters parameters)

Deprecated.

Create a new API.

See createOpenAPIWithHttpInfo(com.datadog.api.client.v2.api.ApiManagementApi.CreateOpenAPIOptionalParameters).

Parameters:

parameters - Optional parameters for the request.

Returns:

CompletableFuture<ApiResponse<CreateOpenAPIResponse>>

deleteOpenAPI

@Deprecated
public void deleteOpenAPI(UUID id)
                   throws ApiException

Deprecated.

Delete an API.

See deleteOpenAPIWithHttpInfo(java.util.UUID).

Parameters:

id - ID of the API to delete (required)

Throws:

ApiException - if fails to make API call

deleteOpenAPIAsync

@Deprecated
public CompletableFuture<Void> deleteOpenAPIAsync(UUID id)

Deprecated.

Delete an API.

See deleteOpenAPIWithHttpInfoAsync(java.util.UUID).

Parameters:

id - ID of the API to delete (required)

Returns:

CompletableFuture

deleteOpenAPIWithHttpInfo

@Deprecated
public ApiResponse<Void> deleteOpenAPIWithHttpInfo(UUID id)
                                            throws ApiException

Deprecated.

Delete a specific API by ID.

Parameters:

id - ID of the API to delete (required)

Returns:

ApiResponse<Void>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
204	API deleted successfully	-
400	Bad request	-
403	Forbidden	-
404	API not found error	-
429	Too many requests	-

deleteOpenAPIWithHttpInfoAsync

@Deprecated
public CompletableFuture<ApiResponse<Void>> deleteOpenAPIWithHttpInfoAsync(UUID id)

Deprecated.

Delete an API.

See deleteOpenAPIWithHttpInfo(java.util.UUID).

Parameters:

id - ID of the API to delete (required)

Returns:

CompletableFuture<ApiResponse<Void>>

getOpenAPI

@Deprecated
public File getOpenAPI(UUID id)
                throws ApiException

Deprecated.

Get an API.

See getOpenAPIWithHttpInfo(java.util.UUID).

Parameters:

id - ID of the API to retrieve (required)

Returns:

File

Throws:

ApiException - if fails to make API call

getOpenAPIAsync

@Deprecated
public CompletableFuture<File> getOpenAPIAsync(UUID id)

Deprecated.

Get an API.

See getOpenAPIWithHttpInfoAsync(java.util.UUID).

Parameters:

id - ID of the API to retrieve (required)

Returns:

CompletableFuture<File>

getOpenAPIWithHttpInfo

@Deprecated
public ApiResponse<File> getOpenAPIWithHttpInfo(UUID id)
                                         throws ApiException

Deprecated.

Retrieve information about a specific API in OpenAPI format file.

Parameters:

id - ID of the API to retrieve (required)

Returns:

ApiResponse<File>

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	API not found error	-
429	Too many requests	-

getOpenAPIWithHttpInfoAsync

@Deprecated
public CompletableFuture<ApiResponse<File>> getOpenAPIWithHttpInfoAsync(UUID id)

Deprecated.

Get an API.

See getOpenAPIWithHttpInfo(java.util.UUID).

Parameters:

id - ID of the API to retrieve (required)

Returns:

CompletableFuture<ApiResponse<File>>

listAPIs

@Deprecated
public ListAPIsResponse listAPIs()
                          throws ApiException

Deprecated.

List APIs.

See listAPIsWithHttpInfo(com.datadog.api.client.v2.api.ApiManagementApi.ListAPIsOptionalParameters).

Returns:

ListAPIsResponse

Throws:

ApiException - if fails to make API call

listAPIsAsync

@Deprecated
public CompletableFuture<ListAPIsResponse> listAPIsAsync()

Deprecated.

List APIs.

See listAPIsWithHttpInfoAsync(com.datadog.api.client.v2.api.ApiManagementApi.ListAPIsOptionalParameters).

Returns:

CompletableFuture<ListAPIsResponse>

listAPIs

@Deprecated
public ListAPIsResponse listAPIs(ApiManagementApi.ListAPIsOptionalParameters parameters)
                          throws ApiException

Deprecated.

List APIs.

See listAPIsWithHttpInfo(com.datadog.api.client.v2.api.ApiManagementApi.ListAPIsOptionalParameters).

Parameters:

parameters - Optional parameters for the request.

Returns:

ListAPIsResponse

Throws:

ApiException - if fails to make API call

listAPIsAsync

@Deprecated
public CompletableFuture<ListAPIsResponse> listAPIsAsync(ApiManagementApi.ListAPIsOptionalParameters parameters)

Deprecated.

List APIs.

See listAPIsWithHttpInfoAsync(com.datadog.api.client.v2.api.ApiManagementApi.ListAPIsOptionalParameters).

Parameters:

parameters - Optional parameters for the request.

Returns:

CompletableFuture<ListAPIsResponse>

listAPIsWithHttpInfo

@Deprecated
public ApiResponse<ListAPIsResponse> listAPIsWithHttpInfo(ApiManagementApi.ListAPIsOptionalParameters parameters)
                                                   throws ApiException

Deprecated.

List APIs and their IDs.

Parameters:

parameters - Optional parameters for the request.

Returns:

ApiResponse<ListAPIsResponse>

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	-

listAPIsWithHttpInfoAsync

@Deprecated
public CompletableFuture<ApiResponse<ListAPIsResponse>> listAPIsWithHttpInfoAsync(ApiManagementApi.ListAPIsOptionalParameters parameters)

Deprecated.

List APIs.

See listAPIsWithHttpInfo(com.datadog.api.client.v2.api.ApiManagementApi.ListAPIsOptionalParameters).

Parameters:

parameters - Optional parameters for the request.

Returns:

CompletableFuture<ApiResponse<ListAPIsResponse>>

updateOpenAPI

@Deprecated
public UpdateOpenAPIResponse updateOpenAPI(UUID id)
                                    throws ApiException

Deprecated.

Update an API.

See updateOpenAPIWithHttpInfo(java.util.UUID, com.datadog.api.client.v2.api.ApiManagementApi.UpdateOpenAPIOptionalParameters).

Parameters:

id - ID of the API to modify (required)

Returns:

UpdateOpenAPIResponse

Throws:

ApiException - if fails to make API call

updateOpenAPIAsync

@Deprecated
public CompletableFuture<UpdateOpenAPIResponse> updateOpenAPIAsync(UUID id)

Deprecated.

Update an API.

See updateOpenAPIWithHttpInfoAsync(java.util.UUID, com.datadog.api.client.v2.api.ApiManagementApi.UpdateOpenAPIOptionalParameters).

Parameters:

id - ID of the API to modify (required)

Returns:

CompletableFuture<UpdateOpenAPIResponse>

updateOpenAPI

@Deprecated
public UpdateOpenAPIResponse updateOpenAPI(UUID id,
 ApiManagementApi.UpdateOpenAPIOptionalParameters parameters)
                                    throws ApiException

Deprecated.

Update an API.

See updateOpenAPIWithHttpInfo(java.util.UUID, com.datadog.api.client.v2.api.ApiManagementApi.UpdateOpenAPIOptionalParameters).

Parameters:

id - ID of the API to modify (required)

parameters - Optional parameters for the request.

Returns:

UpdateOpenAPIResponse

Throws:

ApiException - if fails to make API call

updateOpenAPIAsync

@Deprecated
public CompletableFuture<UpdateOpenAPIResponse> updateOpenAPIAsync(UUID id,
 ApiManagementApi.UpdateOpenAPIOptionalParameters parameters)

Deprecated.

Update an API.

See updateOpenAPIWithHttpInfoAsync(java.util.UUID, com.datadog.api.client.v2.api.ApiManagementApi.UpdateOpenAPIOptionalParameters).

Parameters:

id - ID of the API to modify (required)

parameters - Optional parameters for the request.

Returns:

CompletableFuture<UpdateOpenAPIResponse>

updateOpenAPIWithHttpInfo

@Deprecated
public ApiResponse<UpdateOpenAPIResponse> updateOpenAPIWithHttpInfo(UUID id,
 ApiManagementApi.UpdateOpenAPIOptionalParameters parameters)
                                                             throws ApiException

Deprecated.

Update information about a specific API. The given content will replace all API content of the given ID. The ID is returned by the create API, or can be found in the URL in the API catalog UI.

Parameters:

id - ID of the API to modify (required)

parameters - Optional parameters for the request.

Returns:

ApiResponse<UpdateOpenAPIResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	API updated successfully	-
400	Bad request	-
403	Forbidden	-
404	API not found error	-
429	Too many requests	-

updateOpenAPIWithHttpInfoAsync

@Deprecated
public CompletableFuture<ApiResponse<UpdateOpenAPIResponse>> updateOpenAPIWithHttpInfoAsync(UUID id,
 ApiManagementApi.UpdateOpenAPIOptionalParameters parameters)

Deprecated.

Update an API.

See updateOpenAPIWithHttpInfo(java.util.UUID, com.datadog.api.client.v2.api.ApiManagementApi.UpdateOpenAPIOptionalParameters).

Parameters:

id - ID of the API to modify (required)

parameters - Optional parameters for the request.

Returns:

CompletableFuture<ApiResponse<UpdateOpenAPIResponse>>