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

Class ObservabilityPipelinesApi

java.lang.Object

com.datadog.api.client.v2.api.ObservabilityPipelinesApi

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ObservabilityPipelinesApi.ListPipelinesOptionalParameters	Manage optional parameters to listPipelines.

Constructor Summary

Constructors

Constructor	Description
ObservabilityPipelinesApi()
ObservabilityPipelinesApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
ObservabilityPipeline	createPipeline(ObservabilityPipelineSpec body)	Create a new pipeline.
CompletableFuture<ObservabilityPipeline>	createPipelineAsync(ObservabilityPipelineSpec body)	Create a new pipeline.
ApiResponse<ObservabilityPipeline>	createPipelineWithHttpInfo(ObservabilityPipelineSpec body)	Create a new pipeline.
CompletableFuture<ApiResponse<ObservabilityPipeline>>	createPipelineWithHttpInfoAsync(ObservabilityPipelineSpec body)	Create a new pipeline.
void	deletePipeline(String pipelineId)	Delete a pipeline.
CompletableFuture<Void>	deletePipelineAsync(String pipelineId)	Delete a pipeline.
ApiResponse<Void>	deletePipelineWithHttpInfo(String pipelineId)	Delete a pipeline.
CompletableFuture<ApiResponse<Void>>	deletePipelineWithHttpInfoAsync(String pipelineId)	Delete a pipeline.
ApiClient	getApiClient()	Get the API client.
ObservabilityPipeline	getPipeline(String pipelineId)	Get a specific pipeline.
CompletableFuture<ObservabilityPipeline>	getPipelineAsync(String pipelineId)	Get a specific pipeline.
ApiResponse<ObservabilityPipeline>	getPipelineWithHttpInfo(String pipelineId)	Get a specific pipeline by its ID.
CompletableFuture<ApiResponse<ObservabilityPipeline>>	getPipelineWithHttpInfoAsync(String pipelineId)	Get a specific pipeline.
ListPipelinesResponse	listPipelines()	List pipelines.
ListPipelinesResponse	listPipelines(ObservabilityPipelinesApi.ListPipelinesOptionalParameters parameters)	List pipelines.
CompletableFuture<ListPipelinesResponse>	listPipelinesAsync()	List pipelines.
CompletableFuture<ListPipelinesResponse>	listPipelinesAsync(ObservabilityPipelinesApi.ListPipelinesOptionalParameters parameters)	List pipelines.
ApiResponse<ListPipelinesResponse>	listPipelinesWithHttpInfo(ObservabilityPipelinesApi.ListPipelinesOptionalParameters parameters)	Retrieve a list of pipelines.
CompletableFuture<ApiResponse<ListPipelinesResponse>>	listPipelinesWithHttpInfoAsync(ObservabilityPipelinesApi.ListPipelinesOptionalParameters parameters)	List pipelines.
void	setApiClient(ApiClient apiClient)	Set the API client.
ObservabilityPipeline	updatePipeline(String pipelineId, ObservabilityPipeline body)	Update a pipeline.
CompletableFuture<ObservabilityPipeline>	updatePipelineAsync(String pipelineId, ObservabilityPipeline body)	Update a pipeline.
ApiResponse<ObservabilityPipeline>	updatePipelineWithHttpInfo(String pipelineId, ObservabilityPipeline body)	Update a pipeline.
CompletableFuture<ApiResponse<ObservabilityPipeline>>	updatePipelineWithHttpInfoAsync(String pipelineId, ObservabilityPipeline body)	Update a pipeline.
ValidationResponse	validatePipeline(ObservabilityPipelineSpec body)	Validate an observability pipeline.
CompletableFuture<ValidationResponse>	validatePipelineAsync(ObservabilityPipelineSpec body)	Validate an observability pipeline.
ApiResponse<ValidationResponse>	validatePipelineWithHttpInfo(ObservabilityPipelineSpec body)	Validates a pipeline configuration without creating or updating any resources.
CompletableFuture<ApiResponse<ValidationResponse>>	validatePipelineWithHttpInfoAsync(ObservabilityPipelineSpec body)	Validate an observability pipeline.

Methods inherited from class java.lang.Object

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

Constructor Details

ObservabilityPipelinesApi

public ObservabilityPipelinesApi()

ObservabilityPipelinesApi

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

createPipeline

public ObservabilityPipeline createPipeline(ObservabilityPipelineSpec body)
                                     throws ApiException

Create a new pipeline.

See createPipelineWithHttpInfo(com.datadog.api.client.v2.model.ObservabilityPipelineSpec).

Parameters:

body - (required)

Returns:

ObservabilityPipeline

Throws:

ApiException - if fails to make API call

createPipelineAsync

public CompletableFuture<ObservabilityPipeline> createPipelineAsync(ObservabilityPipelineSpec body)

Create a new pipeline.

See createPipelineWithHttpInfoAsync(com.datadog.api.client.v2.model.ObservabilityPipelineSpec).

Parameters:

body - (required)

