com.amazonaws.services.xray

Class AWSXRayAsyncClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.xray.AWSXRayClient

com.amazonaws.services.xray.AWSXRayAsyncClient

All Implemented Interfaces:

AWSXRay, AWSXRayAsync

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AWSXRayAsyncClient
extends AWSXRayClient
implements AWSXRayAsync

Client for accessing AWS X-Ray asynchronously. Each asynchronous method will return a Java Future object representing the asynchronous operation; overloads which accept an AsyncHandler can be used to receive notification when an asynchronous operation completes.

AWS X-Ray provides APIs for managing debug traces and retrieving service maps and other data created by processing those traces.

Field Summary

Fields inherited from class com.amazonaws.services.xray.AWSXRayClient

configFactory

Fields inherited from class com.amazonaws.AmazonWebServiceClient

client, clientConfiguration, endpoint, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset

Fields inherited from interface com.amazonaws.services.xray.AWSXRay

ENDPOINT_PREFIX

Constructor Summary

Constructors

Constructor and Description
AWSXRayAsyncClient() Deprecated. use AWSXRayAsyncClientBuilder.defaultClient()
AWSXRayAsyncClient(AWSCredentials awsCredentials) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider)
AWSXRayAsyncClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration, ExecutorService executorService) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration) and AwsAsyncClientBuilder.withExecutorFactory(com.amazonaws.client.builder.ExecutorFactory)
AWSXRayAsyncClient(AWSCredentials awsCredentials, ExecutorService executorService) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsAsyncClientBuilder.withExecutorFactory(com.amazonaws.client.builder.ExecutorFactory)
AWSXRayAsyncClient(AWSCredentialsProvider awsCredentialsProvider) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider)
AWSXRayAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration)
AWSXRayAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, ExecutorService executorService) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration) and AwsAsyncClientBuilder.withExecutorFactory(com.amazonaws.client.builder.ExecutorFactory)
AWSXRayAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ExecutorService executorService) Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsAsyncClientBuilder.withExecutorFactory(com.amazonaws.client.builder.ExecutorFactory)
AWSXRayAsyncClient(ClientConfiguration clientConfiguration) Deprecated. use AwsClientBuilder.withClientConfiguration(ClientConfiguration)

Method Summary

Modifier and Type	Method and Description
static AWSXRayAsyncClientBuilder	asyncBuilder()
Future<BatchGetTracesResult>	batchGetTracesAsync(BatchGetTracesRequest request) Retrieves a list of traces specified by ID.
Future<BatchGetTracesResult>	batchGetTracesAsync(BatchGetTracesRequest request, AsyncHandler<BatchGetTracesRequest,BatchGetTracesResult> asyncHandler) Retrieves a list of traces specified by ID.
ExecutorService	getExecutorService() Returns the executor service used by this client to execute async requests.
Future<GetServiceGraphResult>	getServiceGraphAsync(GetServiceGraphRequest request) Retrieves a document that describes services that process incoming requests, and downstream services that they call as a result.
Future<GetServiceGraphResult>	getServiceGraphAsync(GetServiceGraphRequest request, AsyncHandler<GetServiceGraphRequest,GetServiceGraphResult> asyncHandler) Retrieves a document that describes services that process incoming requests, and downstream services that they call as a result.
Future<GetTraceGraphResult>	getTraceGraphAsync(GetTraceGraphRequest request) Retrieves a service graph for one or more specific trace IDs.
Future<GetTraceGraphResult>	getTraceGraphAsync(GetTraceGraphRequest request, AsyncHandler<GetTraceGraphRequest,GetTraceGraphResult> asyncHandler) Retrieves a service graph for one or more specific trace IDs.
Future<GetTraceSummariesResult>	getTraceSummariesAsync(GetTraceSummariesRequest request) Retrieves IDs and metadata for traces available for a specified time frame using an optional filter.
Future<GetTraceSummariesResult>	getTraceSummariesAsync(GetTraceSummariesRequest request, AsyncHandler<GetTraceSummariesRequest,GetTraceSummariesResult> asyncHandler) Retrieves IDs and metadata for traces available for a specified time frame using an optional filter.
Future<PutTelemetryRecordsResult>	putTelemetryRecordsAsync(PutTelemetryRecordsRequest request) Used by the AWS X-Ray daemon to upload telemetry.
Future<PutTelemetryRecordsResult>	putTelemetryRecordsAsync(PutTelemetryRecordsRequest request, AsyncHandler<PutTelemetryRecordsRequest,PutTelemetryRecordsResult> asyncHandler) Used by the AWS X-Ray daemon to upload telemetry.
Future<PutTraceSegmentsResult>	putTraceSegmentsAsync(PutTraceSegmentsRequest request) Uploads segment documents to AWS X-Ray.
Future<PutTraceSegmentsResult>	putTraceSegmentsAsync(PutTraceSegmentsRequest request, AsyncHandler<PutTraceSegmentsRequest,PutTraceSegmentsResult> asyncHandler) Uploads segment documents to AWS X-Ray.
void	shutdown() Shuts down the client, releasing all managed resources.

