@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AWSXRayAsync extends AWSXRay
AsyncHandler
can be used to receive
notification when an asynchronous operation completes.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAWSXRayAsync
instead.
AWS X-Ray provides APIs for managing debug traces and retrieving service maps and other data created by processing those traces.
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
Future<BatchGetTracesResult> batchGetTracesAsync(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.
batchGetTracesRequest
- Future<BatchGetTracesResult> batchGetTracesAsync(BatchGetTracesRequest batchGetTracesRequest, AsyncHandler<BatchGetTracesRequest,BatchGetTracesResult> asyncHandler)
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.
batchGetTracesRequest
- 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.Future<CreateGroupResult> createGroupAsync(CreateGroupRequest createGroupRequest)
Creates a group resource with a name and a filter expression.
createGroupRequest
- Future<CreateGroupResult> createGroupAsync(CreateGroupRequest createGroupRequest, AsyncHandler<CreateGroupRequest,CreateGroupResult> asyncHandler)
Creates a group resource with a name and a filter expression.
createGroupRequest
- 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.Future<CreateSamplingRuleResult> createSamplingRuleAsync(CreateSamplingRuleRequest createSamplingRuleRequest)
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.
createSamplingRuleRequest
- Future<CreateSamplingRuleResult> createSamplingRuleAsync(CreateSamplingRuleRequest createSamplingRuleRequest, AsyncHandler<CreateSamplingRuleRequest,CreateSamplingRuleResult> asyncHandler)
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.
createSamplingRuleRequest
- 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.Future<DeleteGroupResult> deleteGroupAsync(DeleteGroupRequest deleteGroupRequest)
Deletes a group resource.
deleteGroupRequest
- Future<DeleteGroupResult> deleteGroupAsync(DeleteGroupRequest deleteGroupRequest, AsyncHandler<DeleteGroupRequest,DeleteGroupResult> asyncHandler)
Deletes a group resource.
deleteGroupRequest
- 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.Future<DeleteSamplingRuleResult> deleteSamplingRuleAsync(DeleteSamplingRuleRequest deleteSamplingRuleRequest)
Deletes a sampling rule.
deleteSamplingRuleRequest
- Future<DeleteSamplingRuleResult> deleteSamplingRuleAsync(DeleteSamplingRuleRequest deleteSamplingRuleRequest, AsyncHandler<DeleteSamplingRuleRequest,DeleteSamplingRuleResult> asyncHandler)
Deletes a sampling rule.
deleteSamplingRuleRequest
- 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.Future<GetEncryptionConfigResult> getEncryptionConfigAsync(GetEncryptionConfigRequest getEncryptionConfigRequest)
Retrieves the current encryption configuration for X-Ray data.
getEncryptionConfigRequest
- Future<GetEncryptionConfigResult> getEncryptionConfigAsync(GetEncryptionConfigRequest getEncryptionConfigRequest, AsyncHandler<GetEncryptionConfigRequest,GetEncryptionConfigResult> asyncHandler)
Retrieves the current encryption configuration for X-Ray data.
getEncryptionConfigRequest
- 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.Future<GetGroupResult> getGroupAsync(GetGroupRequest getGroupRequest)
Retrieves group resource details.
getGroupRequest
- Future<GetGroupResult> getGroupAsync(GetGroupRequest getGroupRequest, AsyncHandler<GetGroupRequest,GetGroupResult> asyncHandler)
Retrieves group resource details.
getGroupRequest
- 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.Future<GetGroupsResult> getGroupsAsync(GetGroupsRequest getGroupsRequest)
Retrieves all active group details.
getGroupsRequest
- Future<GetGroupsResult> getGroupsAsync(GetGroupsRequest getGroupsRequest, AsyncHandler<GetGroupsRequest,GetGroupsResult> asyncHandler)
Retrieves all active group details.
getGroupsRequest
- 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.Future<GetSamplingRulesResult> getSamplingRulesAsync(GetSamplingRulesRequest getSamplingRulesRequest)
Retrieves all sampling rules.
getSamplingRulesRequest
- Future<GetSamplingRulesResult> getSamplingRulesAsync(GetSamplingRulesRequest getSamplingRulesRequest, AsyncHandler<GetSamplingRulesRequest,GetSamplingRulesResult> asyncHandler)
Retrieves all sampling rules.
getSamplingRulesRequest
- 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.Future<GetSamplingStatisticSummariesResult> getSamplingStatisticSummariesAsync(GetSamplingStatisticSummariesRequest getSamplingStatisticSummariesRequest)
Retrieves information about recent sampling results for all sampling rules.
getSamplingStatisticSummariesRequest
- Future<GetSamplingStatisticSummariesResult> getSamplingStatisticSummariesAsync(GetSamplingStatisticSummariesRequest getSamplingStatisticSummariesRequest, AsyncHandler<GetSamplingStatisticSummariesRequest,GetSamplingStatisticSummariesResult> asyncHandler)
Retrieves information about recent sampling results for all sampling rules.
getSamplingStatisticSummariesRequest
- 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.Future<GetSamplingTargetsResult> getSamplingTargetsAsync(GetSamplingTargetsRequest getSamplingTargetsRequest)
Requests a sampling quota for rules that the service is using to sample requests.
getSamplingTargetsRequest
- Future<GetSamplingTargetsResult> getSamplingTargetsAsync(GetSamplingTargetsRequest getSamplingTargetsRequest, AsyncHandler<GetSamplingTargetsRequest,GetSamplingTargetsResult> asyncHandler)
Requests a sampling quota for rules that the service is using to sample requests.
getSamplingTargetsRequest
- 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.Future<GetServiceGraphResult> getServiceGraphAsync(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.
getServiceGraphRequest
- Future<GetServiceGraphResult> getServiceGraphAsync(GetServiceGraphRequest getServiceGraphRequest, AsyncHandler<GetServiceGraphRequest,GetServiceGraphResult> asyncHandler)
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.
getServiceGraphRequest
- 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.Future<GetTimeSeriesServiceStatisticsResult> getTimeSeriesServiceStatisticsAsync(GetTimeSeriesServiceStatisticsRequest getTimeSeriesServiceStatisticsRequest)
Get an aggregation of service statistics defined by a specific time range.
getTimeSeriesServiceStatisticsRequest
- Future<GetTimeSeriesServiceStatisticsResult> getTimeSeriesServiceStatisticsAsync(GetTimeSeriesServiceStatisticsRequest getTimeSeriesServiceStatisticsRequest, AsyncHandler<GetTimeSeriesServiceStatisticsRequest,GetTimeSeriesServiceStatisticsResult> asyncHandler)
Get an aggregation of service statistics defined by a specific time range.
getTimeSeriesServiceStatisticsRequest
- 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.Future<GetTraceGraphResult> getTraceGraphAsync(GetTraceGraphRequest getTraceGraphRequest)
Retrieves a service graph for one or more specific trace IDs.
getTraceGraphRequest
- Future<GetTraceGraphResult> getTraceGraphAsync(GetTraceGraphRequest getTraceGraphRequest, AsyncHandler<GetTraceGraphRequest,GetTraceGraphResult> asyncHandler)
Retrieves a service graph for one or more specific trace IDs.
getTraceGraphRequest
- 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.Future<GetTraceSummariesResult> getTraceSummariesAsync(GetTraceSummariesRequest getTraceSummariesRequest)
Retrieves IDs and annotations 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.
getTraceSummariesRequest
- Future<GetTraceSummariesResult> getTraceSummariesAsync(GetTraceSummariesRequest getTraceSummariesRequest, AsyncHandler<GetTraceSummariesRequest,GetTraceSummariesResult> asyncHandler)
Retrieves IDs and annotations 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.
getTraceSummariesRequest
- 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.Future<PutEncryptionConfigResult> putEncryptionConfigAsync(PutEncryptionConfigRequest putEncryptionConfigRequest)
Updates the encryption configuration for X-Ray data.
putEncryptionConfigRequest
- Future<PutEncryptionConfigResult> putEncryptionConfigAsync(PutEncryptionConfigRequest putEncryptionConfigRequest, AsyncHandler<PutEncryptionConfigRequest,PutEncryptionConfigResult> asyncHandler)
Updates the encryption configuration for X-Ray data.
putEncryptionConfigRequest
- 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.Future<PutTelemetryRecordsResult> putTelemetryRecordsAsync(PutTelemetryRecordsRequest putTelemetryRecordsRequest)
Used by the AWS X-Ray daemon to upload telemetry.
putTelemetryRecordsRequest
- Future<PutTelemetryRecordsResult> putTelemetryRecordsAsync(PutTelemetryRecordsRequest putTelemetryRecordsRequest, AsyncHandler<PutTelemetryRecordsRequest,PutTelemetryRecordsResult> asyncHandler)
Used by the AWS X-Ray daemon to upload telemetry.
putTelemetryRecordsRequest
- 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.Future<PutTraceSegmentsResult> putTraceSegmentsAsync(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.
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.
putTraceSegmentsRequest
- Future<PutTraceSegmentsResult> putTraceSegmentsAsync(PutTraceSegmentsRequest putTraceSegmentsRequest, AsyncHandler<PutTraceSegmentsRequest,PutTraceSegmentsResult> asyncHandler)
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.
putTraceSegmentsRequest
- 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.Future<UpdateGroupResult> updateGroupAsync(UpdateGroupRequest updateGroupRequest)
Updates a group resource.
updateGroupRequest
- Future<UpdateGroupResult> updateGroupAsync(UpdateGroupRequest updateGroupRequest, AsyncHandler<UpdateGroupRequest,UpdateGroupResult> asyncHandler)
Updates a group resource.
updateGroupRequest
- 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.Future<UpdateSamplingRuleResult> updateSamplingRuleAsync(UpdateSamplingRuleRequest updateSamplingRuleRequest)
Modifies a sampling rule's configuration.
updateSamplingRuleRequest
- Future<UpdateSamplingRuleResult> updateSamplingRuleAsync(UpdateSamplingRuleRequest updateSamplingRuleRequest, AsyncHandler<UpdateSamplingRuleRequest,UpdateSamplingRuleResult> asyncHandler)
Modifies a sampling rule's configuration.
updateSamplingRuleRequest
- 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 © 2020. All rights reserved.