com.datadog.api.client.v2.api

Class CiVisibilityPipelinesApi

java.lang.Object

com.datadog.api.client.v2.api.CiVisibilityPipelinesApi

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CiVisibilityPipelinesApi.ListCIAppPipelineEventsOptionalParameters Manage optional parameters to listCIAppPipelineEvents.
static class	CiVisibilityPipelinesApi.SearchCIAppPipelineEventsOptionalParameters Manage optional parameters to searchCIAppPipelineEvents.

Constructor Summary

Constructors

Constructor and Description
CiVisibilityPipelinesApi()
CiVisibilityPipelinesApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
CIAppPipelinesAnalyticsAggregateResponse	aggregateCIAppPipelineEvents(CIAppPipelinesAggregateRequest body) Aggregate pipelines events.
CompletableFuture<CIAppPipelinesAnalyticsAggregateResponse>	aggregateCIAppPipelineEventsAsync(CIAppPipelinesAggregateRequest body) Aggregate pipelines events.
ApiResponse<CIAppPipelinesAnalyticsAggregateResponse>	aggregateCIAppPipelineEventsWithHttpInfo(CIAppPipelinesAggregateRequest body) Use this API endpoint to aggregate CI Visibility pipeline events into buckets of computed metrics and timeseries.
CompletableFuture<ApiResponse<CIAppPipelinesAnalyticsAggregateResponse>>	aggregateCIAppPipelineEventsWithHttpInfoAsync(CIAppPipelinesAggregateRequest body) Aggregate pipelines events.
Object	createCIAppPipelineEvent(CIAppCreatePipelineEventRequest body) Send pipeline event.
CompletableFuture<Object>	createCIAppPipelineEventAsync(CIAppCreatePipelineEventRequest body) Send pipeline event.
ApiResponse<Object>	createCIAppPipelineEventWithHttpInfo(CIAppCreatePipelineEventRequest body) Send your pipeline event to your Datadog platform over HTTP.
CompletableFuture<ApiResponse<Object>>	createCIAppPipelineEventWithHttpInfoAsync(CIAppCreatePipelineEventRequest body) Send pipeline event.
ApiClient	getApiClient() Get the API client.
CIAppPipelineEventsResponse	listCIAppPipelineEvents() Get a list of pipelines events.
CIAppPipelineEventsResponse	listCIAppPipelineEvents(CiVisibilityPipelinesApi.ListCIAppPipelineEventsOptionalParameters parameters) Get a list of pipelines events.
CompletableFuture<CIAppPipelineEventsResponse>	listCIAppPipelineEventsAsync() Get a list of pipelines events.
CompletableFuture<CIAppPipelineEventsResponse>	listCIAppPipelineEventsAsync(CiVisibilityPipelinesApi.ListCIAppPipelineEventsOptionalParameters parameters) Get a list of pipelines events.
ApiResponse<CIAppPipelineEventsResponse>	listCIAppPipelineEventsWithHttpInfo(CiVisibilityPipelinesApi.ListCIAppPipelineEventsOptionalParameters parameters) List endpoint returns CI Visibility pipeline events that match a search query.
CompletableFuture<ApiResponse<CIAppPipelineEventsResponse>>	listCIAppPipelineEventsWithHttpInfoAsync(CiVisibilityPipelinesApi.ListCIAppPipelineEventsOptionalParameters parameters) Get a list of pipelines events.
PaginationIterable<CIAppPipelineEvent>	listCIAppPipelineEventsWithPagination() Get a list of pipelines events.
PaginationIterable<CIAppPipelineEvent>	listCIAppPipelineEventsWithPagination(CiVisibilityPipelinesApi.ListCIAppPipelineEventsOptionalParameters parameters) Get a list of pipelines events.
CIAppPipelineEventsResponse	searchCIAppPipelineEvents() Search pipelines events.
CIAppPipelineEventsResponse	searchCIAppPipelineEvents(CiVisibilityPipelinesApi.SearchCIAppPipelineEventsOptionalParameters parameters) Search pipelines events.
CompletableFuture<CIAppPipelineEventsResponse>	searchCIAppPipelineEventsAsync() Search pipelines events.
CompletableFuture<CIAppPipelineEventsResponse>	searchCIAppPipelineEventsAsync(CiVisibilityPipelinesApi.SearchCIAppPipelineEventsOptionalParameters parameters) Search pipelines events.
ApiResponse<CIAppPipelineEventsResponse>	searchCIAppPipelineEventsWithHttpInfo(CiVisibilityPipelinesApi.SearchCIAppPipelineEventsOptionalParameters parameters) List endpoint returns CI Visibility pipeline events that match a search query.
CompletableFuture<ApiResponse<CIAppPipelineEventsResponse>>	searchCIAppPipelineEventsWithHttpInfoAsync(CiVisibilityPipelinesApi.SearchCIAppPipelineEventsOptionalParameters parameters) Search pipelines events.
PaginationIterable<CIAppPipelineEvent>	searchCIAppPipelineEventsWithPagination() Search pipelines events.
PaginationIterable<CIAppPipelineEvent>	searchCIAppPipelineEventsWithPagination(CiVisibilityPipelinesApi.SearchCIAppPipelineEventsOptionalParameters parameters) Search pipelines events.
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