Methods inherited from class com.amazonaws.services.xray.AWSXRayClient

batchGetTraces, builder, getCachedResponseMetadata, getServiceGraph, getTraceGraph, getTraceSummaries, putTelemetryRecords, putTraceSegments

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, beforeClientExecution, beforeMarshalling, calculateCRC32FromCompressedData, checkMutability, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, createSignerProvider, endClientExecution, endClientExecution, getEndpointPrefix, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerOverride, getSignerProvider, getSignerRegionOverride, getTimeOffset, isProfilingEnabled, isRequestMetricsEnabled, makeImmutable, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, useStrictHostNameVerification, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.amazonaws.services.xray.AWSXRay

batchGetTraces, getCachedResponseMetadata, getServiceGraph, getTraceGraph, getTraceSummaries, putTelemetryRecords, putTraceSegments, setEndpoint, setRegion

Constructor Detail

AWSXRayAsyncClient

@Deprecated
public AWSXRayAsyncClient()

Deprecated. use AWSXRayAsyncClientBuilder.defaultClient()

Constructs a new asynchronous client to invoke service methods on AWS X-Ray. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Credential profiles file at the default location (~/.aws/credentials) shared by all AWS SDKs and the AWS CLI
• Instance profile credentials delivered through the Amazon EC2 metadata service

Asynchronous methods are delegated to a fixed-size thread pool containing 50 threads (to match the default maximum number of concurrent connections to the service).

See Also:

DefaultAWSCredentialsProviderChain, Executors.newFixedThreadPool(int)

AWSXRayAsyncClient

@Deprecated
public AWSXRayAsyncClient(ClientConfiguration clientConfiguration)

Deprecated. use AwsClientBuilder.withClientConfiguration(ClientConfiguration)

Constructs a new asynchronous client to invoke service methods on AWS X-Ray. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Credential profiles file at the default location (~/.aws/credentials) shared by all AWS SDKs and the AWS CLI
• Instance profile credentials delivered through the Amazon EC2 metadata service

Asynchronous methods are delegated to a fixed-size thread pool containing a number of threads equal to the maximum number of concurrent connections configured via ClientConfiguration.getMaxConnections().

Parameters:

clientConfiguration - The client configuration options controlling how this client connects to AWS X-Ray (ex: proxy settings, retry counts, etc).

See Also:

DefaultAWSCredentialsProviderChain, Executors.newFixedThreadPool(int)

AWSXRayAsyncClient

@Deprecated
public AWSXRayAsyncClient(AWSCredentials awsCredentials)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider)

Constructs a new asynchronous client to invoke service methods on AWS X-Ray using the specified AWS account credentials.

Asynchronous methods are delegated to a fixed-size thread pool containing 50 threads (to match the default maximum number of concurrent connections to the service).

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

See Also:

Executors.newFixedThreadPool(int)

AWSXRayAsyncClient

@Deprecated
public AWSXRayAsyncClient(AWSCredentials awsCredentials,
                                      ExecutorService executorService)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsAsyncClientBuilder.withExecutorFactory(com.amazonaws.client.builder.ExecutorFactory)

Constructs a new asynchronous client to invoke service methods on AWS X-Ray using the specified AWS account credentials and executor service. Default client settings will be used.

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

executorService - The executor service by which all asynchronous requests will be executed.

AWSXRayAsyncClient

@Deprecated
public AWSXRayAsyncClient(AWSCredentials awsCredentials,
                                      ClientConfiguration clientConfiguration,
                                      ExecutorService executorService)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration) and AwsAsyncClientBuilder.withExecutorFactory(com.amazonaws.client.builder.ExecutorFactory)

Constructs a new asynchronous client to invoke service methods on AWS X-Ray using the specified AWS account credentials, executor service, and client configuration options.

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

clientConfiguration - Client configuration options (ex: max retry limit, proxy settings, etc).

executorService - The executor service by which all asynchronous requests will be executed.

AWSXRayAsyncClient

@Deprecated
public AWSXRayAsyncClient(AWSCredentialsProvider awsCredentialsProvider)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider)

Constructs a new asynchronous client to invoke service methods on AWS X-Ray using the specified AWS account credentials provider. Default client settings will be used.

