Package com.datadog.api.client.v2.api
Class SoftwareCatalogApi
java.lang.Object
com.datadog.api.client.v2.api.SoftwareCatalogApi
@Generated("https://github.com/DataDog/datadog-api-client-java/blob/master/.generator")
public class SoftwareCatalogApi
extends Object
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classManage optional parameters to listCatalogEntity.static classManage optional parameters to listCatalogKind.static classManage optional parameters to listCatalogRelation. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoiddeleteCatalogEntity(String entityId) Delete a single entity.deleteCatalogEntityAsync(String entityId) Delete a single entity.deleteCatalogEntityWithHttpInfo(String entityId) Delete a single entity in Software Catalog.deleteCatalogEntityWithHttpInfoAsync(String entityId) Delete a single entity.voiddeleteCatalogKind(String kindId) Delete a single kind.deleteCatalogKindAsync(String kindId) Delete a single kind.deleteCatalogKindWithHttpInfo(String kindId) Delete a single kind in Software Catalog.Delete a single kind.Get the API client.Get a list of entities.Get a list of entities.Get a list of entities.Get a list of entities.Get a list of entities from Software Catalog.listCatalogEntityWithHttpInfoAsync(SoftwareCatalogApi.ListCatalogEntityOptionalParameters parameters) Get a list of entities.Get a list of entities.Get a list of entities.Get a list of entity kinds.Get a list of entity kinds.Get a list of entity kinds.Get a list of entity kinds.Get a list of entity kinds from Software Catalog.Get a list of entity kinds.Get a list of entity kinds.Get a list of entity kinds.Get a list of entity relations.Get a list of entity relations.Get a list of entity relations.Get a list of entity relations.listCatalogRelationWithHttpInfo(SoftwareCatalogApi.ListCatalogRelationOptionalParameters parameters) Get a list of entity relations from Software Catalog.listCatalogRelationWithHttpInfoAsync(SoftwareCatalogApi.ListCatalogRelationOptionalParameters parameters) Get a list of entity relations.Get a list of entity relations.listCatalogRelationWithPagination(SoftwareCatalogApi.ListCatalogRelationOptionalParameters parameters) Get a list of entity relations.Preview catalog entities.Preview catalog entities.Preview catalog entities.voidsetApiClient(ApiClient apiClient) Set the API client.Create or update entities.Create or update entities.Create or update entities in Software Catalog.Create or update entities.Create or update kinds.Create or update kinds.Create or update kinds in Software Catalog.Create or update kinds.
-
Constructor Details
-
SoftwareCatalogApi
public SoftwareCatalogApi() -
SoftwareCatalogApi
-
-
Method Details
-
getApiClient
Get the API client.- Returns:
- API client
-
setApiClient
Set the API client.- Parameters:
apiClient- an instance of API client
-
deleteCatalogEntity
Delete a single entity.- Parameters:
entityId- UUID or Entity Ref. (required)- Throws:
ApiException- if fails to make API call
-
deleteCatalogEntityAsync
Delete a single entity.- Parameters:
entityId- UUID or Entity Ref. (required)- Returns:
- CompletableFuture
-
deleteCatalogEntityWithHttpInfo
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
Delete a single entity.- Parameters:
entityId- UUID or Entity Ref. (required)- Returns:
- CompletableFuture<ApiResponse<Void>>
-
deleteCatalogKind
Delete a single kind.- Parameters:
kindId- Entity kind. (required)- Throws:
ApiException- if fails to make API call
-
deleteCatalogKindAsync
Delete a single kind.- Parameters:
kindId- Entity kind. (required)- Returns:
- CompletableFuture
-
deleteCatalogKindWithHttpInfo
Delete a single kind in Software Catalog.- Parameters:
kindId- Entity kind. (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 -
-
deleteCatalogKindWithHttpInfoAsync
Delete a single kind.- Parameters:
kindId- Entity kind. (required)- Returns:
- CompletableFuture<ApiResponse<Void>>
-
listCatalogEntity
Get a list of entities.- Returns:
- ListEntityCatalogResponse
- Throws:
ApiException- if fails to make API call
-
listCatalogEntityAsync
Get a list of entities.- Returns:
- CompletableFuture<ListEntityCatalogResponse>
-
listCatalogEntity
public ListEntityCatalogResponse listCatalogEntity(SoftwareCatalogApi.ListCatalogEntityOptionalParameters parameters) throws ApiException Get a list of entities.- 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.- Parameters:
parameters- Optional parameters for the request.- Returns:
- CompletableFuture<ListEntityCatalogResponse>
-
listCatalogEntityWithPagination
Get a list of entities.- Returns:
- PaginationIterable<EntityData>
-
listCatalogEntityWithPagination
public PaginationIterable<EntityData> listCatalogEntityWithPagination(SoftwareCatalogApi.ListCatalogEntityOptionalParameters parameters) Get a list of entities.- 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.- Parameters:
parameters- Optional parameters for the request.- Returns:
- CompletableFuture<ApiResponse<ListEntityCatalogResponse>>
-
listCatalogKind
Get a list of entity kinds.- Returns:
- ListKindCatalogResponse
- Throws:
ApiException- if fails to make API call
-
listCatalogKindAsync
Get a list of entity kinds.- Returns:
- CompletableFuture<ListKindCatalogResponse>
-
listCatalogKind
public ListKindCatalogResponse listCatalogKind(SoftwareCatalogApi.ListCatalogKindOptionalParameters parameters) throws ApiException Get a list of entity kinds.- Parameters:
parameters- Optional parameters for the request.- Returns:
- ListKindCatalogResponse
- Throws:
ApiException- if fails to make API call
-
listCatalogKindAsync
public CompletableFuture<ListKindCatalogResponse> listCatalogKindAsync(SoftwareCatalogApi.ListCatalogKindOptionalParameters parameters) Get a list of entity kinds.- Parameters:
parameters- Optional parameters for the request.- Returns:
- CompletableFuture<ListKindCatalogResponse>
-
listCatalogKindWithPagination
Get a list of entity kinds.- Returns:
- PaginationIterable<KindData>
-
listCatalogKindWithPagination
public PaginationIterable<KindData> listCatalogKindWithPagination(SoftwareCatalogApi.ListCatalogKindOptionalParameters parameters) Get a list of entity kinds.- Returns:
- ListKindCatalogResponse
-
listCatalogKindWithHttpInfo
public ApiResponse<ListKindCatalogResponse> listCatalogKindWithHttpInfo(SoftwareCatalogApi.ListCatalogKindOptionalParameters parameters) throws ApiException Get a list of entity kinds from Software Catalog.- Parameters:
parameters- Optional parameters for the request.- Returns:
- ApiResponse<ListKindCatalogResponse>
- 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 -
-
listCatalogKindWithHttpInfoAsync
public CompletableFuture<ApiResponse<ListKindCatalogResponse>> listCatalogKindWithHttpInfoAsync(SoftwareCatalogApi.ListCatalogKindOptionalParameters parameters) Get a list of entity kinds.- Parameters:
parameters- Optional parameters for the request.- Returns:
- CompletableFuture<ApiResponse<ListKindCatalogResponse>>
-
listCatalogRelation
Get a list of entity relations.- Returns:
- ListRelationCatalogResponse
- Throws:
ApiException- if fails to make API call
-
listCatalogRelationAsync
Get a list of entity relations.- Returns:
- CompletableFuture<ListRelationCatalogResponse>
-
listCatalogRelation
public ListRelationCatalogResponse listCatalogRelation(SoftwareCatalogApi.ListCatalogRelationOptionalParameters parameters) throws ApiException Get a list of entity relations.- Parameters:
parameters- Optional parameters for the request.- Returns:
- ListRelationCatalogResponse
- Throws:
ApiException- if fails to make API call
-
listCatalogRelationAsync
public CompletableFuture<ListRelationCatalogResponse> listCatalogRelationAsync(SoftwareCatalogApi.ListCatalogRelationOptionalParameters parameters) Get a list of entity relations.- Parameters:
parameters- Optional parameters for the request.- Returns:
- CompletableFuture<ListRelationCatalogResponse>
-
listCatalogRelationWithPagination
Get a list of entity relations.- Returns:
- PaginationIterable<RelationResponse>
-
listCatalogRelationWithPagination
public PaginationIterable<RelationResponse> listCatalogRelationWithPagination(SoftwareCatalogApi.ListCatalogRelationOptionalParameters parameters) Get a list of entity relations.- Returns:
- ListRelationCatalogResponse
-
listCatalogRelationWithHttpInfo
public ApiResponse<ListRelationCatalogResponse> listCatalogRelationWithHttpInfo(SoftwareCatalogApi.ListCatalogRelationOptionalParameters parameters) throws ApiException Get a list of entity relations from Software Catalog.- Parameters:
parameters- Optional parameters for the request.- Returns:
- ApiResponse<ListRelationCatalogResponse>
- 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 -
-
listCatalogRelationWithHttpInfoAsync
public CompletableFuture<ApiResponse<ListRelationCatalogResponse>> listCatalogRelationWithHttpInfoAsync(SoftwareCatalogApi.ListCatalogRelationOptionalParameters parameters) Get a list of entity relations.- Parameters:
parameters- Optional parameters for the request.- Returns:
- CompletableFuture<ApiResponse<ListRelationCatalogResponse>>
-
previewCatalogEntities
Preview catalog entities.- Returns:
- EntityResponseArray
- Throws:
ApiException- if fails to make API call
-
previewCatalogEntitiesAsync
Preview catalog entities.- Returns:
- CompletableFuture<EntityResponseArray>
-
previewCatalogEntitiesWithHttpInfo
- Returns:
- ApiResponse<EntityResponseArray>
- Throws:
ApiException- if fails to make API call- Http Response Details:
Response details Status Code Description Response Headers 202 Accepted - 429 Too many requests -
-
previewCatalogEntitiesWithHttpInfoAsync
public CompletableFuture<ApiResponse<EntityResponseArray>> previewCatalogEntitiesWithHttpInfoAsync()Preview catalog entities.- Returns:
- CompletableFuture<ApiResponse<EntityResponseArray>>
-
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>>
-
upsertCatalogKind
public UpsertCatalogKindResponse upsertCatalogKind(UpsertCatalogKindRequest body) throws ApiException Create or update kinds.See
upsertCatalogKindWithHttpInfo(com.datadog.api.client.v2.model.UpsertCatalogKindRequest).- Parameters:
body- Kind YAML or JSON. (required)- Returns:
- UpsertCatalogKindResponse
- Throws:
ApiException- if fails to make API call
-
upsertCatalogKindAsync
public CompletableFuture<UpsertCatalogKindResponse> upsertCatalogKindAsync(UpsertCatalogKindRequest body) Create or update kinds.See
upsertCatalogKindWithHttpInfoAsync(com.datadog.api.client.v2.model.UpsertCatalogKindRequest).- Parameters:
body- Kind YAML or JSON. (required)- Returns:
- CompletableFuture<UpsertCatalogKindResponse>
-
upsertCatalogKindWithHttpInfo
public ApiResponse<UpsertCatalogKindResponse> upsertCatalogKindWithHttpInfo(UpsertCatalogKindRequest body) throws ApiException Create or update kinds in Software Catalog.- Parameters:
body- Kind YAML or JSON. (required)- Returns:
- ApiResponse<UpsertCatalogKindResponse>
- 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 -
-
upsertCatalogKindWithHttpInfoAsync
public CompletableFuture<ApiResponse<UpsertCatalogKindResponse>> upsertCatalogKindWithHttpInfoAsync(UpsertCatalogKindRequest body) Create or update kinds.See
upsertCatalogKindWithHttpInfo(com.datadog.api.client.v2.model.UpsertCatalogKindRequest).- Parameters:
body- Kind YAML or JSON. (required)- Returns:
- CompletableFuture<ApiResponse<UpsertCatalogKindResponse>>
-