com.amazonaws.services.xray

Class AbstractAWSXRay

java.lang.Object

com.amazonaws.services.xray.AbstractAWSXRay

All Implemented Interfaces:

AWSXRay

Direct Known Subclasses:

AbstractAWSXRayAsync

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AbstractAWSXRay
extends Object
implements AWSXRay

Abstract implementation of AWSXRay. Convenient method forms pass through to the corresponding overload that takes a request object, which throws an UnsupportedOperationException.

Field Summary

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

ENDPOINT_PREFIX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractAWSXRay()

Method Summary

Modifier and Type	Method and Description
BatchGetTracesResult	batchGetTraces(BatchGetTracesRequest request) Retrieves a list of traces specified by ID.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
GetServiceGraphResult	getServiceGraph(GetServiceGraphRequest request) Retrieves a document that describes services that process incoming requests, and downstream services that they call as a result.
GetTraceGraphResult	getTraceGraph(GetTraceGraphRequest request) Retrieves a service graph for one or more specific trace IDs.
GetTraceSummariesResult	getTraceSummaries(GetTraceSummariesRequest request) Retrieves IDs and metadata for traces available for a specified time frame using an optional filter.
PutTelemetryRecordsResult	putTelemetryRecords(PutTelemetryRecordsRequest request) Used by the AWS X-Ray daemon to upload telemetry.
PutTraceSegmentsResult	putTraceSegments(PutTraceSegmentsRequest request) Uploads segment documents to AWS X-Ray.
void	setEndpoint(String endpoint) Overrides the default endpoint for this client ("xray.us-east-1.amazonaws.com").
void	setRegion(Region region) An alternative to AWSXRay.setEndpoint(String), sets the regional endpoint for this client's service calls.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractAWSXRay

protected AbstractAWSXRay()

Method Detail

setEndpoint

public void setEndpoint(String endpoint)

Description copied from interface: AWSXRay

Overrides the default endpoint for this client ("xray.us-east-1.amazonaws.com"). Callers can use this method to control which AWS region they want to work with.

Callers can pass in just the endpoint (ex: "xray.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "xray.us-east-1.amazonaws.com"). If the protocol is not specified here, the default protocol from this client's ClientConfiguration will be used, which by default is HTTPS.

For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID=3912

This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.

Specified by:

setEndpoint in interface AWSXRay

Parameters:

endpoint - The endpoint (ex: "xray.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "xray.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will communicate with.

setRegion

public void setRegion(Region region)

Description copied from interface: AWSXRay

An alternative to AWSXRay.setEndpoint(String), sets the regional endpoint for this client's service calls. Callers can use this method to control which AWS region they want to work with.

By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the ClientConfiguration supplied at construction.

This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.

Specified by:

setRegion in interface AWSXRay

Parameters:

region - The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions) for accessing a given region. Must not be null and must be a region where the service is available.

See Also:

Region.getRegion(com.amazonaws.regions.Regions), Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration), Region.isServiceSupported(String)

batchGetTraces

public BatchGetTracesResult batchGetTraces(BatchGetTracesRequest request)

Description copied from interface: AWSXRay

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:

batchGetTraces in interface AWSXRay

Returns:

Result of the BatchGetTraces operation returned by the service.

See Also:

AWS API Documentation

getServiceGraph

public GetServiceGraphResult getServiceGraph(GetServiceGraphRequest request)

Description copied from interface: AWSXRay

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:

getServiceGraph in interface AWSXRay

Returns:

Result of the GetServiceGraph operation returned by the service.

See Also:

AWS API Documentation

getTraceGraph

public GetTraceGraphResult getTraceGraph(GetTraceGraphRequest request)

Description copied from interface: AWSXRay

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

Specified by:

getTraceGraph in interface AWSXRay

Returns:

Result of the GetTraceGraph operation returned by the service.

See Also:

AWS API Documentation

getTraceSummaries

public GetTraceSummariesResult getTraceSummaries(GetTraceSummariesRequest request)

Description copied from interface: AWSXRay

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:

getTraceSummaries in interface AWSXRay

Returns:

Result of the GetTraceSummaries operation returned by the service.

See Also:

AWS API Documentation

putTelemetryRecords

public PutTelemetryRecordsResult putTelemetryRecords(PutTelemetryRecordsRequest request)

Description copied from interface: AWSXRay

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

Specified by:

putTelemetryRecords in interface AWSXRay

Returns:

Result of the PutTelemetryRecords operation returned by the service.

See Also:

AWS API Documentation

putTraceSegments

public PutTraceSegmentsResult putTraceSegments(PutTraceSegmentsRequest request)

Description copied from interface: AWSXRay

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:

putTraceSegments in interface AWSXRay

Returns:

Result of the PutTraceSegments operation returned by the service.

See Also:

AWS API Documentation

shutdown

public void shutdown()

Description copied from interface: AWSXRay

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

Specified by:

shutdown in interface AWSXRay

getCachedResponseMetadata

public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Description copied from interface: AWSXRay

Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.

Specified by:

getCachedResponseMetadata in interface AWSXRay

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.