@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AWSXRayClient extends AmazonWebServiceClient implements AWSXRay
AWS X-Ray provides APIs for managing debug traces and retrieving service maps and other data created by processing those traces.
Modifier and Type | Field and Description |
---|---|
protected static ClientConfigurationFactory |
configFactory
Client configuration factory providing ClientConfigurations tailored to this client
|
client, clientConfiguration, endpoint, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset
ENDPOINT_PREFIX
Constructor and Description |
---|
AWSXRayClient()
Constructs a new client to invoke service methods on AWS X-Ray.
|
AWSXRayClient(AWSCredentials awsCredentials)
Constructs a new client to invoke service methods on AWS X-Ray using the specified AWS account credentials.
|
AWSXRayClient(AWSCredentials awsCredentials,
ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on AWS X-Ray using the specified AWS account credentials and
client configuration options.
|
AWSXRayClient(AWSCredentialsProvider awsCredentialsProvider)
Constructs a new client to invoke service methods on AWS X-Ray using the specified AWS account credentials
provider.
|
AWSXRayClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on AWS X-Ray using the specified AWS account credentials
provider and client configuration options.
|
AWSXRayClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration,
RequestMetricCollector requestMetricCollector)
Constructs a new client to invoke service methods on AWS X-Ray using the specified AWS account credentials
provider, client configuration options, and request metric collector.
|
AWSXRayClient(ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on AWS X-Ray.
|
Modifier and Type | Method and Description |
---|---|
BatchGetTracesResult |
batchGetTraces(BatchGetTracesRequest batchGetTracesRequest)
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 getServiceGraphRequest)
Retrieves a document that describes services that process incoming requests, and downstream services that they
call as a result.
|
GetTraceGraphResult |
getTraceGraph(GetTraceGraphRequest getTraceGraphRequest)
Retrieves a service graph for one or more specific trace IDs.
|
GetTraceSummariesResult |
getTraceSummaries(GetTraceSummariesRequest getTraceSummariesRequest)
Retrieves IDs and metadata for traces available for a specified time frame using an optional filter.
|
PutTelemetryRecordsResult |
putTelemetryRecords(PutTelemetryRecordsRequest putTelemetryRecordsRequest)
Used by the AWS X-Ray daemon to upload telemetry.
|
PutTraceSegmentsResult |
putTraceSegments(PutTraceSegmentsRequest putTraceSegmentsRequest)
Uploads segment documents to AWS X-Ray.
|
addRequestHandler, addRequestHandler, beforeMarshalling, calculateCRC32FromCompressedData, checkMutability, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, createSignerProvider, endClientExecution, endClientExecution, getEndpointPrefix, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerProvider, getSignerRegionOverride, getTimeOffset, isProfilingEnabled, isRequestMetricsEnabled, makeImmutable, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, useStrictHostNameVerification, withEndpoint, withRegion, withRegion, withTimeOffset
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
setEndpoint, setRegion, shutdown
protected static final ClientConfigurationFactory configFactory
public AWSXRayClient()
All service calls made using this new client object are blocking, and will not return until the service call completes.
DefaultAWSCredentialsProviderChain
public AWSXRayClient(ClientConfiguration clientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
clientConfiguration
- The client configuration options controlling how this client connects to AWS X-Ray (ex: proxy settings,
retry counts, etc.).DefaultAWSCredentialsProviderChain
public AWSXRayClient(AWSCredentials awsCredentials)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials
- The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.public AWSXRayClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials
- The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.clientConfiguration
- The client configuration options controlling how this client connects to AWS X-Ray (ex: proxy settings,
retry counts, etc.).public AWSXRayClient(AWSCredentialsProvider awsCredentialsProvider)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to authenticate requests with AWS services.public AWSXRayClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration
- The client configuration options controlling how this client connects to AWS X-Ray (ex: proxy settings,
retry counts, etc.).public AWSXRayClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration
- The client configuration options controlling how this client connects to AWS X-Ray (ex: proxy settings,
retry counts, etc.).requestMetricCollector
- optional request metric collectorpublic BatchGetTracesResult batchGetTraces(BatchGetTracesRequest batchGetTracesRequest)
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.
batchGetTraces
in interface AWSXRay
batchGetTracesRequest
- InvalidRequestException
- The request is missing required parameters or has invalid parameters.ThrottledException
- The request exceeds the maximum number of requests per second.public GetServiceGraphResult getServiceGraph(GetServiceGraphRequest getServiceGraphRequest)
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.
getServiceGraph
in interface AWSXRay
getServiceGraphRequest
- InvalidRequestException
- The request is missing required parameters or has invalid parameters.ThrottledException
- The request exceeds the maximum number of requests per second.public GetTraceGraphResult getTraceGraph(GetTraceGraphRequest getTraceGraphRequest)
Retrieves a service graph for one or more specific trace IDs.
getTraceGraph
in interface AWSXRay
getTraceGraphRequest
- InvalidRequestException
- The request is missing required parameters or has invalid parameters.ThrottledException
- The request exceeds the maximum number of requests per second.public GetTraceSummariesResult getTraceSummaries(GetTraceSummariesRequest getTraceSummariesRequest)
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
.
getTraceSummaries
in interface AWSXRay
getTraceSummariesRequest
- InvalidRequestException
- The request is missing required parameters or has invalid parameters.ThrottledException
- The request exceeds the maximum number of requests per second.public PutTelemetryRecordsResult putTelemetryRecords(PutTelemetryRecordsRequest putTelemetryRecordsRequest)
Used by the AWS X-Ray daemon to upload telemetry.
putTelemetryRecords
in interface AWSXRay
putTelemetryRecordsRequest
- InvalidRequestException
- The request is missing required parameters or has invalid parameters.ThrottledException
- The request exceeds the maximum number of requests per second.public PutTraceSegmentsResult putTraceSegments(PutTraceSegmentsRequest putTraceSegmentsRequest)
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.
putTraceSegments
in interface AWSXRay
putTraceSegmentsRequest
- InvalidRequestException
- The request is missing required parameters or has invalid parameters.ThrottledException
- The request exceeds the maximum number of requests per second.public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
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 the request.
getCachedResponseMetadata
in interface AWSXRay
request
- The originally executed requestCopyright © 2017. All rights reserved.