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

Class SpansApi

java.lang.Object

com.datadog.api.client.v2.api.SpansApi

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SpansApi.ListSpansGetOptionalParameters	Manage optional parameters to listSpansGet.

Constructor Summary

Constructors

Constructor	Description
SpansApi()
SpansApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
SpansAggregateResponse	aggregateSpans(SpansAggregateRequest body)	Aggregate spans.
CompletableFuture<SpansAggregateResponse>	aggregateSpansAsync(SpansAggregateRequest body)	Aggregate spans.
ApiResponse<SpansAggregateResponse>	aggregateSpansWithHttpInfo(SpansAggregateRequest body)	The API endpoint to aggregate spans into buckets and compute metrics and timeseries.
CompletableFuture<ApiResponse<SpansAggregateResponse>>	aggregateSpansWithHttpInfoAsync(SpansAggregateRequest body)	Aggregate spans.
ApiClient	getApiClient()	Get the API client.
SpansListResponse	listSpans(SpansListRequest body)	Search spans.
CompletableFuture<SpansListResponse>	listSpansAsync(SpansListRequest body)	Search spans.
SpansListResponse	listSpansGet()	Get a list of spans.
SpansListResponse	listSpansGet(SpansApi.ListSpansGetOptionalParameters parameters)	Get a list of spans.
CompletableFuture<SpansListResponse>	listSpansGetAsync()	Get a list of spans.
CompletableFuture<SpansListResponse>	listSpansGetAsync(SpansApi.ListSpansGetOptionalParameters parameters)	Get a list of spans.
ApiResponse<SpansListResponse>	listSpansGetWithHttpInfo(SpansApi.ListSpansGetOptionalParameters parameters)	List endpoint returns spans that match a span search query.
CompletableFuture<ApiResponse<SpansListResponse>>	listSpansGetWithHttpInfoAsync(SpansApi.ListSpansGetOptionalParameters parameters)	Get a list of spans.
PaginationIterable<Span>	listSpansGetWithPagination()	Get a list of spans.
PaginationIterable<Span>	listSpansGetWithPagination(SpansApi.ListSpansGetOptionalParameters parameters)	Get a list of spans.
ApiResponse<SpansListResponse>	listSpansWithHttpInfo(SpansListRequest body)	List endpoint returns spans that match a span search query.
CompletableFuture<ApiResponse<SpansListResponse>>	listSpansWithHttpInfoAsync(SpansListRequest body)	Search spans.
PaginationIterable<Span>	listSpansWithPagination(SpansListRequest body)	Search spans.
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 Details

SpansApi

public SpansApi()

SpansApi

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

aggregateSpans

public SpansAggregateResponse aggregateSpans(SpansAggregateRequest body)
                                      throws ApiException

Aggregate spans.

See aggregateSpansWithHttpInfo(com.datadog.api.client.v2.model.SpansAggregateRequest).

Parameters:

body - (required)

Returns:

SpansAggregateResponse

Throws:

ApiException - if fails to make API call

aggregateSpansAsync

public CompletableFuture<SpansAggregateResponse> aggregateSpansAsync(SpansAggregateRequest body)

Aggregate spans.

See aggregateSpansWithHttpInfoAsync(com.datadog.api.client.v2.model.SpansAggregateRequest).

Parameters:

body - (required)

Returns:

CompletableFuture<SpansAggregateResponse>

aggregateSpansWithHttpInfo

public ApiResponse<SpansAggregateResponse> aggregateSpansWithHttpInfo(SpansAggregateRequest body)
                                                               throws ApiException

The API endpoint to aggregate spans into buckets and compute metrics and timeseries. This endpoint is rate limited to 300 requests per hour.

Parameters:

body - (required)

Returns:

ApiResponse<SpansAggregateResponse>

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	-

aggregateSpansWithHttpInfoAsync

public CompletableFuture<ApiResponse<SpansAggregateResponse>> aggregateSpansWithHttpInfoAsync(SpansAggregateRequest body)

Aggregate spans.

See aggregateSpansWithHttpInfo(com.datadog.api.client.v2.model.SpansAggregateRequest).

Parameters:

body - (required)

Returns:

CompletableFuture<ApiResponse<SpansAggregateResponse>>

listSpans

public SpansListResponse listSpans(SpansListRequest body)
                            throws ApiException

Search spans.

See listSpansWithHttpInfo(com.datadog.api.client.v2.model.SpansListRequest).

Parameters:

body - (required)

Returns:

SpansListResponse

Throws:

ApiException - if fails to make API call

listSpansAsync

public CompletableFuture<SpansListResponse> listSpansAsync(SpansListRequest body)