Returns:

CompletableFuture<ObservabilityPipeline>

createPipelineWithHttpInfo

public ApiResponse<ObservabilityPipeline> createPipelineWithHttpInfo(ObservabilityPipelineSpec body)
                                                              throws ApiException

Create a new pipeline.

Parameters:

body - (required)

Returns:

ApiResponse<ObservabilityPipeline>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
201	OK	-
400	Bad Request	-
403	Not Authorized	-
409	Conflict	-
429	Too many requests	-

createPipelineWithHttpInfoAsync

public CompletableFuture<ApiResponse<ObservabilityPipeline>> createPipelineWithHttpInfoAsync(ObservabilityPipelineSpec body)

Create a new pipeline.

See createPipelineWithHttpInfo(com.datadog.api.client.v2.model.ObservabilityPipelineSpec).

Parameters:

body - (required)

Returns:

CompletableFuture<ApiResponse<ObservabilityPipeline>>

deletePipeline

public void deletePipeline(String pipelineId)
                    throws ApiException

Delete a pipeline.

See deletePipelineWithHttpInfo(java.lang.String).

Parameters:

pipelineId - The ID of the pipeline to delete. (required)

Throws:

ApiException - if fails to make API call

deletePipelineAsync

public CompletableFuture<Void> deletePipelineAsync(String pipelineId)

Delete a pipeline.

See deletePipelineWithHttpInfoAsync(java.lang.String).

Parameters:

pipelineId - The ID of the pipeline to delete. (required)

Returns:

CompletableFuture

deletePipelineWithHttpInfo

public ApiResponse<Void> deletePipelineWithHttpInfo(String pipelineId)
                                             throws ApiException

Delete a pipeline.

Parameters:

pipelineId - The ID of the pipeline 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	OK	-
403	Forbidden	-
404	Not Found	-
409	Conflict	-
429	Too many requests	-

deletePipelineWithHttpInfoAsync

public CompletableFuture<ApiResponse<Void>> deletePipelineWithHttpInfoAsync(String pipelineId)

Delete a pipeline.

See deletePipelineWithHttpInfo(java.lang.String).

Parameters:

pipelineId - The ID of the pipeline to delete. (required)

Returns:

CompletableFuture<ApiResponse<Void>>

getPipeline

public ObservabilityPipeline getPipeline(String pipelineId)
                                  throws ApiException

Get a specific pipeline.

See getPipelineWithHttpInfo(java.lang.String).

Parameters:

pipelineId - The ID of the pipeline to retrieve. (required)

Returns:

ObservabilityPipeline

Throws:

ApiException - if fails to make API call

getPipelineAsync

public CompletableFuture<ObservabilityPipeline> getPipelineAsync(String pipelineId)

Get a specific pipeline.

See getPipelineWithHttpInfoAsync(java.lang.String).

Parameters:

pipelineId - The ID of the pipeline to retrieve. (required)

Returns:

CompletableFuture<ObservabilityPipeline>

getPipelineWithHttpInfo

public ApiResponse<ObservabilityPipeline> getPipelineWithHttpInfo(String pipelineId)
                                                           throws ApiException

Get a specific pipeline by its ID.

Parameters:

pipelineId - The ID of the pipeline to retrieve. (required)

Returns:

ApiResponse<ObservabilityPipeline>

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	-

getPipelineWithHttpInfoAsync

public CompletableFuture<ApiResponse<ObservabilityPipeline>> getPipelineWithHttpInfoAsync(String pipelineId)

Get a specific pipeline.

See getPipelineWithHttpInfo(java.lang.String).

Parameters:

pipelineId - The ID of the pipeline to retrieve. (required)

Returns:

CompletableFuture<ApiResponse<ObservabilityPipeline>>

listPipelines

public ListPipelinesResponse listPipelines()
                                    throws ApiException

List pipelines.

See listPipelinesWithHttpInfo(com.datadog.api.client.v2.api.ObservabilityPipelinesApi.ListPipelinesOptionalParameters).

Returns:

ListPipelinesResponse

Throws:

ApiException - if fails to make API call

listPipelinesAsync

public CompletableFuture<ListPipelinesResponse> listPipelinesAsync()

List pipelines.

See listPipelinesWithHttpInfoAsync(com.datadog.api.client.v2.api.ObservabilityPipelinesApi.ListPipelinesOptionalParameters).

Returns:

CompletableFuture<ListPipelinesResponse>

listPipelines

public ListPipelinesResponse listPipelines(ObservabilityPipelinesApi.ListPipelinesOptionalParameters parameters)
                                    throws ApiException

List pipelines.

See listPipelinesWithHttpInfo(com.datadog.api.client.v2.api.ObservabilityPipelinesApi.ListPipelinesOptionalParameters).

Parameters:

parameters - Optional parameters for the request.

Returns:

ListPipelinesResponse

Throws:

ApiException - if fails to make API call

listPipelinesAsync