CiVisibilityPipelinesApi

public CiVisibilityPipelinesApi()

CiVisibilityPipelinesApi

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

aggregateCIAppPipelineEvents

public CIAppPipelinesAnalyticsAggregateResponse aggregateCIAppPipelineEvents(CIAppPipelinesAggregateRequest body)
                                                                      throws ApiException

Aggregate pipelines events.

See aggregateCIAppPipelineEventsWithHttpInfo(com.datadog.api.client.v2.model.CIAppPipelinesAggregateRequest).

Parameters:

body - (required)

Returns:

CIAppPipelinesAnalyticsAggregateResponse

Throws:

ApiException - if fails to make API call

aggregateCIAppPipelineEventsAsync

public CompletableFuture<CIAppPipelinesAnalyticsAggregateResponse> aggregateCIAppPipelineEventsAsync(CIAppPipelinesAggregateRequest body)

Aggregate pipelines events.

See aggregateCIAppPipelineEventsWithHttpInfoAsync(com.datadog.api.client.v2.model.CIAppPipelinesAggregateRequest).

Parameters:

body - (required)

Returns:

CompletableFuture<CIAppPipelinesAnalyticsAggregateResponse>

aggregateCIAppPipelineEventsWithHttpInfo

public ApiResponse<CIAppPipelinesAnalyticsAggregateResponse> aggregateCIAppPipelineEventsWithHttpInfo(CIAppPipelinesAggregateRequest body)
                                                                                               throws ApiException

Use this API endpoint to aggregate CI Visibility pipeline events into buckets of computed metrics and timeseries.

Parameters:

body - (required)

Returns:

ApiResponse<CIAppPipelinesAnalyticsAggregateResponse>

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	-

aggregateCIAppPipelineEventsWithHttpInfoAsync

public CompletableFuture<ApiResponse<CIAppPipelinesAnalyticsAggregateResponse>> aggregateCIAppPipelineEventsWithHttpInfoAsync(CIAppPipelinesAggregateRequest body)

Aggregate pipelines events.

See aggregateCIAppPipelineEventsWithHttpInfo(com.datadog.api.client.v2.model.CIAppPipelinesAggregateRequest).

Parameters:

body - (required)

Returns:

CompletableFuture<ApiResponse<CIAppPipelinesAnalyticsAggregateResponse>>

createCIAppPipelineEvent

public Object createCIAppPipelineEvent(CIAppCreatePipelineEventRequest body)
                                throws ApiException

Send pipeline event.

See createCIAppPipelineEventWithHttpInfo(com.datadog.api.client.v2.model.CIAppCreatePipelineEventRequest).

Parameters:

body - (required)

Returns:

Object

Throws:

ApiException - if fails to make API call

createCIAppPipelineEventAsync

public CompletableFuture<Object> createCIAppPipelineEventAsync(CIAppCreatePipelineEventRequest body)

Send pipeline event.

See createCIAppPipelineEventWithHttpInfoAsync(com.datadog.api.client.v2.model.CIAppCreatePipelineEventRequest).

Parameters:

body - (required)

Returns:

CompletableFuture<Object>

createCIAppPipelineEventWithHttpInfo

public ApiResponse<Object> createCIAppPipelineEventWithHttpInfo(CIAppCreatePipelineEventRequest body)
                                                         throws ApiException

Send your pipeline event to your Datadog platform over HTTP. For details about how pipeline executions are modeled and what execution types we support, see Pipeline Data Model And Execution Types.

Pipeline events can be submitted with a timestamp that is up to 18 hours in the past.

Parameters:

body - (required)

Returns:

ApiResponse<Object>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
202	Request accepted for processing	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
408	Request Timeout	-
413	Payload Too Large	-
429	Too Many Requests	-
500	Internal Server Error	-
503	Service Unavailable	-