Search spans.

See listSpansWithHttpInfoAsync(com.datadog.api.client.v2.model.SpansListRequest).

Parameters:

body - (required)

Returns:

CompletableFuture<SpansListResponse>

listSpansWithPagination

public PaginationIterable<Span> listSpansWithPagination(SpansListRequest body)

Search spans.

See listSpansWithHttpInfo(com.datadog.api.client.v2.model.SpansListRequest).

Parameters:

body - (required)

Returns:

PaginationIterable<Span>

listSpansWithHttpInfo

public ApiResponse<SpansListResponse> listSpansWithHttpInfo(SpansListRequest body)
                                                     throws ApiException

List endpoint returns spans that match a span search query. Results are paginated.

Use this endpoint to build complex spans filtering and search. This endpoint is rate limited to 300 requests per hour.

Parameters:

body - (required)

Returns:

ApiResponse<SpansListResponse>

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: Access denied.	-
422	Unprocessable Entity.	-
429	Too many requests: The rate limit set by the API has been exceeded.	-

listSpansWithHttpInfoAsync

public CompletableFuture<ApiResponse<SpansListResponse>> listSpansWithHttpInfoAsync(SpansListRequest body)

Search spans.

See listSpansWithHttpInfo(com.datadog.api.client.v2.model.SpansListRequest).

Parameters:

body - (required)

Returns:

CompletableFuture<ApiResponse<SpansListResponse>>

listSpansGet

public SpansListResponse listSpansGet()
                               throws ApiException

Get a list of spans.

See listSpansGetWithHttpInfo(com.datadog.api.client.v2.api.SpansApi.ListSpansGetOptionalParameters).

Returns:

SpansListResponse

Throws:

ApiException - if fails to make API call

listSpansGetAsync

public CompletableFuture<SpansListResponse> listSpansGetAsync()

Get a list of spans.

See listSpansGetWithHttpInfoAsync(com.datadog.api.client.v2.api.SpansApi.ListSpansGetOptionalParameters).

Returns:

CompletableFuture<SpansListResponse>

listSpansGet

public SpansListResponse listSpansGet(SpansApi.ListSpansGetOptionalParameters parameters)
                               throws ApiException

Get a list of spans.

See listSpansGetWithHttpInfo(com.datadog.api.client.v2.api.SpansApi.ListSpansGetOptionalParameters).

Parameters:

parameters - Optional parameters for the request.

Returns:

SpansListResponse

Throws:

ApiException - if fails to make API call

listSpansGetAsync

public CompletableFuture<SpansListResponse> listSpansGetAsync(SpansApi.ListSpansGetOptionalParameters parameters)

Get a list of spans.

See listSpansGetWithHttpInfoAsync(com.datadog.api.client.v2.api.SpansApi.ListSpansGetOptionalParameters).

Parameters:

parameters - Optional parameters for the request.

Returns:

CompletableFuture<SpansListResponse>

listSpansGetWithPagination

public PaginationIterable<Span> listSpansGetWithPagination()

Get a list of spans.

See listSpansGetWithHttpInfo(com.datadog.api.client.v2.api.SpansApi.ListSpansGetOptionalParameters).

Returns:

PaginationIterable<Span>

listSpansGetWithPagination

public PaginationIterable<Span> listSpansGetWithPagination(SpansApi.ListSpansGetOptionalParameters parameters)

Get a list of spans.

See listSpansGetWithHttpInfo(com.datadog.api.client.v2.api.SpansApi.ListSpansGetOptionalParameters).

Returns:

SpansListResponse

listSpansGetWithHttpInfo

public ApiResponse<SpansListResponse> listSpansGetWithHttpInfo(SpansApi.ListSpansGetOptionalParameters parameters)
                                                        throws ApiException

List endpoint returns spans that match a span search query. Results are paginated.

Use this endpoint to see your latest spans. This endpoint is rate limited to 300 requests per hour.

Parameters:

parameters - Optional parameters for the request.

Returns:

ApiResponse<SpansListResponse>

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: Access denied.	-
422	Unprocessable Entity.	-
429	Too many requests: The rate limit set by the API has been exceeded.	-

listSpansGetWithHttpInfoAsync

public CompletableFuture<ApiResponse<SpansListResponse>> listSpansGetWithHttpInfoAsync(SpansApi.ListSpansGetOptionalParameters parameters)

Get a list of spans.

See listSpansGetWithHttpInfo(com.datadog.api.client.v2.api.SpansApi.ListSpansGetOptionalParameters).

Parameters:

parameters - Optional parameters for the request.

Returns:

CompletableFuture<ApiResponse<SpansListResponse>>