public CompletableFuture<ListPipelinesResponse> listPipelinesAsync(ObservabilityPipelinesApi.ListPipelinesOptionalParameters parameters)

List pipelines.

See listPipelinesWithHttpInfoAsync(com.datadog.api.client.v2.api.ObservabilityPipelinesApi.ListPipelinesOptionalParameters).

Parameters:

parameters - Optional parameters for the request.

Returns:

CompletableFuture<ListPipelinesResponse>

listPipelinesWithHttpInfo

public ApiResponse<ListPipelinesResponse> listPipelinesWithHttpInfo(ObservabilityPipelinesApi.ListPipelinesOptionalParameters parameters)
                                                             throws ApiException

Retrieve a list of pipelines.

Parameters:

parameters - Optional parameters for the request.

Returns:

ApiResponse<ListPipelinesResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK	-
400	Bad Request	-
403	Not Authorized	-
429	Too many requests	-

listPipelinesWithHttpInfoAsync

public CompletableFuture<ApiResponse<ListPipelinesResponse>> listPipelinesWithHttpInfoAsync(ObservabilityPipelinesApi.ListPipelinesOptionalParameters parameters)

List pipelines.

See listPipelinesWithHttpInfo(com.datadog.api.client.v2.api.ObservabilityPipelinesApi.ListPipelinesOptionalParameters).

Parameters:

parameters - Optional parameters for the request.

Returns:

CompletableFuture<ApiResponse<ListPipelinesResponse>>

updatePipeline

public ObservabilityPipeline updatePipeline(String pipelineId,
 ObservabilityPipeline body)
                                     throws ApiException

Update a pipeline.

See updatePipelineWithHttpInfo(java.lang.String, com.datadog.api.client.v2.model.ObservabilityPipeline).

Parameters:

pipelineId - The ID of the pipeline to update. (required)

body - (required)

Returns:

ObservabilityPipeline

Throws:

ApiException - if fails to make API call

updatePipelineAsync

public CompletableFuture<ObservabilityPipeline> updatePipelineAsync(String pipelineId,
 ObservabilityPipeline body)

Update a pipeline.

See updatePipelineWithHttpInfoAsync(java.lang.String, com.datadog.api.client.v2.model.ObservabilityPipeline).

Parameters:

pipelineId - The ID of the pipeline to update. (required)

body - (required)

Returns:

CompletableFuture<ObservabilityPipeline>

updatePipelineWithHttpInfo

public ApiResponse<ObservabilityPipeline> updatePipelineWithHttpInfo(String pipelineId,
 ObservabilityPipeline body)
                                                              throws ApiException

Update a pipeline.

Parameters:

pipelineId - The ID of the pipeline to update. (required)

body - (required)

Returns:

ApiResponse<ObservabilityPipeline>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK	-
400	Bad Request	-
403	Not Authorized	-
404	Not Found	-
409	Conflict	-
429	Too many requests	-

updatePipelineWithHttpInfoAsync

public CompletableFuture<ApiResponse<ObservabilityPipeline>> updatePipelineWithHttpInfoAsync(String pipelineId,
 ObservabilityPipeline body)

Update a pipeline.

See updatePipelineWithHttpInfo(java.lang.String, com.datadog.api.client.v2.model.ObservabilityPipeline).

Parameters:

pipelineId - The ID of the pipeline to update. (required)

body - (required)

Returns:

CompletableFuture<ApiResponse<ObservabilityPipeline>>

validatePipeline

public ValidationResponse validatePipeline(ObservabilityPipelineSpec body)
                                    throws ApiException

Validate an observability pipeline.

See validatePipelineWithHttpInfo(com.datadog.api.client.v2.model.ObservabilityPipelineSpec).

Parameters:

body - (required)

Returns:

ValidationResponse

Throws:

ApiException - if fails to make API call

validatePipelineAsync

public CompletableFuture<ValidationResponse> validatePipelineAsync(ObservabilityPipelineSpec body)

Validate an observability pipeline.

See validatePipelineWithHttpInfoAsync(com.datadog.api.client.v2.model.ObservabilityPipelineSpec).

Parameters:

body - (required)

Returns:

CompletableFuture<ValidationResponse>

validatePipelineWithHttpInfo

public ApiResponse<ValidationResponse> validatePipelineWithHttpInfo(ObservabilityPipelineSpec body)
                                                             throws ApiException

Validates a pipeline configuration without creating or updating any resources. Returns a list of validation errors, if any.

Parameters:

body - (required)

Returns:

ApiResponse<ValidationResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK	-
400	Bad Request	-
403	Not Authorized	-
429	Too many requests	-

validatePipelineWithHttpInfoAsync

public CompletableFuture<ApiResponse<ValidationResponse>> validatePipelineWithHttpInfoAsync(ObservabilityPipelineSpec body)

Validate an observability pipeline.

See validatePipelineWithHttpInfo(com.datadog.api.client.v2.model.ObservabilityPipelineSpec).

Parameters:

body - (required)

Returns:

CompletableFuture<ApiResponse<ValidationResponse>>