com.datadog.api.client.v2.api

Class SoftwareCatalogApi

java.lang.Object

com.datadog.api.client.v2.api.SoftwareCatalogApi

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SoftwareCatalogApi.ListCatalogEntityOptionalParameters Manage optional parameters to listCatalogEntity.

Constructor Summary

Constructors

Constructor and Description
SoftwareCatalogApi()
SoftwareCatalogApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
void	deleteCatalogEntity(String entityId) Delete a single entity.
CompletableFuture<Void>	deleteCatalogEntityAsync(String entityId) Delete a single entity.
ApiResponse<Void>	deleteCatalogEntityWithHttpInfo(String entityId) Delete a single entity in Software Catalog.
CompletableFuture<ApiResponse<Void>>	deleteCatalogEntityWithHttpInfoAsync(String entityId) Delete a single entity.
ApiClient	getApiClient() Get the API client.
ListEntityCatalogResponse	listCatalogEntity() Get a list of entities.
ListEntityCatalogResponse	listCatalogEntity(SoftwareCatalogApi.ListCatalogEntityOptionalParameters parameters) Get a list of entities.
CompletableFuture<ListEntityCatalogResponse>	listCatalogEntityAsync() Get a list of entities.
CompletableFuture<ListEntityCatalogResponse>	listCatalogEntityAsync(SoftwareCatalogApi.ListCatalogEntityOptionalParameters parameters) Get a list of entities.
ApiResponse<ListEntityCatalogResponse>	listCatalogEntityWithHttpInfo(SoftwareCatalogApi.ListCatalogEntityOptionalParameters parameters) Get a list of entities from Software Catalog.
CompletableFuture<ApiResponse<ListEntityCatalogResponse>>	listCatalogEntityWithHttpInfoAsync(SoftwareCatalogApi.ListCatalogEntityOptionalParameters parameters) Get a list of entities.
PaginationIterable<EntityData>	listCatalogEntityWithPagination() Get a list of entities.
PaginationIterable<EntityData>	listCatalogEntityWithPagination(SoftwareCatalogApi.ListCatalogEntityOptionalParameters parameters) Get a list of entities.
void	setApiClient(ApiClient apiClient) Set the API client.
UpsertCatalogEntityResponse	upsertCatalogEntity(UpsertCatalogEntityRequest body) Create or update entities.
CompletableFuture<UpsertCatalogEntityResponse>	upsertCatalogEntityAsync(UpsertCatalogEntityRequest body) Create or update entities.
ApiResponse<UpsertCatalogEntityResponse>	upsertCatalogEntityWithHttpInfo(UpsertCatalogEntityRequest body) Create or update entities in Software Catalog.
CompletableFuture<ApiResponse<UpsertCatalogEntityResponse>>	upsertCatalogEntityWithHttpInfoAsync(UpsertCatalogEntityRequest body) Create or update entities.

Methods inherited from class java.lang.Object

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

Constructor Detail

SoftwareCatalogApi

public SoftwareCatalogApi()

SoftwareCatalogApi

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

deleteCatalogEntity

public void deleteCatalogEntity(String entityId)
                         throws ApiException

Delete a single entity.

See deleteCatalogEntityWithHttpInfo(java.lang.String).

Parameters:

entityId - UUID or Entity Ref. (required)

Throws:

ApiException - if fails to make API call

deleteCatalogEntityAsync

public CompletableFuture<Void> deleteCatalogEntityAsync(String entityId)

Delete a single entity.

See deleteCatalogEntityWithHttpInfoAsync(java.lang.String).

Parameters:

entityId - UUID or Entity Ref. (required)

Returns:

CompletableFuture

deleteCatalogEntityWithHttpInfo

public ApiResponse<Void> deleteCatalogEntityWithHttpInfo(String entityId)
                                                  throws ApiException

Delete a single entity in Software Catalog.

Parameters:

entityId - UUID or Entity Ref. (required)

Returns:

ApiResponse<Void>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

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

deleteCatalogEntityWithHttpInfoAsync

public CompletableFuture<ApiResponse<Void>> deleteCatalogEntityWithHttpInfoAsync(String entityId)

Delete a single entity.

See deleteCatalogEntityWithHttpInfo(java.lang.String).

Parameters:

entityId - UUID or Entity Ref. (required)

Returns:

CompletableFuture<ApiResponse<Void>>

listCatalogEntity

public ListEntityCatalogResponse listCatalogEntity()
                                            throws ApiException

Get a list of entities.

See listCatalogEntityWithHttpInfo(com.datadog.api.client.v2.api.SoftwareCatalogApi.ListCatalogEntityOptionalParameters).

Returns:

ListEntityCatalogResponse

Throws:

ApiException - if fails to make API call

listCatalogEntityAsync

public CompletableFuture<ListEntityCatalogResponse> listCatalogEntityAsync()

Get a list of entities.