Asynchronous methods are delegated to a fixed-size thread pool containing 50 threads (to match the default maximum number of concurrent connections to the service).

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

See Also:

Executors.newFixedThreadPool(int)

AWSXRayAsyncClient

@Deprecated
public AWSXRayAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
                                      ClientConfiguration clientConfiguration)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration)

Constructs a new asynchronous client to invoke service methods on AWS X-Ray using the provided AWS account credentials provider and client configuration options.

Asynchronous methods are delegated to a fixed-size thread pool containing a number of threads equal to the maximum number of concurrent connections configured via ClientConfiguration.getMaxConnections().

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

clientConfiguration - Client configuration options (ex: max retry limit, proxy settings, etc).

See Also:

DefaultAWSCredentialsProviderChain, Executors.newFixedThreadPool(int)

AWSXRayAsyncClient

@Deprecated
public AWSXRayAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
                                      ExecutorService executorService)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsAsyncClientBuilder.withExecutorFactory(com.amazonaws.client.builder.ExecutorFactory)

Constructs a new asynchronous client to invoke service methods on AWS X-Ray using the specified AWS account credentials provider and executor service. Default client settings will be used.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

executorService - The executor service by which all asynchronous requests will be executed.

AWSXRayAsyncClient

@Deprecated
public AWSXRayAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
                                      ClientConfiguration clientConfiguration,
                                      ExecutorService executorService)

Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration) and AwsAsyncClientBuilder.withExecutorFactory(com.amazonaws.client.builder.ExecutorFactory)

Constructs a new asynchronous client to invoke service methods on AWS X-Ray using the specified AWS account credentials provider, executor service, and client configuration options.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

clientConfiguration - Client configuration options (ex: max retry limit, proxy settings, etc).

executorService - The executor service by which all asynchronous requests will be executed.

Method Detail

asyncBuilder

public static AWSXRayAsyncClientBuilder asyncBuilder()

getExecutorService

public ExecutorService getExecutorService()

Returns the executor service used by this client to execute async requests.

Returns:

The executor service used by this client to execute async requests.

batchGetTracesAsync

public Future<BatchGetTracesResult> batchGetTracesAsync(BatchGetTracesRequest request)

Description copied from interface: AWSXRayAsync

Retrieves a list of traces specified by ID. Each trace is a collection of segment documents that originates from a single request. Use GetTraceSummaries to get a list of trace IDs.

Specified by:

batchGetTracesAsync in interface AWSXRayAsync

Returns:

A Java Future containing the result of the BatchGetTraces operation returned by the service.

See Also:

AWS API Documentation

batchGetTracesAsync

public Future<BatchGetTracesResult> batchGetTracesAsync(BatchGetTracesRequest request,
                                                        AsyncHandler<BatchGetTracesRequest,BatchGetTracesResult> asyncHandler)

Description copied from interface: AWSXRayAsync

Retrieves a list of traces specified by ID. Each trace is a collection of segment documents that originates from a single request. Use GetTraceSummaries to get a list of trace IDs.

Specified by:

batchGetTracesAsync in interface AWSXRayAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the BatchGetTraces operation returned by the service.

See Also:

AWS API Documentation

getServiceGraphAsync

public Future<GetServiceGraphResult> getServiceGraphAsync(GetServiceGraphRequest request)

Description copied from interface: AWSXRayAsync

Retrieves a document that describes services that process incoming requests, and downstream services that they call as a result. Root services process incoming requests and make calls to downstream services. Root services are applications that use the AWS X-Ray SDK. Downstream services can be other applications, AWS resources, HTTP web APIs, or SQL databases.

Specified by:

getServiceGraphAsync in interface AWSXRayAsync

Returns:

A Java Future containing the result of the GetServiceGraph operation returned by the service.

See Also:

AWS API Documentation

getServiceGraphAsync

public Future<GetServiceGraphResult> getServiceGraphAsync(GetServiceGraphRequest request,
                                                          AsyncHandler<GetServiceGraphRequest,GetServiceGraphResult> asyncHandler)

Description copied from interface: AWSXRayAsync

Retrieves a document that describes services that process incoming requests, and downstream services that they call as a result. Root services process incoming requests and make calls to downstream services. Root services are applications that use the AWS X-Ray SDK. Downstream services can be other applications, AWS resources, HTTP web APIs, or SQL databases.

Specified by:

getServiceGraphAsync in interface AWSXRayAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the GetServiceGraph operation returned by the service.

See Also:

AWS API Documentation

getTraceGraphAsync

public Future<GetTraceGraphResult> getTraceGraphAsync(GetTraceGraphRequest request)

