com.datadog.api.client.v2.api

Class ServiceDefinitionApi

java.lang.Object

com.datadog.api.client.v2.api.ServiceDefinitionApi

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ServiceDefinitionApi.GetServiceDefinitionOptionalParameters Manage optional parameters to getServiceDefinition.
static class	ServiceDefinitionApi.ListServiceDefinitionsOptionalParameters Manage optional parameters to listServiceDefinitions.

Constructor Summary

Constructors

Constructor and Description
ServiceDefinitionApi()
ServiceDefinitionApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ServiceDefinitionCreateResponse	createOrUpdateServiceDefinitions(ServiceDefinitionsCreateRequest body) Create or update service definition.
CompletableFuture<ServiceDefinitionCreateResponse>	createOrUpdateServiceDefinitionsAsync(ServiceDefinitionsCreateRequest body) Create or update service definition.
ApiResponse<ServiceDefinitionCreateResponse>	createOrUpdateServiceDefinitionsWithHttpInfo(ServiceDefinitionsCreateRequest body) Create or update service definition in the Datadog Service Catalog.
CompletableFuture<ApiResponse<ServiceDefinitionCreateResponse>>	createOrUpdateServiceDefinitionsWithHttpInfoAsync(ServiceDefinitionsCreateRequest body) Create or update service definition.
void	deleteServiceDefinition(String serviceName) Delete a single service definition.
CompletableFuture<Void>	deleteServiceDefinitionAsync(String serviceName) Delete a single service definition.
ApiResponse<Void>	deleteServiceDefinitionWithHttpInfo(String serviceName) Delete a single service definition in the Datadog Service Catalog.
CompletableFuture<ApiResponse<Void>>	deleteServiceDefinitionWithHttpInfoAsync(String serviceName) Delete a single service definition.
ApiClient	getApiClient() Get the API client.
ServiceDefinitionGetResponse	getServiceDefinition(String serviceName) Get a single service definition.
ServiceDefinitionGetResponse	getServiceDefinition(String serviceName, ServiceDefinitionApi.GetServiceDefinitionOptionalParameters parameters) Get a single service definition.
CompletableFuture<ServiceDefinitionGetResponse>	getServiceDefinitionAsync(String serviceName) Get a single service definition.
CompletableFuture<ServiceDefinitionGetResponse>	getServiceDefinitionAsync(String serviceName, ServiceDefinitionApi.GetServiceDefinitionOptionalParameters parameters) Get a single service definition.
ApiResponse<ServiceDefinitionGetResponse>	getServiceDefinitionWithHttpInfo(String serviceName, ServiceDefinitionApi.GetServiceDefinitionOptionalParameters parameters) Get a single service definition from the Datadog Service Catalog.
CompletableFuture<ApiResponse<ServiceDefinitionGetResponse>>	getServiceDefinitionWithHttpInfoAsync(String serviceName, ServiceDefinitionApi.GetServiceDefinitionOptionalParameters parameters) Get a single service definition.
ServiceDefinitionsListResponse	listServiceDefinitions() Get all service definitions.
ServiceDefinitionsListResponse	listServiceDefinitions(ServiceDefinitionApi.ListServiceDefinitionsOptionalParameters parameters) Get all service definitions.
CompletableFuture<ServiceDefinitionsListResponse>	listServiceDefinitionsAsync() Get all service definitions.
CompletableFuture<ServiceDefinitionsListResponse>	listServiceDefinitionsAsync(ServiceDefinitionApi.ListServiceDefinitionsOptionalParameters parameters) Get all service definitions.
ApiResponse<ServiceDefinitionsListResponse>	listServiceDefinitionsWithHttpInfo(ServiceDefinitionApi.ListServiceDefinitionsOptionalParameters parameters) Get a list of all service definitions from the Datadog Service Catalog.
CompletableFuture<ApiResponse<ServiceDefinitionsListResponse>>	listServiceDefinitionsWithHttpInfoAsync(ServiceDefinitionApi.ListServiceDefinitionsOptionalParameters parameters) Get all service definitions.
PaginationIterable<ServiceDefinitionData>	listServiceDefinitionsWithPagination() Get all service definitions.
PaginationIterable<ServiceDefinitionData>	listServiceDefinitionsWithPagination(ServiceDefinitionApi.ListServiceDefinitionsOptionalParameters parameters) Get all service definitions.
void	setApiClient(ApiClient apiClient) Set the API client.

Methods inherited from class java.lang.Object

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

Constructor Detail

ServiceDefinitionApi

public ServiceDefinitionApi()

ServiceDefinitionApi

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

createOrUpdateServiceDefinitions

public ServiceDefinitionCreateResponse createOrUpdateServiceDefinitions(ServiceDefinitionsCreateRequest body)
                                                                 throws ApiException

Create or update service definition.

See createOrUpdateServiceDefinitionsWithHttpInfo(com.datadog.api.client.v2.model.ServiceDefinitionsCreateRequest).

Parameters:

body - Service Definition YAML/JSON. (required)

Returns:

ServiceDefinitionCreateResponse

Throws:

ApiException - if fails to make API call