See listCatalogEntityWithHttpInfoAsync(com.datadog.api.client.v2.api.SoftwareCatalogApi.ListCatalogEntityOptionalParameters).

Returns:

CompletableFuture<ListEntityCatalogResponse>

listCatalogEntity

public ListEntityCatalogResponse listCatalogEntity(SoftwareCatalogApi.ListCatalogEntityOptionalParameters parameters)
                                            throws ApiException

Get a list of entities.

See listCatalogEntityWithHttpInfo(com.datadog.api.client.v2.api.SoftwareCatalogApi.ListCatalogEntityOptionalParameters).

Parameters:

parameters - Optional parameters for the request.

Returns:

ListEntityCatalogResponse

Throws:

ApiException - if fails to make API call

listCatalogEntityAsync

public CompletableFuture<ListEntityCatalogResponse> listCatalogEntityAsync(SoftwareCatalogApi.ListCatalogEntityOptionalParameters parameters)

Get a list of entities.

See listCatalogEntityWithHttpInfoAsync(com.datadog.api.client.v2.api.SoftwareCatalogApi.ListCatalogEntityOptionalParameters).

Parameters:

parameters - Optional parameters for the request.

Returns:

CompletableFuture<ListEntityCatalogResponse>

listCatalogEntityWithPagination

public PaginationIterable<EntityData> listCatalogEntityWithPagination()

Get a list of entities.

See listCatalogEntityWithHttpInfo(com.datadog.api.client.v2.api.SoftwareCatalogApi.ListCatalogEntityOptionalParameters).

Returns:

PaginationIterable<EntityData>

listCatalogEntityWithPagination

public PaginationIterable<EntityData> listCatalogEntityWithPagination(SoftwareCatalogApi.ListCatalogEntityOptionalParameters parameters)

Get a list of entities.

See listCatalogEntityWithHttpInfo(com.datadog.api.client.v2.api.SoftwareCatalogApi.ListCatalogEntityOptionalParameters).

Returns:

ListEntityCatalogResponse

listCatalogEntityWithHttpInfo

public ApiResponse<ListEntityCatalogResponse> listCatalogEntityWithHttpInfo(SoftwareCatalogApi.ListCatalogEntityOptionalParameters parameters)
                                                                     throws ApiException

Get a list of entities from Software Catalog.

Parameters:

parameters - Optional parameters for the request.

Returns:

ApiResponse<ListEntityCatalogResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK	-
403	Forbidden	-
429	Too many requests	-

listCatalogEntityWithHttpInfoAsync

public CompletableFuture<ApiResponse<ListEntityCatalogResponse>> listCatalogEntityWithHttpInfoAsync(SoftwareCatalogApi.ListCatalogEntityOptionalParameters parameters)

Get a list of entities.

See listCatalogEntityWithHttpInfo(com.datadog.api.client.v2.api.SoftwareCatalogApi.ListCatalogEntityOptionalParameters).

Parameters:

parameters - Optional parameters for the request.

Returns:

CompletableFuture<ApiResponse<ListEntityCatalogResponse>>

upsertCatalogEntity

public UpsertCatalogEntityResponse upsertCatalogEntity(UpsertCatalogEntityRequest body)
                                                throws ApiException

Create or update entities.

See upsertCatalogEntityWithHttpInfo(com.datadog.api.client.v2.model.UpsertCatalogEntityRequest).

Parameters:

body - Entity YAML or JSON. (required)

Returns:

UpsertCatalogEntityResponse

Throws:

ApiException - if fails to make API call

upsertCatalogEntityAsync

public CompletableFuture<UpsertCatalogEntityResponse> upsertCatalogEntityAsync(UpsertCatalogEntityRequest body)

Create or update entities.

See upsertCatalogEntityWithHttpInfoAsync(com.datadog.api.client.v2.model.UpsertCatalogEntityRequest).

Parameters:

body - Entity YAML or JSON. (required)

Returns:

CompletableFuture<UpsertCatalogEntityResponse>

upsertCatalogEntityWithHttpInfo

public ApiResponse<UpsertCatalogEntityResponse> upsertCatalogEntityWithHttpInfo(UpsertCatalogEntityRequest body)
                                                                         throws ApiException

Create or update entities in Software Catalog.

Parameters:

body - Entity YAML or JSON. (required)

Returns:

ApiResponse<UpsertCatalogEntityResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
202	ACCEPTED	-
400	Bad Request	-
403	Forbidden	-
429	Too many requests	-

upsertCatalogEntityWithHttpInfoAsync

public CompletableFuture<ApiResponse<UpsertCatalogEntityResponse>> upsertCatalogEntityWithHttpInfoAsync(UpsertCatalogEntityRequest body)

Create or update entities.

See upsertCatalogEntityWithHttpInfo(com.datadog.api.client.v2.model.UpsertCatalogEntityRequest).

Parameters:

body - Entity YAML or JSON. (required)

Returns:

CompletableFuture<ApiResponse<UpsertCatalogEntityResponse>>