Description copied from interface: AWSXRayAsync

Retrieves a service graph for one or more specific trace IDs.

Specified by:

getTraceGraphAsync in interface AWSXRayAsync

Returns:

A Java Future containing the result of the GetTraceGraph operation returned by the service.

See Also:

AWS API Documentation

getTraceGraphAsync

public Future<GetTraceGraphResult> getTraceGraphAsync(GetTraceGraphRequest request,
                                                      AsyncHandler<GetTraceGraphRequest,GetTraceGraphResult> asyncHandler)

Description copied from interface: AWSXRayAsync

Retrieves a service graph for one or more specific trace IDs.

Specified by:

getTraceGraphAsync in interface AWSXRayAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the GetTraceGraph operation returned by the service.

See Also:

AWS API Documentation

getTraceSummariesAsync

public Future<GetTraceSummariesResult> getTraceSummariesAsync(GetTraceSummariesRequest request)

Description copied from interface: AWSXRayAsync

Retrieves IDs and metadata for traces available for a specified time frame using an optional filter. To get the full traces, pass the trace IDs to BatchGetTraces.

Specified by:

getTraceSummariesAsync in interface AWSXRayAsync

Returns:

A Java Future containing the result of the GetTraceSummaries operation returned by the service.

See Also:

AWS API Documentation

getTraceSummariesAsync

public Future<GetTraceSummariesResult> getTraceSummariesAsync(GetTraceSummariesRequest request,
                                                              AsyncHandler<GetTraceSummariesRequest,GetTraceSummariesResult> asyncHandler)

Description copied from interface: AWSXRayAsync

Retrieves IDs and metadata for traces available for a specified time frame using an optional filter. To get the full traces, pass the trace IDs to BatchGetTraces.

Specified by:

getTraceSummariesAsync in interface AWSXRayAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the GetTraceSummaries operation returned by the service.

See Also:

AWS API Documentation

putTelemetryRecordsAsync

public Future<PutTelemetryRecordsResult> putTelemetryRecordsAsync(PutTelemetryRecordsRequest request)

Description copied from interface: AWSXRayAsync

Used by the AWS X-Ray daemon to upload telemetry.

Specified by:

putTelemetryRecordsAsync in interface AWSXRayAsync

Returns:

A Java Future containing the result of the PutTelemetryRecords operation returned by the service.

See Also:

AWS API Documentation

putTelemetryRecordsAsync

public Future<PutTelemetryRecordsResult> putTelemetryRecordsAsync(PutTelemetryRecordsRequest request,
                                                                  AsyncHandler<PutTelemetryRecordsRequest,PutTelemetryRecordsResult> asyncHandler)

Description copied from interface: AWSXRayAsync

Used by the AWS X-Ray daemon to upload telemetry.

Specified by:

putTelemetryRecordsAsync in interface AWSXRayAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the PutTelemetryRecords operation returned by the service.

See Also:

AWS API Documentation

putTraceSegmentsAsync

public Future<PutTraceSegmentsResult> putTraceSegmentsAsync(PutTraceSegmentsRequest request)

Description copied from interface: AWSXRayAsync

Uploads segment documents to AWS X-Ray. The X-Ray SDK generates segment documents and sends them to the X-Ray daemon, which uploads them in batches. A segment document can be a completed segment, an in-progress segment, or an array of subsegments.

Specified by:

putTraceSegmentsAsync in interface AWSXRayAsync

Returns:

A Java Future containing the result of the PutTraceSegments operation returned by the service.

See Also:

AWS API Documentation

putTraceSegmentsAsync

public Future<PutTraceSegmentsResult> putTraceSegmentsAsync(PutTraceSegmentsRequest request,
                                                            AsyncHandler<PutTraceSegmentsRequest,PutTraceSegmentsResult> asyncHandler)

Description copied from interface: AWSXRayAsync

Uploads segment documents to AWS X-Ray. The X-Ray SDK generates segment documents and sends them to the X-Ray daemon, which uploads them in batches. A segment document can be a completed segment, an in-progress segment, or an array of subsegments.

Specified by:

putTraceSegmentsAsync in interface AWSXRayAsync

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the PutTraceSegments operation returned by the service.

See Also:

AWS API Documentation

shutdown

public void shutdown()

Shuts down the client, releasing all managed resources. This includes forcibly terminating all pending asynchronous service calls. Clients who wish to give pending asynchronous service calls time to complete should call getExecutorService().shutdown() followed by getExecutorService().awaitTermination() prior to calling this method.

Specified by:

shutdown in interface AWSXRay

Overrides:

shutdown in class AmazonWebServiceClient