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

Class ApmTraceApi

java.lang.Object

com.datadog.api.client.v2.api.ApmTraceApi

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ApmTraceApi.GetPrunedTraceByIDOptionalParameters	Manage optional parameters to getPrunedTraceByID.
static class	ApmTraceApi.GetTraceByIDOptionalParameters	Manage optional parameters to getTraceByID.

Constructor Summary

Constructors

Constructor	Description
ApmTraceApi()
ApmTraceApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
ApiClient	getApiClient()	Get the API client.
PrunedTraceResponse	getPrunedTraceByID(String traceId)	Get a pruned trace by ID.
PrunedTraceResponse	getPrunedTraceByID(String traceId, ApmTraceApi.GetPrunedTraceByIDOptionalParameters parameters)	Get a pruned trace by ID.
CompletableFuture<PrunedTraceResponse>	getPrunedTraceByIDAsync(String traceId)	Get a pruned trace by ID.
CompletableFuture<PrunedTraceResponse>	getPrunedTraceByIDAsync(String traceId, ApmTraceApi.GetPrunedTraceByIDOptionalParameters parameters)	Get a pruned trace by ID.
ApiResponse<PrunedTraceResponse>	getPrunedTraceByIDWithHttpInfo(String traceId, ApmTraceApi.GetPrunedTraceByIDOptionalParameters parameters)	Retrieve a pruned, hierarchical view of an APM trace by its trace ID.
CompletableFuture<ApiResponse<PrunedTraceResponse>>	getPrunedTraceByIDWithHttpInfoAsync(String traceId, ApmTraceApi.GetPrunedTraceByIDOptionalParameters parameters)	Get a pruned trace by ID.
TraceResponse	getTraceByID(String traceId)	Get a trace by ID.
TraceResponse	getTraceByID(String traceId, ApmTraceApi.GetTraceByIDOptionalParameters parameters)	Get a trace by ID.
CompletableFuture<TraceResponse>	getTraceByIDAsync(String traceId)	Get a trace by ID.
CompletableFuture<TraceResponse>	getTraceByIDAsync(String traceId, ApmTraceApi.GetTraceByIDOptionalParameters parameters)	Get a trace by ID.
ApiResponse<TraceResponse>	getTraceByIDWithHttpInfo(String traceId, ApmTraceApi.GetTraceByIDOptionalParameters parameters)	Retrieve a full APM trace by its trace ID, including every span in the trace.
CompletableFuture<ApiResponse<TraceResponse>>	getTraceByIDWithHttpInfoAsync(String traceId, ApmTraceApi.GetTraceByIDOptionalParameters parameters)	Get a trace by ID.
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

ApmTraceApi

public ApmTraceApi()

ApmTraceApi

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

getPrunedTraceByID

public PrunedTraceResponse getPrunedTraceByID(String traceId)
                                       throws ApiException

Get a pruned trace by ID.

See getPrunedTraceByIDWithHttpInfo(java.lang.String, com.datadog.api.client.v2.api.ApmTraceApi.GetPrunedTraceByIDOptionalParameters).

Parameters:

traceId - The trace ID. Accepts either a 32-character hexadecimal string (128-bit trace ID) or a decimal string of up to 39 digits. (required)

Returns:

PrunedTraceResponse

Throws:

ApiException - if fails to make API call

getPrunedTraceByIDAsync

public CompletableFuture<PrunedTraceResponse> getPrunedTraceByIDAsync(String traceId)

Get a pruned trace by ID.

See getPrunedTraceByIDWithHttpInfoAsync(java.lang.String, com.datadog.api.client.v2.api.ApmTraceApi.GetPrunedTraceByIDOptionalParameters).

Parameters:

traceId - The trace ID. Accepts either a 32-character hexadecimal string (128-bit trace ID) or a decimal string of up to 39 digits. (required)

Returns:

CompletableFuture<PrunedTraceResponse>

getPrunedTraceByID

public PrunedTraceResponse getPrunedTraceByID(String traceId,
 ApmTraceApi.GetPrunedTraceByIDOptionalParameters parameters)
                                       throws ApiException

Get a pruned trace by ID.

See getPrunedTraceByIDWithHttpInfo(java.lang.String, com.datadog.api.client.v2.api.ApmTraceApi.GetPrunedTraceByIDOptionalParameters).

Parameters:

traceId - The trace ID. Accepts either a 32-character hexadecimal string (128-bit trace ID) or a decimal string of up to 39 digits. (required)

parameters - Optional parameters for the request.

Returns:

PrunedTraceResponse

Throws:

ApiException - if fails to make API call

getPrunedTraceByIDAsync

public CompletableFuture<PrunedTraceResponse> getPrunedTraceByIDAsync(String traceId,
 ApmTraceApi.GetPrunedTraceByIDOptionalParameters parameters)

Get a pruned trace by ID.

See getPrunedTraceByIDWithHttpInfoAsync(java.lang.String, com.datadog.api.client.v2.api.ApmTraceApi.GetPrunedTraceByIDOptionalParameters).

Parameters:

traceId - The trace ID. Accepts either a 32-character hexadecimal string (128-bit trace ID) or a decimal string of up to 39 digits. (required)

parameters - Optional parameters for the request.

Returns:

CompletableFuture<PrunedTraceResponse>

getPrunedTraceByIDWithHttpInfo

