com.datadog.api.client.v2.api

Class ApiManagementApi

java.lang.Object

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

@Generated(value="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 and 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 and Description
ApiManagementApi()
ApiManagementApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
CreateOpenAPIResponse	createOpenAPI() Create a new API.
CreateOpenAPIResponse	createOpenAPI(ApiManagementApi.CreateOpenAPIOptionalParameters parameters) Create a new API.
CompletableFuture<CreateOpenAPIResponse>	createOpenAPIAsync() Create a new API.
CompletableFuture<CreateOpenAPIResponse>	createOpenAPIAsync(ApiManagementApi.CreateOpenAPIOptionalParameters parameters) Create a new API.
ApiResponse<CreateOpenAPIResponse>	createOpenAPIWithHttpInfo(ApiManagementApi.CreateOpenAPIOptionalParameters parameters) Create a new API from the OpenAPI specification given.
CompletableFuture<ApiResponse<CreateOpenAPIResponse>>	createOpenAPIWithHttpInfoAsync(ApiManagementApi.CreateOpenAPIOptionalParameters parameters) Create a new API.
void	deleteOpenAPI(UUID id) Delete an API.
CompletableFuture<Void>	deleteOpenAPIAsync(UUID id) Delete an API.
ApiResponse<Void>	deleteOpenAPIWithHttpInfo(UUID id) Delete a specific API by ID.
CompletableFuture<ApiResponse<Void>>	deleteOpenAPIWithHttpInfoAsync(UUID id) Delete an API.
ApiClient	getApiClient() Get the API client.
File	getOpenAPI(UUID id) Get an API.
CompletableFuture<File>	getOpenAPIAsync(UUID id) Get an API.
ApiResponse<File>	getOpenAPIWithHttpInfo(UUID id) Retrieve information about a specific API in OpenAPI format file.
CompletableFuture<ApiResponse<File>>	getOpenAPIWithHttpInfoAsync(UUID id) Get an API.
ListAPIsResponse	listAPIs() List APIs.
ListAPIsResponse	listAPIs(ApiManagementApi.ListAPIsOptionalParameters parameters) List APIs.
CompletableFuture<ListAPIsResponse>	listAPIsAsync() List APIs.
CompletableFuture<ListAPIsResponse>	listAPIsAsync(ApiManagementApi.ListAPIsOptionalParameters parameters) List APIs.
ApiResponse<ListAPIsResponse>	listAPIsWithHttpInfo(ApiManagementApi.ListAPIsOptionalParameters parameters) List APIs and their IDs.
CompletableFuture<ApiResponse<ListAPIsResponse>>	listAPIsWithHttpInfoAsync(ApiManagementApi.ListAPIsOptionalParameters parameters) List APIs.
void	setApiClient(ApiClient apiClient) Set the API client.
UpdateOpenAPIResponse	updateOpenAPI(UUID id) Update an API.
UpdateOpenAPIResponse	updateOpenAPI(UUID id, ApiManagementApi.UpdateOpenAPIOptionalParameters parameters) Update an API.
CompletableFuture<UpdateOpenAPIResponse>	updateOpenAPIAsync(UUID id) Update an API.
CompletableFuture<UpdateOpenAPIResponse>	updateOpenAPIAsync(UUID id, ApiManagementApi.UpdateOpenAPIOptionalParameters parameters) Update an API.
ApiResponse<UpdateOpenAPIResponse>	updateOpenAPIWithHttpInfo(UUID id, ApiManagementApi.UpdateOpenAPIOptionalParameters parameters) Update information about a specific API.
CompletableFuture<ApiResponse<UpdateOpenAPIResponse>>	updateOpenAPIWithHttpInfoAsync(UUID id, ApiManagementApi.UpdateOpenAPIOptionalParameters parameters) Update an API.

Methods inherited from class java.lang.Object

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

Constructor Detail

ApiManagementApi

public ApiManagementApi()

ApiManagementApi

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

createOpenAPI

public CreateOpenAPIResponse createOpenAPI()
                                    throws ApiException

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

public CompletableFuture<CreateOpenAPIResponse> createOpenAPIAsync()

Create a new API.

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

Returns:

CompletableFuture<CreateOpenAPIResponse>

createOpenAPI

public CreateOpenAPIResponse createOpenAPI(ApiManagementApi.CreateOpenAPIOptionalParameters parameters)
                                    throws ApiException

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

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

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

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

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

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

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

public void deleteOpenAPI(UUID id)
                   throws ApiException

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

public CompletableFuture<Void> deleteOpenAPIAsync(UUID id)

Delete an API.

See deleteOpenAPIWithHttpInfoAsync(java.util.UUID).

Parameters:

id - ID of the API to delete (required)

Returns:

CompletableFuture

deleteOpenAPIWithHttpInfo

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

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

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

Delete an API.

See deleteOpenAPIWithHttpInfo(java.util.UUID).

Parameters:

id - ID of the API to delete (required)

Returns:

CompletableFuture<ApiResponse<Void>>

getOpenAPI

public File getOpenAPI(UUID id)
                throws ApiException

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

public CompletableFuture<File> getOpenAPIAsync(UUID id)

Get an API.

See getOpenAPIWithHttpInfoAsync(java.util.UUID).

Parameters:

id - ID of the API to retrieve (required)

Returns:

CompletableFuture<File>

getOpenAPIWithHttpInfo

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

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

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

Get an API.

See getOpenAPIWithHttpInfo(java.util.UUID).

Parameters:

id - ID of the API to retrieve (required)

Returns:

CompletableFuture<ApiResponse<File>>

listAPIs

public ListAPIsResponse listAPIs()
                          throws ApiException

List APIs.

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

Returns:

ListAPIsResponse

Throws:

ApiException - if fails to make API call

listAPIsAsync

public CompletableFuture<ListAPIsResponse> listAPIsAsync()

List APIs.

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

Returns:

CompletableFuture<ListAPIsResponse>

listAPIs

public ListAPIsResponse listAPIs(ApiManagementApi.ListAPIsOptionalParameters parameters)
                          throws ApiException

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

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

List APIs.

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

Parameters:

parameters - Optional parameters for the request.

Returns:

CompletableFuture<ListAPIsResponse>

listAPIsWithHttpInfo

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

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

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

List APIs.

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

Parameters:

parameters - Optional parameters for the request.

Returns:

CompletableFuture<ApiResponse<ListAPIsResponse>>

updateOpenAPI

public UpdateOpenAPIResponse updateOpenAPI(UUID id)
                                    throws ApiException

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

public CompletableFuture<UpdateOpenAPIResponse> updateOpenAPIAsync(UUID id)

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

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

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

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

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

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

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

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

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>>