createCIAppPipelineEventWithHttpInfoAsync

public CompletableFuture<ApiResponse<Object>> createCIAppPipelineEventWithHttpInfoAsync(CIAppCreatePipelineEventRequest body)

Send pipeline event.

See createCIAppPipelineEventWithHttpInfo(com.datadog.api.client.v2.model.CIAppCreatePipelineEventRequest).

Parameters:

body - (required)

Returns:

CompletableFuture<ApiResponse<Object>>

listCIAppPipelineEvents

public CIAppPipelineEventsResponse listCIAppPipelineEvents()
                                                    throws ApiException

Get a list of pipelines events.

See listCIAppPipelineEventsWithHttpInfo(com.datadog.api.client.v2.api.CiVisibilityPipelinesApi.ListCIAppPipelineEventsOptionalParameters).

Returns:

CIAppPipelineEventsResponse

Throws:

ApiException - if fails to make API call

listCIAppPipelineEventsAsync

public CompletableFuture<CIAppPipelineEventsResponse> listCIAppPipelineEventsAsync()

Get a list of pipelines events.

See listCIAppPipelineEventsWithHttpInfoAsync(com.datadog.api.client.v2.api.CiVisibilityPipelinesApi.ListCIAppPipelineEventsOptionalParameters).

Returns:

CompletableFuture<CIAppPipelineEventsResponse>

listCIAppPipelineEvents

public CIAppPipelineEventsResponse listCIAppPipelineEvents(CiVisibilityPipelinesApi.ListCIAppPipelineEventsOptionalParameters parameters)
                                                    throws ApiException

Get a list of pipelines events.

See listCIAppPipelineEventsWithHttpInfo(com.datadog.api.client.v2.api.CiVisibilityPipelinesApi.ListCIAppPipelineEventsOptionalParameters).

Parameters:

parameters - Optional parameters for the request.

Returns:

CIAppPipelineEventsResponse

Throws:

ApiException - if fails to make API call

listCIAppPipelineEventsAsync

public CompletableFuture<CIAppPipelineEventsResponse> listCIAppPipelineEventsAsync(CiVisibilityPipelinesApi.ListCIAppPipelineEventsOptionalParameters parameters)

Get a list of pipelines events.

See listCIAppPipelineEventsWithHttpInfoAsync(com.datadog.api.client.v2.api.CiVisibilityPipelinesApi.ListCIAppPipelineEventsOptionalParameters).

Parameters:

parameters - Optional parameters for the request.

Returns:

CompletableFuture<CIAppPipelineEventsResponse>

listCIAppPipelineEventsWithPagination

public PaginationIterable<CIAppPipelineEvent> listCIAppPipelineEventsWithPagination()

Get a list of pipelines events.

See listCIAppPipelineEventsWithHttpInfo(com.datadog.api.client.v2.api.CiVisibilityPipelinesApi.ListCIAppPipelineEventsOptionalParameters).

Returns:

PaginationIterable<CIAppPipelineEvent>

listCIAppPipelineEventsWithPagination

public PaginationIterable<CIAppPipelineEvent> listCIAppPipelineEventsWithPagination(CiVisibilityPipelinesApi.ListCIAppPipelineEventsOptionalParameters parameters)

Get a list of pipelines events.

See listCIAppPipelineEventsWithHttpInfo(com.datadog.api.client.v2.api.CiVisibilityPipelinesApi.ListCIAppPipelineEventsOptionalParameters).

Returns:

CIAppPipelineEventsResponse

listCIAppPipelineEventsWithHttpInfo

public ApiResponse<CIAppPipelineEventsResponse> listCIAppPipelineEventsWithHttpInfo(CiVisibilityPipelinesApi.ListCIAppPipelineEventsOptionalParameters parameters)
                                                                             throws ApiException

List endpoint returns CI Visibility pipeline events that match a search query. Results are paginated similarly to logs.

Use this endpoint to see your latest pipeline events.

Parameters:

parameters - Optional parameters for the request.

Returns:

ApiResponse<CIAppPipelineEventsResponse>

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	-

listCIAppPipelineEventsWithHttpInfoAsync

public CompletableFuture<ApiResponse<CIAppPipelineEventsResponse>> listCIAppPipelineEventsWithHttpInfoAsync(CiVisibilityPipelinesApi.ListCIAppPipelineEventsOptionalParameters parameters)

Get a list of pipelines events.

See listCIAppPipelineEventsWithHttpInfo(com.datadog.api.client.v2.api.CiVisibilityPipelinesApi.ListCIAppPipelineEventsOptionalParameters).

