@Generated(value="software.amazon.awssdk:codegen") public interface XRayAsyncClient extends SdkClient
builder()
method.
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 |
---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider . |
static String |
SERVICE_NAME |
Modifier and Type | Method and Description |
---|---|
default CompletableFuture<BatchGetTracesResponse> |
batchGetTraces(BatchGetTracesRequest batchGetTracesRequest)
Retrieves a list of traces specified by ID.
|
default CompletableFuture<BatchGetTracesResponse> |
batchGetTraces(Consumer<BatchGetTracesRequest.Builder> batchGetTracesRequest)
Retrieves a list of traces specified by ID.
|
default BatchGetTracesPublisher |
batchGetTracesPaginator(BatchGetTracesRequest batchGetTracesRequest)
Retrieves a list of traces specified by ID.
|
default BatchGetTracesPublisher |
batchGetTracesPaginator(Consumer<BatchGetTracesRequest.Builder> batchGetTracesRequest)
Retrieves a list of traces specified by ID.
|
static XRayAsyncClientBuilder |
builder()
Create a builder that can be used to configure and create a
XRayAsyncClient . |
static XRayAsyncClient |
create()
Create a
XRayAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider . |
default CompletableFuture<CreateGroupResponse> |
createGroup(Consumer<CreateGroupRequest.Builder> createGroupRequest)
Creates a group resource with a name and a filter expression.
|
default CompletableFuture<CreateGroupResponse> |
createGroup(CreateGroupRequest createGroupRequest)
Creates a group resource with a name and a filter expression.
|
default CompletableFuture<CreateSamplingRuleResponse> |
createSamplingRule(Consumer<CreateSamplingRuleRequest.Builder> createSamplingRuleRequest)
Creates a rule to control sampling behavior for instrumented applications.
|
default CompletableFuture<CreateSamplingRuleResponse> |
createSamplingRule(CreateSamplingRuleRequest createSamplingRuleRequest)
Creates a rule to control sampling behavior for instrumented applications.
|
default CompletableFuture<DeleteGroupResponse> |
deleteGroup(Consumer<DeleteGroupRequest.Builder> deleteGroupRequest)
Deletes a group resource.
|
default CompletableFuture<DeleteGroupResponse> |
deleteGroup(DeleteGroupRequest deleteGroupRequest)
Deletes a group resource.
|
default CompletableFuture<DeleteSamplingRuleResponse> |
deleteSamplingRule(Consumer<DeleteSamplingRuleRequest.Builder> deleteSamplingRuleRequest)
Deletes a sampling rule.
|
default CompletableFuture<DeleteSamplingRuleResponse> |
deleteSamplingRule(DeleteSamplingRuleRequest deleteSamplingRuleRequest)
Deletes a sampling rule.
|
default CompletableFuture<GetEncryptionConfigResponse> |
getEncryptionConfig()
Retrieves the current encryption configuration for X-Ray data.
|
default CompletableFuture<GetEncryptionConfigResponse> |
getEncryptionConfig(Consumer<GetEncryptionConfigRequest.Builder> getEncryptionConfigRequest)
Retrieves the current encryption configuration for X-Ray data.
|
default CompletableFuture<GetEncryptionConfigResponse> |
getEncryptionConfig(GetEncryptionConfigRequest getEncryptionConfigRequest)
Retrieves the current encryption configuration for X-Ray data.
|
default CompletableFuture<GetGroupResponse> |
getGroup(Consumer<GetGroupRequest.Builder> getGroupRequest)
Retrieves group resource details.
|
default CompletableFuture<GetGroupResponse> |
getGroup(GetGroupRequest getGroupRequest)
Retrieves group resource details.
|
default CompletableFuture<GetGroupsResponse> |
getGroups()
Retrieves all active group details.
|
default CompletableFuture<GetGroupsResponse> |
getGroups(Consumer<GetGroupsRequest.Builder> getGroupsRequest)
Retrieves all active group details.
|
default CompletableFuture<GetGroupsResponse> |
getGroups(GetGroupsRequest getGroupsRequest)
Retrieves all active group details.
|
default GetGroupsPublisher |
getGroupsPaginator()
Retrieves all active group details.
|
default GetGroupsPublisher |
getGroupsPaginator(Consumer<GetGroupsRequest.Builder> getGroupsRequest)
Retrieves all active group details.
|
default GetGroupsPublisher |
getGroupsPaginator(GetGroupsRequest getGroupsRequest)
Retrieves all active group details.
|
default CompletableFuture<GetInsightResponse> |
getInsight(Consumer<GetInsightRequest.Builder> getInsightRequest)
Retrieves the summary information of an insight.
|
default CompletableFuture<GetInsightResponse> |
getInsight(GetInsightRequest getInsightRequest)
Retrieves the summary information of an insight.
|
default CompletableFuture<GetInsightEventsResponse> |
getInsightEvents(Consumer<GetInsightEventsRequest.Builder> getInsightEventsRequest)
X-Ray reevaluates insights periodically until they're resolved, and records each intermediate state as an event.
|
default CompletableFuture<GetInsightEventsResponse> |
getInsightEvents(GetInsightEventsRequest getInsightEventsRequest)
X-Ray reevaluates insights periodically until they're resolved, and records each intermediate state as an event.
|
default GetInsightEventsPublisher |
getInsightEventsPaginator(Consumer<GetInsightEventsRequest.Builder> getInsightEventsRequest)
X-Ray reevaluates insights periodically until they're resolved, and records each intermediate state as an event.
|
default GetInsightEventsPublisher |
getInsightEventsPaginator(GetInsightEventsRequest getInsightEventsRequest)
X-Ray reevaluates insights periodically until they're resolved, and records each intermediate state as an event.
|
default CompletableFuture<GetInsightImpactGraphResponse> |
getInsightImpactGraph(Consumer<GetInsightImpactGraphRequest.Builder> getInsightImpactGraphRequest)
Retrieves a service graph structure filtered by the specified insight.
|
default CompletableFuture<GetInsightImpactGraphResponse> |
getInsightImpactGraph(GetInsightImpactGraphRequest getInsightImpactGraphRequest)
Retrieves a service graph structure filtered by the specified insight.
|
default CompletableFuture<GetInsightSummariesResponse> |
getInsightSummaries(Consumer<GetInsightSummariesRequest.Builder> getInsightSummariesRequest)
Retrieves the summaries of all insights in the specified group matching the provided filter values.
|
default CompletableFuture<GetInsightSummariesResponse> |
getInsightSummaries(GetInsightSummariesRequest getInsightSummariesRequest)
Retrieves the summaries of all insights in the specified group matching the provided filter values.
|
default GetInsightSummariesPublisher |
getInsightSummariesPaginator(Consumer<GetInsightSummariesRequest.Builder> getInsightSummariesRequest)
Retrieves the summaries of all insights in the specified group matching the provided filter values.
|
default GetInsightSummariesPublisher |
getInsightSummariesPaginator(GetInsightSummariesRequest getInsightSummariesRequest)
Retrieves the summaries of all insights in the specified group matching the provided filter values.
|
default CompletableFuture<GetSamplingRulesResponse> |
getSamplingRules()
Retrieves all sampling rules.
|
default CompletableFuture<GetSamplingRulesResponse> |
getSamplingRules(Consumer<GetSamplingRulesRequest.Builder> getSamplingRulesRequest)
Retrieves all sampling rules.
|
default CompletableFuture<GetSamplingRulesResponse> |
getSamplingRules(GetSamplingRulesRequest getSamplingRulesRequest)
Retrieves all sampling rules.
|
default GetSamplingRulesPublisher |
getSamplingRulesPaginator()
Retrieves all sampling rules.
|
default GetSamplingRulesPublisher |
getSamplingRulesPaginator(Consumer<GetSamplingRulesRequest.Builder> getSamplingRulesRequest)
Retrieves all sampling rules.
|
default GetSamplingRulesPublisher |
getSamplingRulesPaginator(GetSamplingRulesRequest getSamplingRulesRequest)
Retrieves all sampling rules.
|
default CompletableFuture<GetSamplingStatisticSummariesResponse> |
getSamplingStatisticSummaries()
Retrieves information about recent sampling results for all sampling rules.
|
default CompletableFuture<GetSamplingStatisticSummariesResponse> |
getSamplingStatisticSummaries(Consumer<GetSamplingStatisticSummariesRequest.Builder> getSamplingStatisticSummariesRequest)
Retrieves information about recent sampling results for all sampling rules.
|
default CompletableFuture<GetSamplingStatisticSummariesResponse> |
getSamplingStatisticSummaries(GetSamplingStatisticSummariesRequest getSamplingStatisticSummariesRequest)
Retrieves information about recent sampling results for all sampling rules.
|
default GetSamplingStatisticSummariesPublisher |
getSamplingStatisticSummariesPaginator()
Retrieves information about recent sampling results for all sampling rules.
|
default GetSamplingStatisticSummariesPublisher |
getSamplingStatisticSummariesPaginator(Consumer<GetSamplingStatisticSummariesRequest.Builder> getSamplingStatisticSummariesRequest)
Retrieves information about recent sampling results for all sampling rules.
|
default GetSamplingStatisticSummariesPublisher |
getSamplingStatisticSummariesPaginator(GetSamplingStatisticSummariesRequest getSamplingStatisticSummariesRequest)
Retrieves information about recent sampling results for all sampling rules.
|
default CompletableFuture<GetSamplingTargetsResponse> |
getSamplingTargets(Consumer<GetSamplingTargetsRequest.Builder> getSamplingTargetsRequest)
Requests a sampling quota for rules that the service is using to sample requests.
|
default CompletableFuture<GetSamplingTargetsResponse> |
getSamplingTargets(GetSamplingTargetsRequest getSamplingTargetsRequest)
Requests a sampling quota for rules that the service is using to sample requests.
|
default CompletableFuture<GetServiceGraphResponse> |
getServiceGraph(Consumer<GetServiceGraphRequest.Builder> getServiceGraphRequest)
Retrieves a document that describes services that process incoming requests, and downstream services that they
call as a result.
|
default CompletableFuture<GetServiceGraphResponse> |
getServiceGraph(GetServiceGraphRequest getServiceGraphRequest)
Retrieves a document that describes services that process incoming requests, and downstream services that they
call as a result.
|
default GetServiceGraphPublisher |
getServiceGraphPaginator(Consumer<GetServiceGraphRequest.Builder> getServiceGraphRequest)
Retrieves a document that describes services that process incoming requests, and downstream services that they
call as a result.
|
default GetServiceGraphPublisher |
getServiceGraphPaginator(GetServiceGraphRequest getServiceGraphRequest)
Retrieves a document that describes services that process incoming requests, and downstream services that they
call as a result.
|
default CompletableFuture<GetTimeSeriesServiceStatisticsResponse> |
getTimeSeriesServiceStatistics(Consumer<GetTimeSeriesServiceStatisticsRequest.Builder> getTimeSeriesServiceStatisticsRequest)
Get an aggregation of service statistics defined by a specific time range.
|
default CompletableFuture<GetTimeSeriesServiceStatisticsResponse> |
getTimeSeriesServiceStatistics(GetTimeSeriesServiceStatisticsRequest getTimeSeriesServiceStatisticsRequest)
Get an aggregation of service statistics defined by a specific time range.
|
default GetTimeSeriesServiceStatisticsPublisher |
getTimeSeriesServiceStatisticsPaginator(Consumer<GetTimeSeriesServiceStatisticsRequest.Builder> getTimeSeriesServiceStatisticsRequest)
Get an aggregation of service statistics defined by a specific time range.
|
default GetTimeSeriesServiceStatisticsPublisher |
getTimeSeriesServiceStatisticsPaginator(GetTimeSeriesServiceStatisticsRequest getTimeSeriesServiceStatisticsRequest)
Get an aggregation of service statistics defined by a specific time range.
|
default CompletableFuture<GetTraceGraphResponse> |
getTraceGraph(Consumer<GetTraceGraphRequest.Builder> getTraceGraphRequest)
Retrieves a service graph for one or more specific trace IDs.
|
default CompletableFuture<GetTraceGraphResponse> |
getTraceGraph(GetTraceGraphRequest getTraceGraphRequest)
Retrieves a service graph for one or more specific trace IDs.
|
default GetTraceGraphPublisher |
getTraceGraphPaginator(Consumer<GetTraceGraphRequest.Builder> getTraceGraphRequest)
Retrieves a service graph for one or more specific trace IDs.
|
default GetTraceGraphPublisher |
getTraceGraphPaginator(GetTraceGraphRequest getTraceGraphRequest)
Retrieves a service graph for one or more specific trace IDs.
|
default CompletableFuture<GetTraceSummariesResponse> |
getTraceSummaries(Consumer<GetTraceSummariesRequest.Builder> getTraceSummariesRequest)
Retrieves IDs and annotations for traces available for a specified time frame using an optional filter.
|
default CompletableFuture<GetTraceSummariesResponse> |
getTraceSummaries(GetTraceSummariesRequest getTraceSummariesRequest)
Retrieves IDs and annotations for traces available for a specified time frame using an optional filter.
|
default GetTraceSummariesPublisher |
getTraceSummariesPaginator(Consumer<GetTraceSummariesRequest.Builder> getTraceSummariesRequest)
Retrieves IDs and annotations for traces available for a specified time frame using an optional filter.
|
default GetTraceSummariesPublisher |
getTraceSummariesPaginator(GetTraceSummariesRequest getTraceSummariesRequest)
Retrieves IDs and annotations for traces available for a specified time frame using an optional filter.
|
default CompletableFuture<ListTagsForResourceResponse> |
listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Returns a list of tags that are applied to the specified AWS X-Ray group or sampling rule.
|
default CompletableFuture<ListTagsForResourceResponse> |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Returns a list of tags that are applied to the specified AWS X-Ray group or sampling rule.
|
default CompletableFuture<PutEncryptionConfigResponse> |
putEncryptionConfig(Consumer<PutEncryptionConfigRequest.Builder> putEncryptionConfigRequest)
Updates the encryption configuration for X-Ray data.
|
default CompletableFuture<PutEncryptionConfigResponse> |
putEncryptionConfig(PutEncryptionConfigRequest putEncryptionConfigRequest)
Updates the encryption configuration for X-Ray data.
|
default CompletableFuture<PutTelemetryRecordsResponse> |
putTelemetryRecords(Consumer<PutTelemetryRecordsRequest.Builder> putTelemetryRecordsRequest)
Used by the AWS X-Ray daemon to upload telemetry.
|
default CompletableFuture<PutTelemetryRecordsResponse> |
putTelemetryRecords(PutTelemetryRecordsRequest putTelemetryRecordsRequest)
Used by the AWS X-Ray daemon to upload telemetry.
|
default CompletableFuture<PutTraceSegmentsResponse> |
putTraceSegments(Consumer<PutTraceSegmentsRequest.Builder> putTraceSegmentsRequest)
Uploads segment documents to AWS X-Ray.
|
default CompletableFuture<PutTraceSegmentsResponse> |
putTraceSegments(PutTraceSegmentsRequest putTraceSegmentsRequest)
Uploads segment documents to AWS X-Ray.
|
default CompletableFuture<TagResourceResponse> |
tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Applies tags to an existing AWS X-Ray group or sampling rule.
|
default CompletableFuture<TagResourceResponse> |
tagResource(TagResourceRequest tagResourceRequest)
Applies tags to an existing AWS X-Ray group or sampling rule.
|
default CompletableFuture<UntagResourceResponse> |
untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Removes tags from an AWS X-Ray group or sampling rule.
|
default CompletableFuture<UntagResourceResponse> |
untagResource(UntagResourceRequest untagResourceRequest)
Removes tags from an AWS X-Ray group or sampling rule.
|
default CompletableFuture<UpdateGroupResponse> |
updateGroup(Consumer<UpdateGroupRequest.Builder> updateGroupRequest)
Updates a group resource.
|
default CompletableFuture<UpdateGroupResponse> |
updateGroup(UpdateGroupRequest updateGroupRequest)
Updates a group resource.
|
default CompletableFuture<UpdateSamplingRuleResponse> |
updateSamplingRule(Consumer<UpdateSamplingRuleRequest.Builder> updateSamplingRuleRequest)
Modifies a sampling rule's configuration.
|
default CompletableFuture<UpdateSamplingRuleResponse> |
updateSamplingRule(UpdateSamplingRuleRequest updateSamplingRuleRequest)
Modifies a sampling rule's configuration.
|
serviceName
close
static final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider
.static XRayAsyncClient create()
XRayAsyncClient
with the region loaded from the
DefaultAwsRegionProviderChain
and credentials loaded from the
DefaultCredentialsProvider
.static XRayAsyncClientBuilder builder()
XRayAsyncClient
.default CompletableFuture<BatchGetTracesResponse> 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.
batchGetTracesRequest
- default CompletableFuture<BatchGetTracesResponse> batchGetTraces(Consumer<BatchGetTracesRequest.Builder> 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.
This is a convenience which creates an instance of the BatchGetTracesRequest.Builder
avoiding the need to
create one manually via BatchGetTracesRequest.builder()
batchGetTracesRequest
- A Consumer
that will call methods on BatchGetTracesRequest.Builder
to create a request.default BatchGetTracesPublisher batchGetTracesPaginator(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.
This is a variant of batchGetTraces(software.amazon.awssdk.services.xray.model.BatchGetTracesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.xray.paginators.BatchGetTracesPublisher publisher = client.batchGetTracesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.xray.paginators.BatchGetTracesPublisher publisher = client.batchGetTracesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.xray.model.BatchGetTracesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.xray.model.BatchGetTracesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
batchGetTraces(software.amazon.awssdk.services.xray.model.BatchGetTracesRequest)
operation.
batchGetTracesRequest
- default BatchGetTracesPublisher batchGetTracesPaginator(Consumer<BatchGetTracesRequest.Builder> 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.
This is a variant of batchGetTraces(software.amazon.awssdk.services.xray.model.BatchGetTracesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.xray.paginators.BatchGetTracesPublisher publisher = client.batchGetTracesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.xray.paginators.BatchGetTracesPublisher publisher = client.batchGetTracesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.xray.model.BatchGetTracesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.xray.model.BatchGetTracesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
batchGetTraces(software.amazon.awssdk.services.xray.model.BatchGetTracesRequest)
operation.
This is a convenience which creates an instance of the BatchGetTracesRequest.Builder
avoiding the need to
create one manually via BatchGetTracesRequest.builder()
batchGetTracesRequest
- A Consumer
that will call methods on BatchGetTracesRequest.Builder
to create a request.default CompletableFuture<CreateGroupResponse> createGroup(CreateGroupRequest createGroupRequest)
Creates a group resource with a name and a filter expression.
createGroupRequest
- default CompletableFuture<CreateGroupResponse> createGroup(Consumer<CreateGroupRequest.Builder> createGroupRequest)
Creates a group resource with a name and a filter expression.
This is a convenience which creates an instance of the CreateGroupRequest.Builder
avoiding the need to
create one manually via CreateGroupRequest.builder()
createGroupRequest
- A Consumer
that will call methods on CreateGroupRequest.Builder
to create a request.default CompletableFuture<CreateSamplingRuleResponse> createSamplingRule(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
- default CompletableFuture<CreateSamplingRuleResponse> createSamplingRule(Consumer<CreateSamplingRuleRequest.Builder> 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.
This is a convenience which creates an instance of the CreateSamplingRuleRequest.Builder
avoiding the
need to create one manually via CreateSamplingRuleRequest.builder()
createSamplingRuleRequest
- A Consumer
that will call methods on CreateSamplingRuleRequest.Builder
to create a
request.default CompletableFuture<DeleteGroupResponse> deleteGroup(DeleteGroupRequest deleteGroupRequest)
Deletes a group resource.
deleteGroupRequest
- default CompletableFuture<DeleteGroupResponse> deleteGroup(Consumer<DeleteGroupRequest.Builder> deleteGroupRequest)
Deletes a group resource.
This is a convenience which creates an instance of the DeleteGroupRequest.Builder
avoiding the need to
create one manually via DeleteGroupRequest.builder()
deleteGroupRequest
- A Consumer
that will call methods on DeleteGroupRequest.Builder
to create a request.default CompletableFuture<DeleteSamplingRuleResponse> deleteSamplingRule(DeleteSamplingRuleRequest deleteSamplingRuleRequest)
Deletes a sampling rule.
deleteSamplingRuleRequest
- default CompletableFuture<DeleteSamplingRuleResponse> deleteSamplingRule(Consumer<DeleteSamplingRuleRequest.Builder> deleteSamplingRuleRequest)
Deletes a sampling rule.
This is a convenience which creates an instance of the DeleteSamplingRuleRequest.Builder
avoiding the
need to create one manually via DeleteSamplingRuleRequest.builder()
deleteSamplingRuleRequest
- A Consumer
that will call methods on DeleteSamplingRuleRequest.Builder
to create a
request.default CompletableFuture<GetEncryptionConfigResponse> getEncryptionConfig(GetEncryptionConfigRequest getEncryptionConfigRequest)
Retrieves the current encryption configuration for X-Ray data.
getEncryptionConfigRequest
- default CompletableFuture<GetEncryptionConfigResponse> getEncryptionConfig(Consumer<GetEncryptionConfigRequest.Builder> getEncryptionConfigRequest)
Retrieves the current encryption configuration for X-Ray data.
This is a convenience which creates an instance of the GetEncryptionConfigRequest.Builder
avoiding the
need to create one manually via GetEncryptionConfigRequest.builder()
getEncryptionConfigRequest
- A Consumer
that will call methods on GetEncryptionConfigRequest.Builder
to create a
request.default CompletableFuture<GetEncryptionConfigResponse> getEncryptionConfig()
Retrieves the current encryption configuration for X-Ray data.
default CompletableFuture<GetGroupResponse> getGroup(GetGroupRequest getGroupRequest)
Retrieves group resource details.
getGroupRequest
- default CompletableFuture<GetGroupResponse> getGroup(Consumer<GetGroupRequest.Builder> getGroupRequest)
Retrieves group resource details.
This is a convenience which creates an instance of the GetGroupRequest.Builder
avoiding the need to
create one manually via GetGroupRequest.builder()
getGroupRequest
- A Consumer
that will call methods on GetGroupRequest.Builder
to create a request.default CompletableFuture<GetGroupsResponse> getGroups(GetGroupsRequest getGroupsRequest)
Retrieves all active group details.
getGroupsRequest
- default CompletableFuture<GetGroupsResponse> getGroups(Consumer<GetGroupsRequest.Builder> getGroupsRequest)
Retrieves all active group details.
This is a convenience which creates an instance of the GetGroupsRequest.Builder
avoiding the need to
create one manually via GetGroupsRequest.builder()
getGroupsRequest
- A Consumer
that will call methods on GetGroupsRequest.Builder
to create a request.default CompletableFuture<GetGroupsResponse> getGroups()
Retrieves all active group details.
default GetGroupsPublisher getGroupsPaginator()
Retrieves all active group details.
This is a variant of getGroups(software.amazon.awssdk.services.xray.model.GetGroupsRequest)
operation.
The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.xray.paginators.GetGroupsPublisher publisher = client.getGroupsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.xray.paginators.GetGroupsPublisher publisher = client.getGroupsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.xray.model.GetGroupsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.xray.model.GetGroupsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getGroups(software.amazon.awssdk.services.xray.model.GetGroupsRequest)
operation.
default GetGroupsPublisher getGroupsPaginator(GetGroupsRequest getGroupsRequest)
Retrieves all active group details.
This is a variant of getGroups(software.amazon.awssdk.services.xray.model.GetGroupsRequest)
operation.
The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.xray.paginators.GetGroupsPublisher publisher = client.getGroupsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.xray.paginators.GetGroupsPublisher publisher = client.getGroupsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.xray.model.GetGroupsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.xray.model.GetGroupsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getGroups(software.amazon.awssdk.services.xray.model.GetGroupsRequest)
operation.
getGroupsRequest
- default GetGroupsPublisher getGroupsPaginator(Consumer<GetGroupsRequest.Builder> getGroupsRequest)
Retrieves all active group details.
This is a variant of getGroups(software.amazon.awssdk.services.xray.model.GetGroupsRequest)
operation.
The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.xray.paginators.GetGroupsPublisher publisher = client.getGroupsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.xray.paginators.GetGroupsPublisher publisher = client.getGroupsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.xray.model.GetGroupsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.xray.model.GetGroupsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getGroups(software.amazon.awssdk.services.xray.model.GetGroupsRequest)
operation.
This is a convenience which creates an instance of the GetGroupsRequest.Builder
avoiding the need to
create one manually via GetGroupsRequest.builder()
getGroupsRequest
- A Consumer
that will call methods on GetGroupsRequest.Builder
to create a request.default CompletableFuture<GetInsightResponse> getInsight(GetInsightRequest getInsightRequest)
Retrieves the summary information of an insight. This includes impact to clients and root cause services, the top anomalous services, the category, the state of the insight, and the start and end time of the insight.
getInsightRequest
- default CompletableFuture<GetInsightResponse> getInsight(Consumer<GetInsightRequest.Builder> getInsightRequest)
Retrieves the summary information of an insight. This includes impact to clients and root cause services, the top anomalous services, the category, the state of the insight, and the start and end time of the insight.
This is a convenience which creates an instance of the GetInsightRequest.Builder
avoiding the need to
create one manually via GetInsightRequest.builder()
getInsightRequest
- A Consumer
that will call methods on GetInsightRequest.Builder
to create a request.default CompletableFuture<GetInsightEventsResponse> getInsightEvents(GetInsightEventsRequest getInsightEventsRequest)
X-Ray reevaluates insights periodically until they're resolved, and records each intermediate state as an event. You can review an insight's events in the Impact Timeline on the Inspect page in the X-Ray console.
getInsightEventsRequest
- default CompletableFuture<GetInsightEventsResponse> getInsightEvents(Consumer<GetInsightEventsRequest.Builder> getInsightEventsRequest)
X-Ray reevaluates insights periodically until they're resolved, and records each intermediate state as an event. You can review an insight's events in the Impact Timeline on the Inspect page in the X-Ray console.
This is a convenience which creates an instance of the GetInsightEventsRequest.Builder
avoiding the need
to create one manually via GetInsightEventsRequest.builder()
getInsightEventsRequest
- A Consumer
that will call methods on GetInsightEventsRequest.Builder
to create a request.default GetInsightEventsPublisher getInsightEventsPaginator(GetInsightEventsRequest getInsightEventsRequest)
X-Ray reevaluates insights periodically until they're resolved, and records each intermediate state as an event. You can review an insight's events in the Impact Timeline on the Inspect page in the X-Ray console.
This is a variant of
getInsightEvents(software.amazon.awssdk.services.xray.model.GetInsightEventsRequest)
operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.xray.paginators.GetInsightEventsPublisher publisher = client.getInsightEventsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.xray.paginators.GetInsightEventsPublisher publisher = client.getInsightEventsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.xray.model.GetInsightEventsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.xray.model.GetInsightEventsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getInsightEvents(software.amazon.awssdk.services.xray.model.GetInsightEventsRequest)
operation.
getInsightEventsRequest
- default GetInsightEventsPublisher getInsightEventsPaginator(Consumer<GetInsightEventsRequest.Builder> getInsightEventsRequest)
X-Ray reevaluates insights periodically until they're resolved, and records each intermediate state as an event. You can review an insight's events in the Impact Timeline on the Inspect page in the X-Ray console.
This is a variant of
getInsightEvents(software.amazon.awssdk.services.xray.model.GetInsightEventsRequest)
operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.xray.paginators.GetInsightEventsPublisher publisher = client.getInsightEventsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.xray.paginators.GetInsightEventsPublisher publisher = client.getInsightEventsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.xray.model.GetInsightEventsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.xray.model.GetInsightEventsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getInsightEvents(software.amazon.awssdk.services.xray.model.GetInsightEventsRequest)
operation.
This is a convenience which creates an instance of the GetInsightEventsRequest.Builder
avoiding the need
to create one manually via GetInsightEventsRequest.builder()
getInsightEventsRequest
- A Consumer
that will call methods on GetInsightEventsRequest.Builder
to create a request.default CompletableFuture<GetInsightImpactGraphResponse> getInsightImpactGraph(GetInsightImpactGraphRequest getInsightImpactGraphRequest)
Retrieves a service graph structure filtered by the specified insight. The service graph is limited to only structural information. For a complete service graph, use this API with the GetServiceGraph API.
getInsightImpactGraphRequest
- default CompletableFuture<GetInsightImpactGraphResponse> getInsightImpactGraph(Consumer<GetInsightImpactGraphRequest.Builder> getInsightImpactGraphRequest)
Retrieves a service graph structure filtered by the specified insight. The service graph is limited to only structural information. For a complete service graph, use this API with the GetServiceGraph API.
This is a convenience which creates an instance of the GetInsightImpactGraphRequest.Builder
avoiding the
need to create one manually via GetInsightImpactGraphRequest.builder()
getInsightImpactGraphRequest
- A Consumer
that will call methods on GetInsightImpactGraphRequest.Builder
to create a
request.default CompletableFuture<GetInsightSummariesResponse> getInsightSummaries(GetInsightSummariesRequest getInsightSummariesRequest)
Retrieves the summaries of all insights in the specified group matching the provided filter values.
getInsightSummariesRequest
- default CompletableFuture<GetInsightSummariesResponse> getInsightSummaries(Consumer<GetInsightSummariesRequest.Builder> getInsightSummariesRequest)
Retrieves the summaries of all insights in the specified group matching the provided filter values.
This is a convenience which creates an instance of the GetInsightSummariesRequest.Builder
avoiding the
need to create one manually via GetInsightSummariesRequest.builder()
getInsightSummariesRequest
- A Consumer
that will call methods on GetInsightSummariesRequest.Builder
to create a
request.default GetInsightSummariesPublisher getInsightSummariesPaginator(GetInsightSummariesRequest getInsightSummariesRequest)
Retrieves the summaries of all insights in the specified group matching the provided filter values.
This is a variant of
getInsightSummaries(software.amazon.awssdk.services.xray.model.GetInsightSummariesRequest)
operation.
The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.xray.paginators.GetInsightSummariesPublisher publisher = client.getInsightSummariesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.xray.paginators.GetInsightSummariesPublisher publisher = client.getInsightSummariesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.xray.model.GetInsightSummariesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.xray.model.GetInsightSummariesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getInsightSummaries(software.amazon.awssdk.services.xray.model.GetInsightSummariesRequest)
operation.
getInsightSummariesRequest
- default GetInsightSummariesPublisher getInsightSummariesPaginator(Consumer<GetInsightSummariesRequest.Builder> getInsightSummariesRequest)
Retrieves the summaries of all insights in the specified group matching the provided filter values.
This is a variant of
getInsightSummaries(software.amazon.awssdk.services.xray.model.GetInsightSummariesRequest)
operation.
The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.xray.paginators.GetInsightSummariesPublisher publisher = client.getInsightSummariesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.xray.paginators.GetInsightSummariesPublisher publisher = client.getInsightSummariesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.xray.model.GetInsightSummariesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.xray.model.GetInsightSummariesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getInsightSummaries(software.amazon.awssdk.services.xray.model.GetInsightSummariesRequest)
operation.
This is a convenience which creates an instance of the GetInsightSummariesRequest.Builder
avoiding the
need to create one manually via GetInsightSummariesRequest.builder()
getInsightSummariesRequest
- A Consumer
that will call methods on GetInsightSummariesRequest.Builder
to create a
request.default CompletableFuture<GetSamplingRulesResponse> getSamplingRules(GetSamplingRulesRequest getSamplingRulesRequest)
Retrieves all sampling rules.
getSamplingRulesRequest
- default CompletableFuture<GetSamplingRulesResponse> getSamplingRules(Consumer<GetSamplingRulesRequest.Builder> getSamplingRulesRequest)
Retrieves all sampling rules.
This is a convenience which creates an instance of the GetSamplingRulesRequest.Builder
avoiding the need
to create one manually via GetSamplingRulesRequest.builder()
getSamplingRulesRequest
- A Consumer
that will call methods on GetSamplingRulesRequest.Builder
to create a request.default CompletableFuture<GetSamplingRulesResponse> getSamplingRules()
Retrieves all sampling rules.
default GetSamplingRulesPublisher getSamplingRulesPaginator()
Retrieves all sampling rules.
This is a variant of
getSamplingRules(software.amazon.awssdk.services.xray.model.GetSamplingRulesRequest)
operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.xray.paginators.GetSamplingRulesPublisher publisher = client.getSamplingRulesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.xray.paginators.GetSamplingRulesPublisher publisher = client.getSamplingRulesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.xray.model.GetSamplingRulesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.xray.model.GetSamplingRulesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getSamplingRules(software.amazon.awssdk.services.xray.model.GetSamplingRulesRequest)
operation.
default GetSamplingRulesPublisher getSamplingRulesPaginator(GetSamplingRulesRequest getSamplingRulesRequest)
Retrieves all sampling rules.
This is a variant of
getSamplingRules(software.amazon.awssdk.services.xray.model.GetSamplingRulesRequest)
operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.xray.paginators.GetSamplingRulesPublisher publisher = client.getSamplingRulesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.xray.paginators.GetSamplingRulesPublisher publisher = client.getSamplingRulesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.xray.model.GetSamplingRulesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.xray.model.GetSamplingRulesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getSamplingRules(software.amazon.awssdk.services.xray.model.GetSamplingRulesRequest)
operation.
getSamplingRulesRequest
- default GetSamplingRulesPublisher getSamplingRulesPaginator(Consumer<GetSamplingRulesRequest.Builder> getSamplingRulesRequest)
Retrieves all sampling rules.
This is a variant of
getSamplingRules(software.amazon.awssdk.services.xray.model.GetSamplingRulesRequest)
operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.xray.paginators.GetSamplingRulesPublisher publisher = client.getSamplingRulesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.xray.paginators.GetSamplingRulesPublisher publisher = client.getSamplingRulesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.xray.model.GetSamplingRulesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.xray.model.GetSamplingRulesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getSamplingRules(software.amazon.awssdk.services.xray.model.GetSamplingRulesRequest)
operation.
This is a convenience which creates an instance of the GetSamplingRulesRequest.Builder
avoiding the need
to create one manually via GetSamplingRulesRequest.builder()
getSamplingRulesRequest
- A Consumer
that will call methods on GetSamplingRulesRequest.Builder
to create a request.default CompletableFuture<GetSamplingStatisticSummariesResponse> getSamplingStatisticSummaries(GetSamplingStatisticSummariesRequest getSamplingStatisticSummariesRequest)
Retrieves information about recent sampling results for all sampling rules.
getSamplingStatisticSummariesRequest
- default CompletableFuture<GetSamplingStatisticSummariesResponse> getSamplingStatisticSummaries(Consumer<GetSamplingStatisticSummariesRequest.Builder> getSamplingStatisticSummariesRequest)
Retrieves information about recent sampling results for all sampling rules.
This is a convenience which creates an instance of the GetSamplingStatisticSummariesRequest.Builder
avoiding the need to create one manually via GetSamplingStatisticSummariesRequest.builder()
getSamplingStatisticSummariesRequest
- A Consumer
that will call methods on GetSamplingStatisticSummariesRequest.Builder
to
create a request.default CompletableFuture<GetSamplingStatisticSummariesResponse> getSamplingStatisticSummaries()
Retrieves information about recent sampling results for all sampling rules.
default GetSamplingStatisticSummariesPublisher getSamplingStatisticSummariesPaginator()
Retrieves information about recent sampling results for all sampling rules.
This is a variant of
getSamplingStatisticSummaries(software.amazon.awssdk.services.xray.model.GetSamplingStatisticSummariesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.xray.paginators.GetSamplingStatisticSummariesPublisher publisher = client.getSamplingStatisticSummariesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.xray.paginators.GetSamplingStatisticSummariesPublisher publisher = client.getSamplingStatisticSummariesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.xray.model.GetSamplingStatisticSummariesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.xray.model.GetSamplingStatisticSummariesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getSamplingStatisticSummaries(software.amazon.awssdk.services.xray.model.GetSamplingStatisticSummariesRequest)
operation.
default GetSamplingStatisticSummariesPublisher getSamplingStatisticSummariesPaginator(GetSamplingStatisticSummariesRequest getSamplingStatisticSummariesRequest)
Retrieves information about recent sampling results for all sampling rules.
This is a variant of
getSamplingStatisticSummaries(software.amazon.awssdk.services.xray.model.GetSamplingStatisticSummariesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.xray.paginators.GetSamplingStatisticSummariesPublisher publisher = client.getSamplingStatisticSummariesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.xray.paginators.GetSamplingStatisticSummariesPublisher publisher = client.getSamplingStatisticSummariesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.xray.model.GetSamplingStatisticSummariesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.xray.model.GetSamplingStatisticSummariesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getSamplingStatisticSummaries(software.amazon.awssdk.services.xray.model.GetSamplingStatisticSummariesRequest)
operation.
getSamplingStatisticSummariesRequest
- default GetSamplingStatisticSummariesPublisher getSamplingStatisticSummariesPaginator(Consumer<GetSamplingStatisticSummariesRequest.Builder> getSamplingStatisticSummariesRequest)
Retrieves information about recent sampling results for all sampling rules.
This is a variant of
getSamplingStatisticSummaries(software.amazon.awssdk.services.xray.model.GetSamplingStatisticSummariesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.xray.paginators.GetSamplingStatisticSummariesPublisher publisher = client.getSamplingStatisticSummariesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.xray.paginators.GetSamplingStatisticSummariesPublisher publisher = client.getSamplingStatisticSummariesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.xray.model.GetSamplingStatisticSummariesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.xray.model.GetSamplingStatisticSummariesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getSamplingStatisticSummaries(software.amazon.awssdk.services.xray.model.GetSamplingStatisticSummariesRequest)
operation.
This is a convenience which creates an instance of the GetSamplingStatisticSummariesRequest.Builder
avoiding the need to create one manually via GetSamplingStatisticSummariesRequest.builder()
getSamplingStatisticSummariesRequest
- A Consumer
that will call methods on GetSamplingStatisticSummariesRequest.Builder
to
create a request.default CompletableFuture<GetSamplingTargetsResponse> getSamplingTargets(GetSamplingTargetsRequest getSamplingTargetsRequest)
Requests a sampling quota for rules that the service is using to sample requests.
getSamplingTargetsRequest
- default CompletableFuture<GetSamplingTargetsResponse> getSamplingTargets(Consumer<GetSamplingTargetsRequest.Builder> getSamplingTargetsRequest)
Requests a sampling quota for rules that the service is using to sample requests.
This is a convenience which creates an instance of the GetSamplingTargetsRequest.Builder
avoiding the
need to create one manually via GetSamplingTargetsRequest.builder()
getSamplingTargetsRequest
- A Consumer
that will call methods on GetSamplingTargetsRequest.Builder
to create a
request.default CompletableFuture<GetServiceGraphResponse> 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.
getServiceGraphRequest
- default CompletableFuture<GetServiceGraphResponse> getServiceGraph(Consumer<GetServiceGraphRequest.Builder> 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.
This is a convenience which creates an instance of the GetServiceGraphRequest.Builder
avoiding the need
to create one manually via GetServiceGraphRequest.builder()
getServiceGraphRequest
- A Consumer
that will call methods on GetServiceGraphRequest.Builder
to create a request.default GetServiceGraphPublisher getServiceGraphPaginator(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.
This is a variant of getServiceGraph(software.amazon.awssdk.services.xray.model.GetServiceGraphRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.xray.paginators.GetServiceGraphPublisher publisher = client.getServiceGraphPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.xray.paginators.GetServiceGraphPublisher publisher = client.getServiceGraphPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.xray.model.GetServiceGraphResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.xray.model.GetServiceGraphResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getServiceGraph(software.amazon.awssdk.services.xray.model.GetServiceGraphRequest)
operation.
getServiceGraphRequest
- default GetServiceGraphPublisher getServiceGraphPaginator(Consumer<GetServiceGraphRequest.Builder> 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.
This is a variant of getServiceGraph(software.amazon.awssdk.services.xray.model.GetServiceGraphRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.xray.paginators.GetServiceGraphPublisher publisher = client.getServiceGraphPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.xray.paginators.GetServiceGraphPublisher publisher = client.getServiceGraphPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.xray.model.GetServiceGraphResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.xray.model.GetServiceGraphResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getServiceGraph(software.amazon.awssdk.services.xray.model.GetServiceGraphRequest)
operation.
This is a convenience which creates an instance of the GetServiceGraphRequest.Builder
avoiding the need
to create one manually via GetServiceGraphRequest.builder()
getServiceGraphRequest
- A Consumer
that will call methods on GetServiceGraphRequest.Builder
to create a request.default CompletableFuture<GetTimeSeriesServiceStatisticsResponse> getTimeSeriesServiceStatistics(GetTimeSeriesServiceStatisticsRequest getTimeSeriesServiceStatisticsRequest)
Get an aggregation of service statistics defined by a specific time range.
getTimeSeriesServiceStatisticsRequest
- default CompletableFuture<GetTimeSeriesServiceStatisticsResponse> getTimeSeriesServiceStatistics(Consumer<GetTimeSeriesServiceStatisticsRequest.Builder> getTimeSeriesServiceStatisticsRequest)
Get an aggregation of service statistics defined by a specific time range.
This is a convenience which creates an instance of the GetTimeSeriesServiceStatisticsRequest.Builder
avoiding the need to create one manually via GetTimeSeriesServiceStatisticsRequest.builder()
getTimeSeriesServiceStatisticsRequest
- A Consumer
that will call methods on GetTimeSeriesServiceStatisticsRequest.Builder
to
create a request.default GetTimeSeriesServiceStatisticsPublisher getTimeSeriesServiceStatisticsPaginator(GetTimeSeriesServiceStatisticsRequest getTimeSeriesServiceStatisticsRequest)
Get an aggregation of service statistics defined by a specific time range.
This is a variant of
getTimeSeriesServiceStatistics(software.amazon.awssdk.services.xray.model.GetTimeSeriesServiceStatisticsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.xray.paginators.GetTimeSeriesServiceStatisticsPublisher publisher = client.getTimeSeriesServiceStatisticsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.xray.paginators.GetTimeSeriesServiceStatisticsPublisher publisher = client.getTimeSeriesServiceStatisticsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.xray.model.GetTimeSeriesServiceStatisticsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.xray.model.GetTimeSeriesServiceStatisticsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getTimeSeriesServiceStatistics(software.amazon.awssdk.services.xray.model.GetTimeSeriesServiceStatisticsRequest)
operation.
getTimeSeriesServiceStatisticsRequest
- default GetTimeSeriesServiceStatisticsPublisher getTimeSeriesServiceStatisticsPaginator(Consumer<GetTimeSeriesServiceStatisticsRequest.Builder> getTimeSeriesServiceStatisticsRequest)
Get an aggregation of service statistics defined by a specific time range.
This is a variant of
getTimeSeriesServiceStatistics(software.amazon.awssdk.services.xray.model.GetTimeSeriesServiceStatisticsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.xray.paginators.GetTimeSeriesServiceStatisticsPublisher publisher = client.getTimeSeriesServiceStatisticsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.xray.paginators.GetTimeSeriesServiceStatisticsPublisher publisher = client.getTimeSeriesServiceStatisticsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.xray.model.GetTimeSeriesServiceStatisticsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.xray.model.GetTimeSeriesServiceStatisticsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getTimeSeriesServiceStatistics(software.amazon.awssdk.services.xray.model.GetTimeSeriesServiceStatisticsRequest)
operation.
This is a convenience which creates an instance of the GetTimeSeriesServiceStatisticsRequest.Builder
avoiding the need to create one manually via GetTimeSeriesServiceStatisticsRequest.builder()
getTimeSeriesServiceStatisticsRequest
- A Consumer
that will call methods on GetTimeSeriesServiceStatisticsRequest.Builder
to
create a request.default CompletableFuture<GetTraceGraphResponse> getTraceGraph(GetTraceGraphRequest getTraceGraphRequest)
Retrieves a service graph for one or more specific trace IDs.
getTraceGraphRequest
- default CompletableFuture<GetTraceGraphResponse> getTraceGraph(Consumer<GetTraceGraphRequest.Builder> getTraceGraphRequest)
Retrieves a service graph for one or more specific trace IDs.
This is a convenience which creates an instance of the GetTraceGraphRequest.Builder
avoiding the need to
create one manually via GetTraceGraphRequest.builder()
getTraceGraphRequest
- A Consumer
that will call methods on GetTraceGraphRequest.Builder
to create a request.default GetTraceGraphPublisher getTraceGraphPaginator(GetTraceGraphRequest getTraceGraphRequest)
Retrieves a service graph for one or more specific trace IDs.
This is a variant of getTraceGraph(software.amazon.awssdk.services.xray.model.GetTraceGraphRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.xray.paginators.GetTraceGraphPublisher publisher = client.getTraceGraphPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.xray.paginators.GetTraceGraphPublisher publisher = client.getTraceGraphPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.xray.model.GetTraceGraphResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.xray.model.GetTraceGraphResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getTraceGraph(software.amazon.awssdk.services.xray.model.GetTraceGraphRequest)
operation.
getTraceGraphRequest
- default GetTraceGraphPublisher getTraceGraphPaginator(Consumer<GetTraceGraphRequest.Builder> getTraceGraphRequest)
Retrieves a service graph for one or more specific trace IDs.
This is a variant of getTraceGraph(software.amazon.awssdk.services.xray.model.GetTraceGraphRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.xray.paginators.GetTraceGraphPublisher publisher = client.getTraceGraphPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.xray.paginators.GetTraceGraphPublisher publisher = client.getTraceGraphPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.xray.model.GetTraceGraphResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.xray.model.GetTraceGraphResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getTraceGraph(software.amazon.awssdk.services.xray.model.GetTraceGraphRequest)
operation.
This is a convenience which creates an instance of the GetTraceGraphRequest.Builder
avoiding the need to
create one manually via GetTraceGraphRequest.builder()
getTraceGraphRequest
- A Consumer
that will call methods on GetTraceGraphRequest.Builder
to create a request.default CompletableFuture<GetTraceSummariesResponse> getTraceSummaries(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
- default CompletableFuture<GetTraceSummariesResponse> getTraceSummaries(Consumer<GetTraceSummariesRequest.Builder> 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.
This is a convenience which creates an instance of the GetTraceSummariesRequest.Builder
avoiding the need
to create one manually via GetTraceSummariesRequest.builder()
getTraceSummariesRequest
- A Consumer
that will call methods on GetTraceSummariesRequest.Builder
to create a request.default GetTraceSummariesPublisher getTraceSummariesPaginator(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.
This is a variant of
getTraceSummaries(software.amazon.awssdk.services.xray.model.GetTraceSummariesRequest)
operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.xray.paginators.GetTraceSummariesPublisher publisher = client.getTraceSummariesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.xray.paginators.GetTraceSummariesPublisher publisher = client.getTraceSummariesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.xray.model.GetTraceSummariesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.xray.model.GetTraceSummariesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getTraceSummaries(software.amazon.awssdk.services.xray.model.GetTraceSummariesRequest)
operation.
getTraceSummariesRequest
- default GetTraceSummariesPublisher getTraceSummariesPaginator(Consumer<GetTraceSummariesRequest.Builder> 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.
This is a variant of
getTraceSummaries(software.amazon.awssdk.services.xray.model.GetTraceSummariesRequest)
operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.xray.paginators.GetTraceSummariesPublisher publisher = client.getTraceSummariesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.xray.paginators.GetTraceSummariesPublisher publisher = client.getTraceSummariesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.xray.model.GetTraceSummariesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.xray.model.GetTraceSummariesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getTraceSummaries(software.amazon.awssdk.services.xray.model.GetTraceSummariesRequest)
operation.
This is a convenience which creates an instance of the GetTraceSummariesRequest.Builder
avoiding the need
to create one manually via GetTraceSummariesRequest.builder()
getTraceSummariesRequest
- A Consumer
that will call methods on GetTraceSummariesRequest.Builder
to create a request.default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Returns a list of tags that are applied to the specified AWS X-Ray group or sampling rule.
listTagsForResourceRequest
- default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Returns a list of tags that are applied to the specified AWS X-Ray group or sampling rule.
This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder
avoiding the
need to create one manually via ListTagsForResourceRequest.builder()
listTagsForResourceRequest
- A Consumer
that will call methods on ListTagsForResourceRequest.Builder
to create a
request.default CompletableFuture<PutEncryptionConfigResponse> putEncryptionConfig(PutEncryptionConfigRequest putEncryptionConfigRequest)
Updates the encryption configuration for X-Ray data.
putEncryptionConfigRequest
- default CompletableFuture<PutEncryptionConfigResponse> putEncryptionConfig(Consumer<PutEncryptionConfigRequest.Builder> putEncryptionConfigRequest)
Updates the encryption configuration for X-Ray data.
This is a convenience which creates an instance of the PutEncryptionConfigRequest.Builder
avoiding the
need to create one manually via PutEncryptionConfigRequest.builder()
putEncryptionConfigRequest
- A Consumer
that will call methods on PutEncryptionConfigRequest.Builder
to create a
request.default CompletableFuture<PutTelemetryRecordsResponse> putTelemetryRecords(PutTelemetryRecordsRequest putTelemetryRecordsRequest)
Used by the AWS X-Ray daemon to upload telemetry.
putTelemetryRecordsRequest
- default CompletableFuture<PutTelemetryRecordsResponse> putTelemetryRecords(Consumer<PutTelemetryRecordsRequest.Builder> putTelemetryRecordsRequest)
Used by the AWS X-Ray daemon to upload telemetry.
This is a convenience which creates an instance of the PutTelemetryRecordsRequest.Builder
avoiding the
need to create one manually via PutTelemetryRecordsRequest.builder()
putTelemetryRecordsRequest
- A Consumer
that will call methods on PutTelemetryRecordsRequest.Builder
to create a
request.default CompletableFuture<PutTraceSegmentsResponse> 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.
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 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, for instance, 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
- default CompletableFuture<PutTraceSegmentsResponse> putTraceSegments(Consumer<PutTraceSegmentsRequest.Builder> 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 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, for instance, 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.
This is a convenience which creates an instance of the PutTraceSegmentsRequest.Builder
avoiding the need
to create one manually via PutTraceSegmentsRequest.builder()
putTraceSegmentsRequest
- A Consumer
that will call methods on PutTraceSegmentsRequest.Builder
to create a request.default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest)
Applies tags to an existing AWS X-Ray group or sampling rule.
tagResourceRequest
- default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Applies tags to an existing AWS X-Ray group or sampling rule.
This is a convenience which creates an instance of the TagResourceRequest.Builder
avoiding the need to
create one manually via TagResourceRequest.builder()
tagResourceRequest
- A Consumer
that will call methods on TagResourceRequest.Builder
to create a request.default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest)
Removes tags from an AWS X-Ray group or sampling rule. You cannot edit or delete system tags (those with an
aws:
prefix).
untagResourceRequest
- default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Removes tags from an AWS X-Ray group or sampling rule. You cannot edit or delete system tags (those with an
aws:
prefix).
This is a convenience which creates an instance of the UntagResourceRequest.Builder
avoiding the need to
create one manually via UntagResourceRequest.builder()
untagResourceRequest
- A Consumer
that will call methods on UntagResourceRequest.Builder
to create a request.default CompletableFuture<UpdateGroupResponse> updateGroup(UpdateGroupRequest updateGroupRequest)
Updates a group resource.
updateGroupRequest
- default CompletableFuture<UpdateGroupResponse> updateGroup(Consumer<UpdateGroupRequest.Builder> updateGroupRequest)
Updates a group resource.
This is a convenience which creates an instance of the UpdateGroupRequest.Builder
avoiding the need to
create one manually via UpdateGroupRequest.builder()
updateGroupRequest
- A Consumer
that will call methods on UpdateGroupRequest.Builder
to create a request.default CompletableFuture<UpdateSamplingRuleResponse> updateSamplingRule(UpdateSamplingRuleRequest updateSamplingRuleRequest)
Modifies a sampling rule's configuration.
updateSamplingRuleRequest
- default CompletableFuture<UpdateSamplingRuleResponse> updateSamplingRule(Consumer<UpdateSamplingRuleRequest.Builder> updateSamplingRuleRequest)
Modifies a sampling rule's configuration.
This is a convenience which creates an instance of the UpdateSamplingRuleRequest.Builder
avoiding the
need to create one manually via UpdateSamplingRuleRequest.builder()
updateSamplingRuleRequest
- A Consumer
that will call methods on UpdateSamplingRuleRequest.Builder
to create a
request.