public ApiResponse<PrunedTraceResponse> getPrunedTraceByIDWithHttpInfo(String traceId,
 ApmTraceApi.GetPrunedTraceByIDOptionalParameters parameters)
                                                                throws ApiException

Retrieve a pruned, hierarchical view of an APM trace by its trace ID. The trace is summarized as a tree of spans rooted at the trace root and reduced in size to keep rendering large traces in the UI practical. This endpoint is rate limited to 60 requests per minute per organization.

Parameters:

traceId - The trace ID. Accepts either a 32-character hexadecimal string (128-bit trace ID) or a decimal string of up to 39 digits. (required)

parameters - Optional parameters for the request.

Returns:

ApiResponse<PrunedTraceResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK	-
403	Forbidden	-
404	Not Found	-
429	Too many requests	-
504	Gateway Timeout	-

getPrunedTraceByIDWithHttpInfoAsync

public CompletableFuture<ApiResponse<PrunedTraceResponse>> getPrunedTraceByIDWithHttpInfoAsync(String traceId,
 ApmTraceApi.GetPrunedTraceByIDOptionalParameters parameters)

Get a pruned trace by ID.

See getPrunedTraceByIDWithHttpInfo(java.lang.String, com.datadog.api.client.v2.api.ApmTraceApi.GetPrunedTraceByIDOptionalParameters).

Parameters:

traceId - The trace ID. Accepts either a 32-character hexadecimal string (128-bit trace ID) or a decimal string of up to 39 digits. (required)

parameters - Optional parameters for the request.

Returns:

CompletableFuture<ApiResponse<PrunedTraceResponse>>

getTraceByID

public TraceResponse getTraceByID(String traceId)
                           throws ApiException

Get a trace by ID.

See getTraceByIDWithHttpInfo(java.lang.String, com.datadog.api.client.v2.api.ApmTraceApi.GetTraceByIDOptionalParameters).

Parameters:

traceId - The trace ID. Accepts either a 32-character hexadecimal string (128-bit trace ID) or a decimal string of up to 39 digits. (required)

Returns:

TraceResponse

Throws:

ApiException - if fails to make API call

getTraceByIDAsync

public CompletableFuture<TraceResponse> getTraceByIDAsync(String traceId)

Get a trace by ID.

See getTraceByIDWithHttpInfoAsync(java.lang.String, com.datadog.api.client.v2.api.ApmTraceApi.GetTraceByIDOptionalParameters).

Parameters:

traceId - The trace ID. Accepts either a 32-character hexadecimal string (128-bit trace ID) or a decimal string of up to 39 digits. (required)

Returns:

CompletableFuture<TraceResponse>

getTraceByID

public TraceResponse getTraceByID(String traceId,
 ApmTraceApi.GetTraceByIDOptionalParameters parameters)
                           throws ApiException

Get a trace by ID.

See getTraceByIDWithHttpInfo(java.lang.String, com.datadog.api.client.v2.api.ApmTraceApi.GetTraceByIDOptionalParameters).

Parameters:

traceId - The trace ID. Accepts either a 32-character hexadecimal string (128-bit trace ID) or a decimal string of up to 39 digits. (required)

parameters - Optional parameters for the request.

Returns:

TraceResponse

Throws:

ApiException - if fails to make API call

getTraceByIDAsync

public CompletableFuture<TraceResponse> getTraceByIDAsync(String traceId,
 ApmTraceApi.GetTraceByIDOptionalParameters parameters)

Get a trace by ID.

See getTraceByIDWithHttpInfoAsync(java.lang.String, com.datadog.api.client.v2.api.ApmTraceApi.GetTraceByIDOptionalParameters).

Parameters:

traceId - The trace ID. Accepts either a 32-character hexadecimal string (128-bit trace ID) or a decimal string of up to 39 digits. (required)

parameters - Optional parameters for the request.

Returns:

CompletableFuture<TraceResponse>

getTraceByIDWithHttpInfo

public ApiResponse<TraceResponse> getTraceByIDWithHttpInfo(String traceId,
 ApmTraceApi.GetTraceByIDOptionalParameters parameters)
                                                    throws ApiException

Retrieve a full APM trace by its trace ID, including every span in the trace. Traces are returned from live storage when available and fall back to longer-term storage. This endpoint is rate limited to 60 requests per minute per organization.

Parameters:

traceId - The trace ID. Accepts either a 32-character hexadecimal string (128-bit trace ID) or a decimal string of up to 39 digits. (required)

parameters - Optional parameters for the request.

Returns:

ApiResponse<TraceResponse>

Throws:

ApiException - if fails to make API call

Http Response Details:

Response details

Status Code	Description	Response Headers
200	OK	-
403	Forbidden	-
404	Not Found	-
413	Payload Too Large	-
429	Too many requests	-

getTraceByIDWithHttpInfoAsync

public CompletableFuture<ApiResponse<TraceResponse>> getTraceByIDWithHttpInfoAsync(String traceId,
 ApmTraceApi.GetTraceByIDOptionalParameters parameters)

Get a trace by ID.

See getTraceByIDWithHttpInfo(java.lang.String, com.datadog.api.client.v2.api.ApmTraceApi.GetTraceByIDOptionalParameters).

Parameters:

traceId - The trace ID. Accepts either a 32-character hexadecimal string (128-bit trace ID) or a decimal string of up to 39 digits. (required)

parameters - Optional parameters for the request.

Returns:

CompletableFuture<ApiResponse<TraceResponse>>