Parameters:

parameters - Optional parameters for the request.

Returns:

CompletableFuture<ApiResponse<CIAppPipelineEventsResponse>>

searchCIAppPipelineEvents

public CIAppPipelineEventsResponse searchCIAppPipelineEvents()
                                                      throws ApiException

Search pipelines events.

See searchCIAppPipelineEventsWithHttpInfo(com.datadog.api.client.v2.api.CiVisibilityPipelinesApi.SearchCIAppPipelineEventsOptionalParameters).

Returns:

CIAppPipelineEventsResponse

Throws:

ApiException - if fails to make API call

searchCIAppPipelineEventsAsync

public CompletableFuture<CIAppPipelineEventsResponse> searchCIAppPipelineEventsAsync()

Search pipelines events.

See searchCIAppPipelineEventsWithHttpInfoAsync(com.datadog.api.client.v2.api.CiVisibilityPipelinesApi.SearchCIAppPipelineEventsOptionalParameters).

Returns:

CompletableFuture<CIAppPipelineEventsResponse>

searchCIAppPipelineEvents

public CIAppPipelineEventsResponse searchCIAppPipelineEvents(CiVisibilityPipelinesApi.SearchCIAppPipelineEventsOptionalParameters parameters)
                                                      throws ApiException

Search pipelines events.

See searchCIAppPipelineEventsWithHttpInfo(com.datadog.api.client.v2.api.CiVisibilityPipelinesApi.SearchCIAppPipelineEventsOptionalParameters).

Parameters:

parameters - Optional parameters for the request.

Returns:

CIAppPipelineEventsResponse

Throws:

ApiException - if fails to make API call

searchCIAppPipelineEventsAsync

public CompletableFuture<CIAppPipelineEventsResponse> searchCIAppPipelineEventsAsync(CiVisibilityPipelinesApi.SearchCIAppPipelineEventsOptionalParameters parameters)

Search pipelines events.

See searchCIAppPipelineEventsWithHttpInfoAsync(com.datadog.api.client.v2.api.CiVisibilityPipelinesApi.SearchCIAppPipelineEventsOptionalParameters).

Parameters:

parameters - Optional parameters for the request.

Returns:

CompletableFuture<CIAppPipelineEventsResponse>

searchCIAppPipelineEventsWithPagination

public PaginationIterable<CIAppPipelineEvent> searchCIAppPipelineEventsWithPagination()

Search pipelines events.

See searchCIAppPipelineEventsWithHttpInfo(com.datadog.api.client.v2.api.CiVisibilityPipelinesApi.SearchCIAppPipelineEventsOptionalParameters).

Returns:

PaginationIterable<CIAppPipelineEvent>

searchCIAppPipelineEventsWithPagination

public PaginationIterable<CIAppPipelineEvent> searchCIAppPipelineEventsWithPagination(CiVisibilityPipelinesApi.SearchCIAppPipelineEventsOptionalParameters parameters)

Search pipelines events.

See searchCIAppPipelineEventsWithHttpInfo(com.datadog.api.client.v2.api.CiVisibilityPipelinesApi.SearchCIAppPipelineEventsOptionalParameters).

Returns:

CIAppPipelineEventsResponse

searchCIAppPipelineEventsWithHttpInfo

public ApiResponse<CIAppPipelineEventsResponse> searchCIAppPipelineEventsWithHttpInfo(CiVisibilityPipelinesApi.SearchCIAppPipelineEventsOptionalParameters parameters)
                                                                               throws ApiException

List endpoint returns CI Visibility pipeline events that match a search query. Results are paginated similarly to logs.

Use this endpoint to build complex events filtering and search.

Parameters:

parameters - Optional parameters for the request.

Returns:

ApiResponse<CIAppPipelineEventsResponse>

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	-

searchCIAppPipelineEventsWithHttpInfoAsync

public CompletableFuture<ApiResponse<CIAppPipelineEventsResponse>> searchCIAppPipelineEventsWithHttpInfoAsync(CiVisibilityPipelinesApi.SearchCIAppPipelineEventsOptionalParameters parameters)

Search pipelines events.

See searchCIAppPipelineEventsWithHttpInfo(com.datadog.api.client.v2.api.CiVisibilityPipelinesApi.SearchCIAppPipelineEventsOptionalParameters).

Parameters:

parameters - Optional parameters for the request.

Returns:

CompletableFuture<ApiResponse<CIAppPipelineEventsResponse>>