@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAWSXRayAsync extends AbstractAWSXRay implements AWSXRayAsync
AWSXRayAsync
. Convenient method forms pass through to the corresponding overload
that takes a request object and an AsyncHandler
, which throws an UnsupportedOperationException
.ENDPOINT_PREFIX
batchGetTraces, createGroup, createSamplingRule, deleteGroup, deleteSamplingRule, getCachedResponseMetadata, getEncryptionConfig, getGroup, getGroups, getSamplingRules, getSamplingStatisticSummaries, getSamplingTargets, getServiceGraph, getTimeSeriesServiceStatistics, getTraceGraph, getTraceSummaries, putEncryptionConfig, putTelemetryRecords, putTraceSegments, setEndpoint, setRegion, shutdown, updateGroup, updateSamplingRule
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
batchGetTraces, createGroup, createSamplingRule, deleteGroup, deleteSamplingRule, getCachedResponseMetadata, getEncryptionConfig, getGroup, getGroups, getSamplingRules, getSamplingStatisticSummaries, getSamplingTargets, getServiceGraph, getTimeSeriesServiceStatistics, getTraceGraph, getTraceSummaries, putEncryptionConfig, putTelemetryRecords, putTraceSegments, setEndpoint, setRegion, shutdown, updateGroup, updateSamplingRule
public Future<BatchGetTracesResult> batchGetTracesAsync(BatchGetTracesRequest request)
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.
batchGetTracesAsync
in interface AWSXRayAsync
public Future<BatchGetTracesResult> batchGetTracesAsync(BatchGetTracesRequest request, AsyncHandler<BatchGetTracesRequest,BatchGetTracesResult> asyncHandler)
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.
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.public Future<CreateGroupResult> createGroupAsync(CreateGroupRequest request)
AWSXRayAsync
Creates a group resource with a name and a filter expression.
createGroupAsync
in interface AWSXRayAsync
public Future<CreateGroupResult> createGroupAsync(CreateGroupRequest request, AsyncHandler<CreateGroupRequest,CreateGroupResult> asyncHandler)
AWSXRayAsync
Creates a group resource with a name and a filter expression.
createGroupAsync
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.public Future<CreateSamplingRuleResult> createSamplingRuleAsync(CreateSamplingRuleRequest request)
AWSXRayAsync
Creates a rule to control sampling behavior for instrumented applications. Services retrieve rules with GetSamplingRules, and evaluate each rule in ascending order of priority for each request. If a rule matches, the service records a trace, borrowing it from the reservoir size. After 10 seconds, the service reports back to X-Ray with GetSamplingTargets to get updated versions of each in-use rule. The updated rule contains a trace quota that the service can use instead of borrowing from the reservoir.
createSamplingRuleAsync
in interface AWSXRayAsync
public Future<CreateSamplingRuleResult> createSamplingRuleAsync(CreateSamplingRuleRequest request, AsyncHandler<CreateSamplingRuleRequest,CreateSamplingRuleResult> asyncHandler)
AWSXRayAsync
Creates a rule to control sampling behavior for instrumented applications. Services retrieve rules with GetSamplingRules, and evaluate each rule in ascending order of priority for each request. If a rule matches, the service records a trace, borrowing it from the reservoir size. After 10 seconds, the service reports back to X-Ray with GetSamplingTargets to get updated versions of each in-use rule. The updated rule contains a trace quota that the service can use instead of borrowing from the reservoir.
createSamplingRuleAsync
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.public Future<DeleteGroupResult> deleteGroupAsync(DeleteGroupRequest request)
AWSXRayAsync
Deletes a group resource.
deleteGroupAsync
in interface AWSXRayAsync
public Future<DeleteGroupResult> deleteGroupAsync(DeleteGroupRequest request, AsyncHandler<DeleteGroupRequest,DeleteGroupResult> asyncHandler)
AWSXRayAsync
Deletes a group resource.
deleteGroupAsync
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.public Future<DeleteSamplingRuleResult> deleteSamplingRuleAsync(DeleteSamplingRuleRequest request)
AWSXRayAsync
Deletes a sampling rule.
deleteSamplingRuleAsync
in interface AWSXRayAsync
public Future<DeleteSamplingRuleResult> deleteSamplingRuleAsync(DeleteSamplingRuleRequest request, AsyncHandler<DeleteSamplingRuleRequest,DeleteSamplingRuleResult> asyncHandler)
AWSXRayAsync
Deletes a sampling rule.
deleteSamplingRuleAsync
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.public Future<GetEncryptionConfigResult> getEncryptionConfigAsync(GetEncryptionConfigRequest request)
AWSXRayAsync
Retrieves the current encryption configuration for X-Ray data.
getEncryptionConfigAsync
in interface AWSXRayAsync
public Future<GetEncryptionConfigResult> getEncryptionConfigAsync(GetEncryptionConfigRequest request, AsyncHandler<GetEncryptionConfigRequest,GetEncryptionConfigResult> asyncHandler)
AWSXRayAsync
Retrieves the current encryption configuration for X-Ray data.
getEncryptionConfigAsync
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.public Future<GetGroupResult> getGroupAsync(GetGroupRequest request)
AWSXRayAsync
Retrieves group resource details.
getGroupAsync
in interface AWSXRayAsync
public Future<GetGroupResult> getGroupAsync(GetGroupRequest request, AsyncHandler<GetGroupRequest,GetGroupResult> asyncHandler)
AWSXRayAsync
Retrieves group resource details.
getGroupAsync
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.public Future<GetGroupsResult> getGroupsAsync(GetGroupsRequest request)
AWSXRayAsync
Retrieves all active group details.
getGroupsAsync
in interface AWSXRayAsync
public Future<GetGroupsResult> getGroupsAsync(GetGroupsRequest request, AsyncHandler<GetGroupsRequest,GetGroupsResult> asyncHandler)
AWSXRayAsync
Retrieves all active group details.
getGroupsAsync
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.public Future<GetSamplingRulesResult> getSamplingRulesAsync(GetSamplingRulesRequest request)
AWSXRayAsync
Retrieves all sampling rules.
getSamplingRulesAsync
in interface AWSXRayAsync
public Future<GetSamplingRulesResult> getSamplingRulesAsync(GetSamplingRulesRequest request, AsyncHandler<GetSamplingRulesRequest,GetSamplingRulesResult> asyncHandler)
AWSXRayAsync
Retrieves all sampling rules.
getSamplingRulesAsync
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.public Future<GetSamplingStatisticSummariesResult> getSamplingStatisticSummariesAsync(GetSamplingStatisticSummariesRequest request)
AWSXRayAsync
Retrieves information about recent sampling results for all sampling rules.
getSamplingStatisticSummariesAsync
in interface AWSXRayAsync
public Future<GetSamplingStatisticSummariesResult> getSamplingStatisticSummariesAsync(GetSamplingStatisticSummariesRequest request, AsyncHandler<GetSamplingStatisticSummariesRequest,GetSamplingStatisticSummariesResult> asyncHandler)
AWSXRayAsync
Retrieves information about recent sampling results for all sampling rules.
getSamplingStatisticSummariesAsync
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.public Future<GetSamplingTargetsResult> getSamplingTargetsAsync(GetSamplingTargetsRequest request)
AWSXRayAsync
Requests a sampling quota for rules that the service is using to sample requests.
getSamplingTargetsAsync
in interface AWSXRayAsync
public Future<GetSamplingTargetsResult> getSamplingTargetsAsync(GetSamplingTargetsRequest request, AsyncHandler<GetSamplingTargetsRequest,GetSamplingTargetsResult> asyncHandler)
AWSXRayAsync
Requests a sampling quota for rules that the service is using to sample requests.
getSamplingTargetsAsync
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.public Future<GetServiceGraphResult> getServiceGraphAsync(GetServiceGraphRequest request)
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.
getServiceGraphAsync
in interface AWSXRayAsync
public Future<GetServiceGraphResult> getServiceGraphAsync(GetServiceGraphRequest request, AsyncHandler<GetServiceGraphRequest,GetServiceGraphResult> asyncHandler)
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.
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.public Future<GetTimeSeriesServiceStatisticsResult> getTimeSeriesServiceStatisticsAsync(GetTimeSeriesServiceStatisticsRequest request)
AWSXRayAsync
Get an aggregation of service statistics defined by a specific time range.
getTimeSeriesServiceStatisticsAsync
in interface AWSXRayAsync
public Future<GetTimeSeriesServiceStatisticsResult> getTimeSeriesServiceStatisticsAsync(GetTimeSeriesServiceStatisticsRequest request, AsyncHandler<GetTimeSeriesServiceStatisticsRequest,GetTimeSeriesServiceStatisticsResult> asyncHandler)
AWSXRayAsync
Get an aggregation of service statistics defined by a specific time range.
getTimeSeriesServiceStatisticsAsync
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.public Future<GetTraceGraphResult> getTraceGraphAsync(GetTraceGraphRequest request)
AWSXRayAsync
Retrieves a service graph for one or more specific trace IDs.
getTraceGraphAsync
in interface AWSXRayAsync
public Future<GetTraceGraphResult> getTraceGraphAsync(GetTraceGraphRequest request, AsyncHandler<GetTraceGraphRequest,GetTraceGraphResult> asyncHandler)
AWSXRayAsync
Retrieves a service graph for one or more specific trace IDs.
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.public Future<GetTraceSummariesResult> getTraceSummariesAsync(GetTraceSummariesRequest request)
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
.
A filter expression can target traced requests that hit specific service nodes or edges, have errors, or come
from a known user. For example, the following filter expression targets traces that pass through
api.example.com
:
service("api.example.com")
This filter expression finds traces that have an annotation named account
with the value
12345
:
annotation.account = "12345"
For a full list of indexed fields and keywords that you can use in filter expressions, see Using Filter Expressions in the AWS X-Ray Developer Guide.
getTraceSummariesAsync
in interface AWSXRayAsync
public Future<GetTraceSummariesResult> getTraceSummariesAsync(GetTraceSummariesRequest request, AsyncHandler<GetTraceSummariesRequest,GetTraceSummariesResult> asyncHandler)
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
.
A filter expression can target traced requests that hit specific service nodes or edges, have errors, or come
from a known user. For example, the following filter expression targets traces that pass through
api.example.com
:
service("api.example.com")
This filter expression finds traces that have an annotation named account
with the value
12345
:
annotation.account = "12345"
For a full list of indexed fields and keywords that you can use in filter expressions, see Using Filter Expressions in the AWS X-Ray Developer Guide.
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.public Future<PutEncryptionConfigResult> putEncryptionConfigAsync(PutEncryptionConfigRequest request)
AWSXRayAsync
Updates the encryption configuration for X-Ray data.
putEncryptionConfigAsync
in interface AWSXRayAsync
public Future<PutEncryptionConfigResult> putEncryptionConfigAsync(PutEncryptionConfigRequest request, AsyncHandler<PutEncryptionConfigRequest,PutEncryptionConfigResult> asyncHandler)
AWSXRayAsync
Updates the encryption configuration for X-Ray data.
putEncryptionConfigAsync
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.public Future<PutTelemetryRecordsResult> putTelemetryRecordsAsync(PutTelemetryRecordsRequest request)
AWSXRayAsync
Used by the AWS X-Ray daemon to upload telemetry.
putTelemetryRecordsAsync
in interface AWSXRayAsync
public Future<PutTelemetryRecordsResult> putTelemetryRecordsAsync(PutTelemetryRecordsRequest request, AsyncHandler<PutTelemetryRecordsRequest,PutTelemetryRecordsResult> asyncHandler)
AWSXRayAsync
Used by the AWS X-Ray daemon to upload telemetry.
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.public Future<PutTraceSegmentsResult> putTraceSegmentsAsync(PutTraceSegmentsRequest request)
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.
Segments must include the following fields. For the full segment document schema, see AWS X-Ray Segment Documents in the AWS X-Ray Developer Guide.
Required Segment Document Fields
name
- The name of the service that handled the request.
id
- A 64-bit identifier for the segment, unique among segments in the same trace, in 16 hexadecimal
digits.
trace_id
- A unique identifier that connects all segments and subsegments originating from a single
client request.
start_time
- Time the segment or subsegment was created, in floating point seconds in epoch time,
accurate to milliseconds. For example, 1480615200.010
or 1.480615200010E9
.
end_time
- Time the segment or subsegment was closed. For example, 1480615200.090
or
1.480615200090E9
. Specify either an end_time
or in_progress
.
in_progress
- Set to true
instead of specifying an end_time
to record that
a segment has been started, but is not complete. Send an in progress segment when your application receives a
request that will take a long time to serve, to trace the fact that the request was received. When the response
is sent, send the complete segment to overwrite the in-progress segment.
A trace_id
consists of three numbers separated by hyphens. For example,
1-58406520-a006649127e371903a2de979. This includes:
Trace ID Format
The version number, i.e. 1
.
The time of the original request, in Unix epoch time, in 8 hexadecimal digits. For example, 10:00AM December 2nd,
2016 PST in epoch time is 1480615200
seconds, or 58406520
in hexadecimal.
A 96-bit identifier for the trace, globally unique, in 24 hexadecimal digits.
putTraceSegmentsAsync
in interface AWSXRayAsync
public Future<PutTraceSegmentsResult> putTraceSegmentsAsync(PutTraceSegmentsRequest request, AsyncHandler<PutTraceSegmentsRequest,PutTraceSegmentsResult> asyncHandler)
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.
Segments must include the following fields. For the full segment document schema, see AWS X-Ray Segment Documents in the AWS X-Ray Developer Guide.
Required Segment Document Fields
name
- The name of the service that handled the request.
id
- A 64-bit identifier for the segment, unique among segments in the same trace, in 16 hexadecimal
digits.
trace_id
- A unique identifier that connects all segments and subsegments originating from a single
client request.
start_time
- Time the segment or subsegment was created, in floating point seconds in epoch time,
accurate to milliseconds. For example, 1480615200.010
or 1.480615200010E9
.
end_time
- Time the segment or subsegment was closed. For example, 1480615200.090
or
1.480615200090E9
. Specify either an end_time
or in_progress
.
in_progress
- Set to true
instead of specifying an end_time
to record that
a segment has been started, but is not complete. Send an in progress segment when your application receives a
request that will take a long time to serve, to trace the fact that the request was received. When the response
is sent, send the complete segment to overwrite the in-progress segment.
A trace_id
consists of three numbers separated by hyphens. For example,
1-58406520-a006649127e371903a2de979. This includes:
Trace ID Format
The version number, i.e. 1
.
The time of the original request, in Unix epoch time, in 8 hexadecimal digits. For example, 10:00AM December 2nd,
2016 PST in epoch time is 1480615200
seconds, or 58406520
in hexadecimal.
A 96-bit identifier for the trace, globally unique, in 24 hexadecimal digits.
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.public Future<UpdateGroupResult> updateGroupAsync(UpdateGroupRequest request)
AWSXRayAsync
Updates a group resource.
updateGroupAsync
in interface AWSXRayAsync
public Future<UpdateGroupResult> updateGroupAsync(UpdateGroupRequest request, AsyncHandler<UpdateGroupRequest,UpdateGroupResult> asyncHandler)
AWSXRayAsync
Updates a group resource.
updateGroupAsync
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.public Future<UpdateSamplingRuleResult> updateSamplingRuleAsync(UpdateSamplingRuleRequest request)
AWSXRayAsync
Modifies a sampling rule's configuration.
updateSamplingRuleAsync
in interface AWSXRayAsync
public Future<UpdateSamplingRuleResult> updateSamplingRuleAsync(UpdateSamplingRuleRequest request, AsyncHandler<UpdateSamplingRuleRequest,UpdateSamplingRuleResult> asyncHandler)
AWSXRayAsync
Modifies a sampling rule's configuration.
updateSamplingRuleAsync
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.Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.