createOrUpdateServiceDefinitionsAsync

public CompletableFuture<ServiceDefinitionCreateResponse> createOrUpdateServiceDefinitionsAsync(ServiceDefinitionsCreateRequest body)

Create or update service definition.

See createOrUpdateServiceDefinitionsWithHttpInfoAsync(com.datadog.api.client.v2.model.ServiceDefinitionsCreateRequest).

Parameters:

body - Service Definition YAML/JSON. (required)

Returns:

CompletableFuture<ServiceDefinitionCreateResponse>

createOrUpdateServiceDefinitionsWithHttpInfo

public ApiResponse<ServiceDefinitionCreateResponse> createOrUpdateServiceDefinitionsWithHttpInfo(ServiceDefinitionsCreateRequest body)
                                                                                          throws ApiException

Create or update service definition in the Datadog Service Catalog.

Parameters:

body - Service Definition YAML/JSON. (required)

Returns:

ApiResponse<ServiceDefinitionCreateResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	CREATED	-
400	Bad Request	-
403	Forbidden	-
409	Conflict	-
429	Too many requests	-

createOrUpdateServiceDefinitionsWithHttpInfoAsync

public CompletableFuture<ApiResponse<ServiceDefinitionCreateResponse>> createOrUpdateServiceDefinitionsWithHttpInfoAsync(ServiceDefinitionsCreateRequest body)

Create or update service definition.

See createOrUpdateServiceDefinitionsWithHttpInfo(com.datadog.api.client.v2.model.ServiceDefinitionsCreateRequest).

Parameters:

body - Service Definition YAML/JSON. (required)

Returns:

CompletableFuture<ApiResponse<ServiceDefinitionCreateResponse>>

deleteServiceDefinition

public void deleteServiceDefinition(String serviceName)
                             throws ApiException

Delete a single service definition.

See deleteServiceDefinitionWithHttpInfo(java.lang.String).

Parameters:

serviceName - The name of the service. (required)

Throws:

ApiException - if fails to make API call

deleteServiceDefinitionAsync

public CompletableFuture<Void> deleteServiceDefinitionAsync(String serviceName)

Delete a single service definition.

See deleteServiceDefinitionWithHttpInfoAsync(java.lang.String).

Parameters:

serviceName - The name of the service. (required)

Returns:

CompletableFuture

deleteServiceDefinitionWithHttpInfo

public ApiResponse<Void> deleteServiceDefinitionWithHttpInfo(String serviceName)
                                                      throws ApiException

Delete a single service definition in the Datadog Service Catalog.

Parameters:

serviceName - The name of the service. (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	-

deleteServiceDefinitionWithHttpInfoAsync

public CompletableFuture<ApiResponse<Void>> deleteServiceDefinitionWithHttpInfoAsync(String serviceName)

Delete a single service definition.

See deleteServiceDefinitionWithHttpInfo(java.lang.String).

Parameters:

serviceName - The name of the service. (required)

Returns:

CompletableFuture<ApiResponse<Void>>

getServiceDefinition

public ServiceDefinitionGetResponse getServiceDefinition(String serviceName)
                                                  throws ApiException

Get a single service definition.

See getServiceDefinitionWithHttpInfo(java.lang.String, com.datadog.api.client.v2.api.ServiceDefinitionApi.GetServiceDefinitionOptionalParameters).

Parameters:

serviceName - The name of the service. (required)

Returns:

ServiceDefinitionGetResponse

Throws:

ApiException - if fails to make API call

getServiceDefinitionAsync

public CompletableFuture<ServiceDefinitionGetResponse> getServiceDefinitionAsync(String serviceName)

Get a single service definition.

See getServiceDefinitionWithHttpInfoAsync(java.lang.String, com.datadog.api.client.v2.api.ServiceDefinitionApi.GetServiceDefinitionOptionalParameters).

Parameters:

serviceName - The name of the service. (required)

Returns:

CompletableFuture<ServiceDefinitionGetResponse>

getServiceDefinition

public ServiceDefinitionGetResponse getServiceDefinition(String serviceName,
                                                         ServiceDefinitionApi.GetServiceDefinitionOptionalParameters parameters)
                                                  throws ApiException

Get a single service definition.

See getServiceDefinitionWithHttpInfo(java.lang.String, com.datadog.api.client.v2.api.ServiceDefinitionApi.GetServiceDefinitionOptionalParameters).

Parameters:

serviceName - The name of the service. (required)

parameters - Optional parameters for the request.

Returns:

ServiceDefinitionGetResponse

Throws:

ApiException - if fails to make API call

getServiceDefinitionAsync

public CompletableFuture<ServiceDefinitionGetResponse> getServiceDefinitionAsync(String serviceName,
                                                                                 ServiceDefinitionApi.GetServiceDefinitionOptionalParameters parameters)

Get a single service definition.

See getServiceDefinitionWithHttpInfoAsync(java.lang.String, com.datadog.api.client.v2.api.ServiceDefinitionApi.GetServiceDefinitionOptionalParameters).

Parameters:

serviceName - The name of the service. (required)

parameters - Optional parameters for the request.

Returns:

CompletableFuture<ServiceDefinitionGetResponse>

getServiceDefinitionWithHttpInfo

public ApiResponse<ServiceDefinitionGetResponse> getServiceDefinitionWithHttpInfo(String serviceName,
                                                                                  ServiceDefinitionApi.GetServiceDefinitionOptionalParameters parameters)
                                                                           throws ApiException

Get a single service definition from the Datadog Service Catalog.

Parameters:

serviceName - The name of the service. (required)

parameters - Optional parameters for the request.

Returns:

ApiResponse<ServiceDefinitionGetResponse>

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	-
409	Conflict	-
429	Too many requests	-

getServiceDefinitionWithHttpInfoAsync

public CompletableFuture<ApiResponse<ServiceDefinitionGetResponse>> getServiceDefinitionWithHttpInfoAsync(String serviceName,
                                                                                                          ServiceDefinitionApi.GetServiceDefinitionOptionalParameters parameters)

Get a single service definition.

See getServiceDefinitionWithHttpInfo(java.lang.String, com.datadog.api.client.v2.api.ServiceDefinitionApi.GetServiceDefinitionOptionalParameters).

Parameters:

serviceName - The name of the service. (required)

parameters - Optional parameters for the request.

Returns:

CompletableFuture<ApiResponse<ServiceDefinitionGetResponse>>

listServiceDefinitions

public ServiceDefinitionsListResponse listServiceDefinitions()
                                                      throws ApiException

Get all service definitions.

See listServiceDefinitionsWithHttpInfo(com.datadog.api.client.v2.api.ServiceDefinitionApi.ListServiceDefinitionsOptionalParameters).

Returns:

ServiceDefinitionsListResponse

Throws:

ApiException - if fails to make API call

listServiceDefinitionsAsync

public CompletableFuture<ServiceDefinitionsListResponse> listServiceDefinitionsAsync()

Get all service definitions.

See listServiceDefinitionsWithHttpInfoAsync(com.datadog.api.client.v2.api.ServiceDefinitionApi.ListServiceDefinitionsOptionalParameters).

Returns:

CompletableFuture<ServiceDefinitionsListResponse>

listServiceDefinitions

public ServiceDefinitionsListResponse listServiceDefinitions(ServiceDefinitionApi.ListServiceDefinitionsOptionalParameters parameters)
                                                      throws ApiException

Get all service definitions.

See listServiceDefinitionsWithHttpInfo(com.datadog.api.client.v2.api.ServiceDefinitionApi.ListServiceDefinitionsOptionalParameters).

Parameters:

parameters - Optional parameters for the request.

Returns:

ServiceDefinitionsListResponse

Throws:

ApiException - if fails to make API call

listServiceDefinitionsAsync

public CompletableFuture<ServiceDefinitionsListResponse> listServiceDefinitionsAsync(ServiceDefinitionApi.ListServiceDefinitionsOptionalParameters parameters)

Get all service definitions.

See listServiceDefinitionsWithHttpInfoAsync(com.datadog.api.client.v2.api.ServiceDefinitionApi.ListServiceDefinitionsOptionalParameters).

Parameters:

parameters - Optional parameters for the request.

Returns:

CompletableFuture<ServiceDefinitionsListResponse>

listServiceDefinitionsWithPagination

public PaginationIterable<ServiceDefinitionData> listServiceDefinitionsWithPagination()

Get all service definitions.

See listServiceDefinitionsWithHttpInfo(com.datadog.api.client.v2.api.ServiceDefinitionApi.ListServiceDefinitionsOptionalParameters).

Returns:

PaginationIterable<ServiceDefinitionData>

listServiceDefinitionsWithPagination

public PaginationIterable<ServiceDefinitionData> listServiceDefinitionsWithPagination(ServiceDefinitionApi.ListServiceDefinitionsOptionalParameters parameters)

Get all service definitions.

See listServiceDefinitionsWithHttpInfo(com.datadog.api.client.v2.api.ServiceDefinitionApi.ListServiceDefinitionsOptionalParameters).

Returns:

ServiceDefinitionsListResponse

listServiceDefinitionsWithHttpInfo

public ApiResponse<ServiceDefinitionsListResponse> listServiceDefinitionsWithHttpInfo(ServiceDefinitionApi.ListServiceDefinitionsOptionalParameters parameters)
                                                                               throws ApiException

Get a list of all service definitions from the Datadog Service Catalog.

Parameters:

parameters - Optional parameters for the request.

Returns:

ApiResponse<ServiceDefinitionsListResponse>

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	-

listServiceDefinitionsWithHttpInfoAsync

public CompletableFuture<ApiResponse<ServiceDefinitionsListResponse>> listServiceDefinitionsWithHttpInfoAsync(ServiceDefinitionApi.ListServiceDefinitionsOptionalParameters parameters)

Get all service definitions.

See listServiceDefinitionsWithHttpInfo(com.datadog.api.client.v2.api.ServiceDefinitionApi.ListServiceDefinitionsOptionalParameters).

Parameters:

parameters - Optional parameters for the request.

Returns:

CompletableFuture<ApiResponse<ServiceDefinitionsListResponse>>