Interface XRayAsyncClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.The asynchronous client performs non-blocking I/O when configured with any SdkAsyncHttpClient
supported in the SDK. However, full non-blocking is not guaranteed as the async client may perform blocking calls in
some cases such as credentials retrieval and endpoint discovery as part of the async API call.
Amazon Web Services X-Ray provides APIs for managing debug traces and retrieving service maps and other data created by processing those traces.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptiondefault CompletableFuture
<BatchGetTracesResponse> batchGetTraces
(Consumer<BatchGetTracesRequest.Builder> batchGetTracesRequest) Retrieves a list of traces specified by ID.default CompletableFuture
<BatchGetTracesResponse> batchGetTraces
(BatchGetTracesRequest batchGetTracesRequest) Retrieves a list of traces specified by ID.default BatchGetTracesPublisher
batchGetTracesPaginator
(Consumer<BatchGetTracesRequest.Builder> batchGetTracesRequest) This is a variant ofbatchGetTraces(software.amazon.awssdk.services.xray.model.BatchGetTracesRequest)
operation.default BatchGetTracesPublisher
batchGetTracesPaginator
(BatchGetTracesRequest batchGetTracesRequest) This is a variant ofbatchGetTraces(software.amazon.awssdk.services.xray.model.BatchGetTracesRequest)
operation.static XRayAsyncClientBuilder
builder()
Create a builder that can be used to configure and create aXRayAsyncClient
.static XRayAsyncClient
create()
Create aXRayAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.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.createSamplingRule
(Consumer<CreateSamplingRuleRequest.Builder> createSamplingRuleRequest) Creates a rule to control sampling behavior for instrumented applications.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.deleteResourcePolicy
(Consumer<DeleteResourcePolicyRequest.Builder> deleteResourcePolicyRequest) Deletes a resource policy from the target Amazon Web Services account.deleteResourcePolicy
(DeleteResourcePolicyRequest deleteResourcePolicyRequest) Deletes a resource policy from the target Amazon Web Services account.deleteSamplingRule
(Consumer<DeleteSamplingRuleRequest.Builder> deleteSamplingRuleRequest) Deletes a sampling rule.deleteSamplingRule
(DeleteSamplingRuleRequest deleteSamplingRuleRequest) Deletes a sampling rule.Retrieves the current encryption configuration for X-Ray data.getEncryptionConfig
(Consumer<GetEncryptionConfigRequest.Builder> getEncryptionConfigRequest) Retrieves the current encryption configuration for X-Ray data.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> 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
This is a variant ofgetGroups(software.amazon.awssdk.services.xray.model.GetGroupsRequest)
operation.default GetGroupsPublisher
getGroupsPaginator
(Consumer<GetGroupsRequest.Builder> getGroupsRequest) This is a variant ofgetGroups(software.amazon.awssdk.services.xray.model.GetGroupsRequest)
operation.default GetGroupsPublisher
getGroupsPaginator
(GetGroupsRequest getGroupsRequest) This is a variant ofgetGroups(software.amazon.awssdk.services.xray.model.GetGroupsRequest)
operation.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.getInsightEvents
(Consumer<GetInsightEventsRequest.Builder> getInsightEventsRequest) X-Ray reevaluates insights periodically until they're resolved, and records each intermediate state as an event.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) This is a variant ofgetInsightEvents(software.amazon.awssdk.services.xray.model.GetInsightEventsRequest)
operation.default GetInsightEventsPublisher
getInsightEventsPaginator
(GetInsightEventsRequest getInsightEventsRequest) This is a variant ofgetInsightEvents(software.amazon.awssdk.services.xray.model.GetInsightEventsRequest)
operation.getInsightImpactGraph
(Consumer<GetInsightImpactGraphRequest.Builder> getInsightImpactGraphRequest) Retrieves a service graph structure filtered by the specified insight.getInsightImpactGraph
(GetInsightImpactGraphRequest getInsightImpactGraphRequest) Retrieves a service graph structure filtered by the specified insight.getInsightSummaries
(Consumer<GetInsightSummariesRequest.Builder> getInsightSummariesRequest) Retrieves the summaries of all insights in the specified group matching the provided filter values.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) This is a variant ofgetInsightSummaries(software.amazon.awssdk.services.xray.model.GetInsightSummariesRequest)
operation.default GetInsightSummariesPublisher
getInsightSummariesPaginator
(GetInsightSummariesRequest getInsightSummariesRequest) This is a variant ofgetInsightSummaries(software.amazon.awssdk.services.xray.model.GetInsightSummariesRequest)
operation.Retrieves all sampling rules.getSamplingRules
(Consumer<GetSamplingRulesRequest.Builder> getSamplingRulesRequest) Retrieves all sampling rules.getSamplingRules
(GetSamplingRulesRequest getSamplingRulesRequest) Retrieves all sampling rules.default GetSamplingRulesPublisher
This is a variant ofgetSamplingRules(software.amazon.awssdk.services.xray.model.GetSamplingRulesRequest)
operation.default GetSamplingRulesPublisher
getSamplingRulesPaginator
(Consumer<GetSamplingRulesRequest.Builder> getSamplingRulesRequest) This is a variant ofgetSamplingRules(software.amazon.awssdk.services.xray.model.GetSamplingRulesRequest)
operation.default GetSamplingRulesPublisher
getSamplingRulesPaginator
(GetSamplingRulesRequest getSamplingRulesRequest) This is a variant ofgetSamplingRules(software.amazon.awssdk.services.xray.model.GetSamplingRulesRequest)
operation.Retrieves information about recent sampling results for all sampling rules.getSamplingStatisticSummaries
(Consumer<GetSamplingStatisticSummariesRequest.Builder> getSamplingStatisticSummariesRequest) Retrieves information about recent sampling results for all sampling rules.getSamplingStatisticSummaries
(GetSamplingStatisticSummariesRequest getSamplingStatisticSummariesRequest) Retrieves information about recent sampling results for all sampling rules.This is a variant ofgetSamplingStatisticSummaries(software.amazon.awssdk.services.xray.model.GetSamplingStatisticSummariesRequest)
operation.getSamplingStatisticSummariesPaginator
(Consumer<GetSamplingStatisticSummariesRequest.Builder> getSamplingStatisticSummariesRequest) This is a variant ofgetSamplingStatisticSummaries(software.amazon.awssdk.services.xray.model.GetSamplingStatisticSummariesRequest)
operation.getSamplingStatisticSummariesPaginator
(GetSamplingStatisticSummariesRequest getSamplingStatisticSummariesRequest) This is a variant ofgetSamplingStatisticSummaries(software.amazon.awssdk.services.xray.model.GetSamplingStatisticSummariesRequest)
operation.getSamplingTargets
(Consumer<GetSamplingTargetsRequest.Builder> getSamplingTargetsRequest) Requests a sampling quota for rules that the service is using to sample requests.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) This is a variant ofgetServiceGraph(software.amazon.awssdk.services.xray.model.GetServiceGraphRequest)
operation.default GetServiceGraphPublisher
getServiceGraphPaginator
(GetServiceGraphRequest getServiceGraphRequest) This is a variant ofgetServiceGraph(software.amazon.awssdk.services.xray.model.GetServiceGraphRequest)
operation.getTimeSeriesServiceStatistics
(Consumer<GetTimeSeriesServiceStatisticsRequest.Builder> getTimeSeriesServiceStatisticsRequest) Get an aggregation of service statistics defined by a specific time range.getTimeSeriesServiceStatistics
(GetTimeSeriesServiceStatisticsRequest getTimeSeriesServiceStatisticsRequest) Get an aggregation of service statistics defined by a specific time range.getTimeSeriesServiceStatisticsPaginator
(Consumer<GetTimeSeriesServiceStatisticsRequest.Builder> getTimeSeriesServiceStatisticsRequest) This is a variant ofgetTimeSeriesServiceStatistics(software.amazon.awssdk.services.xray.model.GetTimeSeriesServiceStatisticsRequest)
operation.getTimeSeriesServiceStatisticsPaginator
(GetTimeSeriesServiceStatisticsRequest getTimeSeriesServiceStatisticsRequest) This is a variant ofgetTimeSeriesServiceStatistics(software.amazon.awssdk.services.xray.model.GetTimeSeriesServiceStatisticsRequest)
operation.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) This is a variant ofgetTraceGraph(software.amazon.awssdk.services.xray.model.GetTraceGraphRequest)
operation.default GetTraceGraphPublisher
getTraceGraphPaginator
(GetTraceGraphRequest getTraceGraphRequest) This is a variant ofgetTraceGraph(software.amazon.awssdk.services.xray.model.GetTraceGraphRequest)
operation.getTraceSummaries
(Consumer<GetTraceSummariesRequest.Builder> getTraceSummariesRequest) Retrieves IDs and annotations for traces available for a specified time frame using an optional filter.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) This is a variant ofgetTraceSummaries(software.amazon.awssdk.services.xray.model.GetTraceSummariesRequest)
operation.default GetTraceSummariesPublisher
getTraceSummariesPaginator
(GetTraceSummariesRequest getTraceSummariesRequest) This is a variant ofgetTraceSummaries(software.amazon.awssdk.services.xray.model.GetTraceSummariesRequest)
operation.listResourcePolicies
(Consumer<ListResourcePoliciesRequest.Builder> listResourcePoliciesRequest) Returns the list of resource policies in the target Amazon Web Services account.listResourcePolicies
(ListResourcePoliciesRequest listResourcePoliciesRequest) Returns the list of resource policies in the target Amazon Web Services account.default ListResourcePoliciesPublisher
listResourcePoliciesPaginator
(Consumer<ListResourcePoliciesRequest.Builder> listResourcePoliciesRequest) This is a variant oflistResourcePolicies(software.amazon.awssdk.services.xray.model.ListResourcePoliciesRequest)
operation.default ListResourcePoliciesPublisher
listResourcePoliciesPaginator
(ListResourcePoliciesRequest listResourcePoliciesRequest) This is a variant oflistResourcePolicies(software.amazon.awssdk.services.xray.model.ListResourcePoliciesRequest)
operation.listTagsForResource
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Returns a list of tags that are applied to the specified Amazon Web Services X-Ray group or sampling rule.listTagsForResource
(ListTagsForResourceRequest listTagsForResourceRequest) Returns a list of tags that are applied to the specified Amazon Web Services X-Ray group or sampling rule.default ListTagsForResourcePublisher
listTagsForResourcePaginator
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) This is a variant oflistTagsForResource(software.amazon.awssdk.services.xray.model.ListTagsForResourceRequest)
operation.default ListTagsForResourcePublisher
listTagsForResourcePaginator
(ListTagsForResourceRequest listTagsForResourceRequest) This is a variant oflistTagsForResource(software.amazon.awssdk.services.xray.model.ListTagsForResourceRequest)
operation.putEncryptionConfig
(Consumer<PutEncryptionConfigRequest.Builder> putEncryptionConfigRequest) Updates the encryption configuration for X-Ray data.putEncryptionConfig
(PutEncryptionConfigRequest putEncryptionConfigRequest) Updates the encryption configuration for X-Ray data.putResourcePolicy
(Consumer<PutResourcePolicyRequest.Builder> putResourcePolicyRequest) Sets the resource policy to grant one or more Amazon Web Services services and accounts permissions to access X-Ray.putResourcePolicy
(PutResourcePolicyRequest putResourcePolicyRequest) Sets the resource policy to grant one or more Amazon Web Services services and accounts permissions to access X-Ray.putTelemetryRecords
(Consumer<PutTelemetryRecordsRequest.Builder> putTelemetryRecordsRequest) Used by the Amazon Web Services X-Ray daemon to upload telemetry.putTelemetryRecords
(PutTelemetryRecordsRequest putTelemetryRecordsRequest) Used by the Amazon Web Services X-Ray daemon to upload telemetry.putTraceSegments
(Consumer<PutTraceSegmentsRequest.Builder> putTraceSegmentsRequest) Uploads segment documents to Amazon Web Services X-Ray.putTraceSegments
(PutTraceSegmentsRequest putTraceSegmentsRequest) Uploads segment documents to Amazon Web Services X-Ray.default XRayServiceClientConfiguration
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationdefault CompletableFuture
<TagResourceResponse> tagResource
(Consumer<TagResourceRequest.Builder> tagResourceRequest) Applies tags to an existing Amazon Web Services X-Ray group or sampling rule.default CompletableFuture
<TagResourceResponse> tagResource
(TagResourceRequest tagResourceRequest) Applies tags to an existing Amazon Web Services X-Ray group or sampling rule.default CompletableFuture
<UntagResourceResponse> untagResource
(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes tags from an Amazon Web Services X-Ray group or sampling rule.default CompletableFuture
<UntagResourceResponse> untagResource
(UntagResourceRequest untagResourceRequest) Removes tags from an Amazon Web Services 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.updateSamplingRule
(Consumer<UpdateSamplingRuleRequest.Builder> updateSamplingRuleRequest) Modifies a sampling rule's configuration.updateSamplingRule
(UpdateSamplingRuleRequest updateSamplingRuleRequest) Modifies a sampling rule's configuration.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
batchGetTraces
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.- Parameters:
batchGetTracesRequest
-- Returns:
- A Java Future containing the result of the BatchGetTraces operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is missing required parameters or has invalid parameters.
- ThrottledException The request exceeds the maximum number of requests per second.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
batchGetTraces
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 viaBatchGetTracesRequest.builder()
- Parameters:
batchGetTracesRequest
- AConsumer
that will call methods onBatchGetTracesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the BatchGetTraces operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is missing required parameters or has invalid parameters.
- ThrottledException The request exceeds the maximum number of requests per second.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
batchGetTracesPaginator
default BatchGetTracesPublisher batchGetTracesPaginator(BatchGetTracesRequest batchGetTracesRequest) 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 newSubscription
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 methodsoftware.amazon.awssdk.services.xray.paginators.BatchGetTracesPublisher publisher = client.batchGetTracesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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.- Parameters:
batchGetTracesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is missing required parameters or has invalid parameters.
- ThrottledException The request exceeds the maximum number of requests per second.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
batchGetTracesPaginator
default BatchGetTracesPublisher batchGetTracesPaginator(Consumer<BatchGetTracesRequest.Builder> batchGetTracesRequest) 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 newSubscription
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 methodsoftware.amazon.awssdk.services.xray.paginators.BatchGetTracesPublisher publisher = client.batchGetTracesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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 viaBatchGetTracesRequest.builder()
- Parameters:
batchGetTracesRequest
- AConsumer
that will call methods onBatchGetTracesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is missing required parameters or has invalid parameters.
- ThrottledException The request exceeds the maximum number of requests per second.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createGroup
Creates a group resource with a name and a filter expression.
- Parameters:
createGroupRequest
-- Returns:
- A Java Future containing the result of the CreateGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is missing required parameters or has invalid parameters.
- ThrottledException The request exceeds the maximum number of requests per second.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createGroup
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 viaCreateGroupRequest.builder()
- Parameters:
createGroupRequest
- AConsumer
that will call methods onCreateGroupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is missing required parameters or has invalid parameters.
- ThrottledException The request exceeds the maximum number of requests per second.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createSamplingRule
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.
- Parameters:
createSamplingRuleRequest
-- Returns:
- A Java Future containing the result of the CreateSamplingRule operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is missing required parameters or has invalid parameters.
- ThrottledException The request exceeds the maximum number of requests per second.
- RuleLimitExceededException You have reached the maximum number of sampling rules.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createSamplingRule
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 viaCreateSamplingRuleRequest.builder()
- Parameters:
createSamplingRuleRequest
- AConsumer
that will call methods onCreateSamplingRuleRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateSamplingRule operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is missing required parameters or has invalid parameters.
- ThrottledException The request exceeds the maximum number of requests per second.
- RuleLimitExceededException You have reached the maximum number of sampling rules.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteGroup
Deletes a group resource.
- Parameters:
deleteGroupRequest
-- Returns:
- A Java Future containing the result of the DeleteGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is missing required parameters or has invalid parameters.
- ThrottledException The request exceeds the maximum number of requests per second.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteGroup
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 viaDeleteGroupRequest.builder()
- Parameters:
deleteGroupRequest
- AConsumer
that will call methods onDeleteGroupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is missing required parameters or has invalid parameters.
- ThrottledException The request exceeds the maximum number of requests per second.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteResourcePolicy
default CompletableFuture<DeleteResourcePolicyResponse> deleteResourcePolicy(DeleteResourcePolicyRequest deleteResourcePolicyRequest) Deletes a resource policy from the target Amazon Web Services account.
- Parameters:
deleteResourcePolicyRequest
-- Returns:
- A Java Future containing the result of the DeleteResourcePolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is missing required parameters or has invalid parameters.
- InvalidPolicyRevisionIdException A policy revision id was provided which does not match the latest
policy revision. This exception is also if a policy revision id of 0 is provided via
PutResourcePolicy
and a policy with the same name already exists. - ThrottledException The request exceeds the maximum number of requests per second.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteResourcePolicy
default CompletableFuture<DeleteResourcePolicyResponse> deleteResourcePolicy(Consumer<DeleteResourcePolicyRequest.Builder> deleteResourcePolicyRequest) Deletes a resource policy from the target Amazon Web Services account.
This is a convenience which creates an instance of the
DeleteResourcePolicyRequest.Builder
avoiding the need to create one manually viaDeleteResourcePolicyRequest.builder()
- Parameters:
deleteResourcePolicyRequest
- AConsumer
that will call methods onDeleteResourcePolicyRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteResourcePolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is missing required parameters or has invalid parameters.
- InvalidPolicyRevisionIdException A policy revision id was provided which does not match the latest
policy revision. This exception is also if a policy revision id of 0 is provided via
PutResourcePolicy
and a policy with the same name already exists. - ThrottledException The request exceeds the maximum number of requests per second.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteSamplingRule
default CompletableFuture<DeleteSamplingRuleResponse> deleteSamplingRule(DeleteSamplingRuleRequest deleteSamplingRuleRequest) Deletes a sampling rule.
- Parameters:
deleteSamplingRuleRequest
-- Returns:
- A Java Future containing the result of the DeleteSamplingRule operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is missing required parameters or has invalid parameters.
- ThrottledException The request exceeds the maximum number of requests per second.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteSamplingRule
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 viaDeleteSamplingRuleRequest.builder()
- Parameters:
deleteSamplingRuleRequest
- AConsumer
that will call methods onDeleteSamplingRuleRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteSamplingRule operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is missing required parameters or has invalid parameters.
- ThrottledException The request exceeds the maximum number of requests per second.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getEncryptionConfig
default CompletableFuture<GetEncryptionConfigResponse> getEncryptionConfig(GetEncryptionConfigRequest getEncryptionConfigRequest) Retrieves the current encryption configuration for X-Ray data.
- Parameters:
getEncryptionConfigRequest
-- Returns:
- A Java Future containing the result of the GetEncryptionConfig operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is missing required parameters or has invalid parameters.
- ThrottledException The request exceeds the maximum number of requests per second.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getEncryptionConfig
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 viaGetEncryptionConfigRequest.builder()
- Parameters:
getEncryptionConfigRequest
- AConsumer
that will call methods onGetEncryptionConfigRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetEncryptionConfig operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is missing required parameters or has invalid parameters.
- ThrottledException The request exceeds the maximum number of requests per second.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getEncryptionConfig
Retrieves the current encryption configuration for X-Ray data.
- Returns:
- A Java Future containing the result of the GetEncryptionConfig operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is missing required parameters or has invalid parameters.
- ThrottledException The request exceeds the maximum number of requests per second.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getGroup
Retrieves group resource details.
- Parameters:
getGroupRequest
-- Returns:
- A Java Future containing the result of the GetGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is missing required parameters or has invalid parameters.
- ThrottledException The request exceeds the maximum number of requests per second.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getGroup
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 viaGetGroupRequest.builder()
- Parameters:
getGroupRequest
- AConsumer
that will call methods onGetGroupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is missing required parameters or has invalid parameters.
- ThrottledException The request exceeds the maximum number of requests per second.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getGroups
Retrieves all active group details.
- Parameters:
getGroupsRequest
-- Returns:
- A Java Future containing the result of the GetGroups operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is missing required parameters or has invalid parameters.
- ThrottledException The request exceeds the maximum number of requests per second.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getGroups
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 viaGetGroupsRequest.builder()
- Parameters:
getGroupsRequest
- AConsumer
that will call methods onGetGroupsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetGroups operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is missing required parameters or has invalid parameters.
- ThrottledException The request exceeds the maximum number of requests per second.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getGroups
Retrieves all active group details.
- Returns:
- A Java Future containing the result of the GetGroups operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is missing required parameters or has invalid parameters.
- ThrottledException The request exceeds the maximum number of requests per second.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getGroupsPaginator
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 newSubscription
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 methodsoftware.amazon.awssdk.services.xray.paginators.GetGroupsPublisher publisher = client.getGroupsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is missing required parameters or has invalid parameters.
- ThrottledException The request exceeds the maximum number of requests per second.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getGroupsPaginator
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 newSubscription
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 methodsoftware.amazon.awssdk.services.xray.paginators.GetGroupsPublisher publisher = client.getGroupsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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.- Parameters:
getGroupsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is missing required parameters or has invalid parameters.
- ThrottledException The request exceeds the maximum number of requests per second.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getGroupsPaginator
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 newSubscription
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 methodsoftware.amazon.awssdk.services.xray.paginators.GetGroupsPublisher publisher = client.getGroupsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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 viaGetGroupsRequest.builder()
- Parameters:
getGroupsRequest
- AConsumer
that will call methods onGetGroupsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is missing required parameters or has invalid parameters.
- ThrottledException The request exceeds the maximum number of requests per second.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getInsight
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.
- Parameters:
getInsightRequest
-- Returns:
- A Java Future containing the result of the GetInsight operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is missing required parameters or has invalid parameters.
- ThrottledException The request exceeds the maximum number of requests per second.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getInsight
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 viaGetInsightRequest.builder()
- Parameters:
getInsightRequest
- AConsumer
that will call methods onGetInsightRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetInsight operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is missing required parameters or has invalid parameters.
- ThrottledException The request exceeds the maximum number of requests per second.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getInsightEvents
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.
- Parameters:
getInsightEventsRequest
-- Returns:
- A Java Future containing the result of the GetInsightEvents operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is missing required parameters or has invalid parameters.
- ThrottledException The request exceeds the maximum number of requests per second.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getInsightEvents
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 viaGetInsightEventsRequest.builder()
- Parameters:
getInsightEventsRequest
- AConsumer
that will call methods onGetInsightEventsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetInsightEvents operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is missing required parameters or has invalid parameters.
- ThrottledException The request exceeds the maximum number of requests per second.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getInsightEventsPaginator
default GetInsightEventsPublisher getInsightEventsPaginator(GetInsightEventsRequest getInsightEventsRequest) 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 newSubscription
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 methodsoftware.amazon.awssdk.services.xray.paginators.GetInsightEventsPublisher publisher = client.getInsightEventsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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.- Parameters:
getInsightEventsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is missing required parameters or has invalid parameters.
- ThrottledException The request exceeds the maximum number of requests per second.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getInsightEventsPaginator
default GetInsightEventsPublisher getInsightEventsPaginator(Consumer<GetInsightEventsRequest.Builder> getInsightEventsRequest) 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 newSubscription
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 methodsoftware.amazon.awssdk.services.xray.paginators.GetInsightEventsPublisher publisher = client.getInsightEventsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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 viaGetInsightEventsRequest.builder()
- Parameters:
getInsightEventsRequest
- AConsumer
that will call methods onGetInsightEventsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is missing required parameters or has invalid parameters.
- ThrottledException The request exceeds the maximum number of requests per second.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getInsightImpactGraph
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.
- Parameters:
getInsightImpactGraphRequest
-- Returns:
- A Java Future containing the result of the GetInsightImpactGraph operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is missing required parameters or has invalid parameters.
- ThrottledException The request exceeds the maximum number of requests per second.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getInsightImpactGraph
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 viaGetInsightImpactGraphRequest.builder()
- Parameters:
getInsightImpactGraphRequest
- AConsumer
that will call methods onGetInsightImpactGraphRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetInsightImpactGraph operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is missing required parameters or has invalid parameters.
- ThrottledException The request exceeds the maximum number of requests per second.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getInsightSummaries
default CompletableFuture<GetInsightSummariesResponse> getInsightSummaries(GetInsightSummariesRequest getInsightSummariesRequest) Retrieves the summaries of all insights in the specified group matching the provided filter values.
- Parameters:
getInsightSummariesRequest
-- Returns:
- A Java Future containing the result of the GetInsightSummaries operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is missing required parameters or has invalid parameters.
- ThrottledException The request exceeds the maximum number of requests per second.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getInsightSummaries
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 viaGetInsightSummariesRequest.builder()
- Parameters:
getInsightSummariesRequest
- AConsumer
that will call methods onGetInsightSummariesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetInsightSummaries operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is missing required parameters or has invalid parameters.
- ThrottledException The request exceeds the maximum number of requests per second.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getInsightSummariesPaginator
default GetInsightSummariesPublisher getInsightSummariesPaginator(GetInsightSummariesRequest getInsightSummariesRequest) 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 newSubscription
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 methodsoftware.amazon.awssdk.services.xray.paginators.GetInsightSummariesPublisher publisher = client.getInsightSummariesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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.- Parameters:
getInsightSummariesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is missing required parameters or has invalid parameters.
- ThrottledException The request exceeds the maximum number of requests per second.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getInsightSummariesPaginator
default GetInsightSummariesPublisher getInsightSummariesPaginator(Consumer<GetInsightSummariesRequest.Builder> getInsightSummariesRequest) 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 newSubscription
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 methodsoftware.amazon.awssdk.services.xray.paginators.GetInsightSummariesPublisher publisher = client.getInsightSummariesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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 viaGetInsightSummariesRequest.builder()
- Parameters:
getInsightSummariesRequest
- AConsumer
that will call methods onGetInsightSummariesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is missing required parameters or has invalid parameters.
- ThrottledException The request exceeds the maximum number of requests per second.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getSamplingRules
default CompletableFuture<GetSamplingRulesResponse> getSamplingRules(GetSamplingRulesRequest getSamplingRulesRequest) Retrieves all sampling rules.
- Parameters:
getSamplingRulesRequest
-- Returns:
- A Java Future containing the result of the GetSamplingRules operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is missing required parameters or has invalid parameters.
- ThrottledException The request exceeds the maximum number of requests per second.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getSamplingRules
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 viaGetSamplingRulesRequest.builder()
- Parameters:
getSamplingRulesRequest
- AConsumer
that will call methods onGetSamplingRulesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetSamplingRules operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is missing required parameters or has invalid parameters.
- ThrottledException The request exceeds the maximum number of requests per second.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getSamplingRules
Retrieves all sampling rules.
- Returns:
- A Java Future containing the result of the GetSamplingRules operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is missing required parameters or has invalid parameters.
- ThrottledException The request exceeds the maximum number of requests per second.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getSamplingRulesPaginator
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 newSubscription
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 methodsoftware.amazon.awssdk.services.xray.paginators.GetSamplingRulesPublisher publisher = client.getSamplingRulesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is missing required parameters or has invalid parameters.
- ThrottledException The request exceeds the maximum number of requests per second.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getSamplingRulesPaginator
default GetSamplingRulesPublisher getSamplingRulesPaginator(GetSamplingRulesRequest getSamplingRulesRequest) 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 newSubscription
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 methodsoftware.amazon.awssdk.services.xray.paginators.GetSamplingRulesPublisher publisher = client.getSamplingRulesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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.- Parameters:
getSamplingRulesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is missing required parameters or has invalid parameters.
- ThrottledException The request exceeds the maximum number of requests per second.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getSamplingRulesPaginator
default GetSamplingRulesPublisher getSamplingRulesPaginator(Consumer<GetSamplingRulesRequest.Builder> getSamplingRulesRequest) 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 newSubscription
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 methodsoftware.amazon.awssdk.services.xray.paginators.GetSamplingRulesPublisher publisher = client.getSamplingRulesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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 viaGetSamplingRulesRequest.builder()
- Parameters:
getSamplingRulesRequest
- AConsumer
that will call methods onGetSamplingRulesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is missing required parameters or has invalid parameters.
- ThrottledException The request exceeds the maximum number of requests per second.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getSamplingStatisticSummaries
default CompletableFuture<GetSamplingStatisticSummariesResponse> getSamplingStatisticSummaries(GetSamplingStatisticSummariesRequest getSamplingStatisticSummariesRequest) Retrieves information about recent sampling results for all sampling rules.
- Parameters:
getSamplingStatisticSummariesRequest
-- Returns:
- A Java Future containing the result of the GetSamplingStatisticSummaries operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is missing required parameters or has invalid parameters.
- ThrottledException The request exceeds the maximum number of requests per second.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getSamplingStatisticSummaries
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 viaGetSamplingStatisticSummariesRequest.builder()
- Parameters:
getSamplingStatisticSummariesRequest
- AConsumer
that will call methods onGetSamplingStatisticSummariesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetSamplingStatisticSummaries operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is missing required parameters or has invalid parameters.
- ThrottledException The request exceeds the maximum number of requests per second.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getSamplingStatisticSummaries
Retrieves information about recent sampling results for all sampling rules.
- Returns:
- A Java Future containing the result of the GetSamplingStatisticSummaries operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is missing required parameters or has invalid parameters.
- ThrottledException The request exceeds the maximum number of requests per second.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getSamplingStatisticSummariesPaginator
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 newSubscription
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 methodsoftware.amazon.awssdk.services.xray.paginators.GetSamplingStatisticSummariesPublisher publisher = client.getSamplingStatisticSummariesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is missing required parameters or has invalid parameters.
- ThrottledException The request exceeds the maximum number of requests per second.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getSamplingStatisticSummariesPaginator
default GetSamplingStatisticSummariesPublisher getSamplingStatisticSummariesPaginator(GetSamplingStatisticSummariesRequest getSamplingStatisticSummariesRequest) 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 newSubscription
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 methodsoftware.amazon.awssdk.services.xray.paginators.GetSamplingStatisticSummariesPublisher publisher = client.getSamplingStatisticSummariesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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.- Parameters:
getSamplingStatisticSummariesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is missing required parameters or has invalid parameters.
- ThrottledException The request exceeds the maximum number of requests per second.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getSamplingStatisticSummariesPaginator
default GetSamplingStatisticSummariesPublisher getSamplingStatisticSummariesPaginator(Consumer<GetSamplingStatisticSummariesRequest.Builder> getSamplingStatisticSummariesRequest) 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 newSubscription
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 methodsoftware.amazon.awssdk.services.xray.paginators.GetSamplingStatisticSummariesPublisher publisher = client.getSamplingStatisticSummariesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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 viaGetSamplingStatisticSummariesRequest.builder()
- Parameters:
getSamplingStatisticSummariesRequest
- AConsumer
that will call methods onGetSamplingStatisticSummariesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is missing required parameters or has invalid parameters.
- ThrottledException The request exceeds the maximum number of requests per second.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getSamplingTargets
default CompletableFuture<GetSamplingTargetsResponse> getSamplingTargets(GetSamplingTargetsRequest getSamplingTargetsRequest) Requests a sampling quota for rules that the service is using to sample requests.
- Parameters:
getSamplingTargetsRequest
-- Returns:
- A Java Future containing the result of the GetSamplingTargets operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is missing required parameters or has invalid parameters.
- ThrottledException The request exceeds the maximum number of requests per second.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getSamplingTargets
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 viaGetSamplingTargetsRequest.builder()
- Parameters:
getSamplingTargetsRequest
- AConsumer
that will call methods onGetSamplingTargetsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetSamplingTargets operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is missing required parameters or has invalid parameters.
- ThrottledException The request exceeds the maximum number of requests per second.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getServiceGraph
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 Amazon Web Services X-Ray SDK. Downstream services can be other applications, Amazon Web Services resources, HTTP web APIs, or SQL databases.
- Parameters:
getServiceGraphRequest
-- Returns:
- A Java Future containing the result of the GetServiceGraph operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is missing required parameters or has invalid parameters.
- ThrottledException The request exceeds the maximum number of requests per second.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getServiceGraph
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 Amazon Web Services X-Ray SDK. Downstream services can be other applications, Amazon Web Services 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 viaGetServiceGraphRequest.builder()
- Parameters:
getServiceGraphRequest
- AConsumer
that will call methods onGetServiceGraphRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetServiceGraph operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is missing required parameters or has invalid parameters.
- ThrottledException The request exceeds the maximum number of requests per second.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getServiceGraphPaginator
default GetServiceGraphPublisher getServiceGraphPaginator(GetServiceGraphRequest getServiceGraphRequest) 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 newSubscription
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 methodsoftware.amazon.awssdk.services.xray.paginators.GetServiceGraphPublisher publisher = client.getServiceGraphPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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.- Parameters:
getServiceGraphRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is missing required parameters or has invalid parameters.
- ThrottledException The request exceeds the maximum number of requests per second.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getServiceGraphPaginator
default GetServiceGraphPublisher getServiceGraphPaginator(Consumer<GetServiceGraphRequest.Builder> getServiceGraphRequest) 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 newSubscription
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 methodsoftware.amazon.awssdk.services.xray.paginators.GetServiceGraphPublisher publisher = client.getServiceGraphPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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 viaGetServiceGraphRequest.builder()
- Parameters:
getServiceGraphRequest
- AConsumer
that will call methods onGetServiceGraphRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is missing required parameters or has invalid parameters.
- ThrottledException The request exceeds the maximum number of requests per second.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getTimeSeriesServiceStatistics
default CompletableFuture<GetTimeSeriesServiceStatisticsResponse> getTimeSeriesServiceStatistics(GetTimeSeriesServiceStatisticsRequest getTimeSeriesServiceStatisticsRequest) Get an aggregation of service statistics defined by a specific time range.
- Parameters:
getTimeSeriesServiceStatisticsRequest
-- Returns:
- A Java Future containing the result of the GetTimeSeriesServiceStatistics operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is missing required parameters or has invalid parameters.
- ThrottledException The request exceeds the maximum number of requests per second.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getTimeSeriesServiceStatistics
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 viaGetTimeSeriesServiceStatisticsRequest.builder()
- Parameters:
getTimeSeriesServiceStatisticsRequest
- AConsumer
that will call methods onGetTimeSeriesServiceStatisticsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetTimeSeriesServiceStatistics operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is missing required parameters or has invalid parameters.
- ThrottledException The request exceeds the maximum number of requests per second.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getTimeSeriesServiceStatisticsPaginator
default GetTimeSeriesServiceStatisticsPublisher getTimeSeriesServiceStatisticsPaginator(GetTimeSeriesServiceStatisticsRequest getTimeSeriesServiceStatisticsRequest) 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 newSubscription
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 methodsoftware.amazon.awssdk.services.xray.paginators.GetTimeSeriesServiceStatisticsPublisher publisher = client.getTimeSeriesServiceStatisticsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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.- Parameters:
getTimeSeriesServiceStatisticsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is missing required parameters or has invalid parameters.
- ThrottledException The request exceeds the maximum number of requests per second.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getTimeSeriesServiceStatisticsPaginator
default GetTimeSeriesServiceStatisticsPublisher getTimeSeriesServiceStatisticsPaginator(Consumer<GetTimeSeriesServiceStatisticsRequest.Builder> getTimeSeriesServiceStatisticsRequest) 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 newSubscription
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 methodsoftware.amazon.awssdk.services.xray.paginators.GetTimeSeriesServiceStatisticsPublisher publisher = client.getTimeSeriesServiceStatisticsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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 viaGetTimeSeriesServiceStatisticsRequest.builder()
- Parameters:
getTimeSeriesServiceStatisticsRequest
- AConsumer
that will call methods onGetTimeSeriesServiceStatisticsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is missing required parameters or has invalid parameters.
- ThrottledException The request exceeds the maximum number of requests per second.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getTraceGraph
default CompletableFuture<GetTraceGraphResponse> getTraceGraph(GetTraceGraphRequest getTraceGraphRequest) Retrieves a service graph for one or more specific trace IDs.
- Parameters:
getTraceGraphRequest
-- Returns:
- A Java Future containing the result of the GetTraceGraph operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is missing required parameters or has invalid parameters.
- ThrottledException The request exceeds the maximum number of requests per second.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getTraceGraph
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 viaGetTraceGraphRequest.builder()
- Parameters:
getTraceGraphRequest
- AConsumer
that will call methods onGetTraceGraphRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetTraceGraph operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is missing required parameters or has invalid parameters.
- ThrottledException The request exceeds the maximum number of requests per second.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getTraceGraphPaginator
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 newSubscription
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 methodsoftware.amazon.awssdk.services.xray.paginators.GetTraceGraphPublisher publisher = client.getTraceGraphPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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.- Parameters:
getTraceGraphRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is missing required parameters or has invalid parameters.
- ThrottledException The request exceeds the maximum number of requests per second.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getTraceGraphPaginator
default GetTraceGraphPublisher getTraceGraphPaginator(Consumer<GetTraceGraphRequest.Builder> getTraceGraphRequest) 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 newSubscription
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 methodsoftware.amazon.awssdk.services.xray.paginators.GetTraceGraphPublisher publisher = client.getTraceGraphPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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 viaGetTraceGraphRequest.builder()
- Parameters:
getTraceGraphRequest
- AConsumer
that will call methods onGetTraceGraphRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is missing required parameters or has invalid parameters.
- ThrottledException The request exceeds the maximum number of requests per second.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getTraceSummaries
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 value12345
: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 Amazon Web Services X-Ray Developer Guide.
- Parameters:
getTraceSummariesRequest
-- Returns:
- A Java Future containing the result of the GetTraceSummaries operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is missing required parameters or has invalid parameters.
- ThrottledException The request exceeds the maximum number of requests per second.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getTraceSummaries
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 value12345
: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 Amazon Web Services X-Ray Developer Guide.
This is a convenience which creates an instance of the
GetTraceSummariesRequest.Builder
avoiding the need to create one manually viaGetTraceSummariesRequest.builder()
- Parameters:
getTraceSummariesRequest
- AConsumer
that will call methods onGetTraceSummariesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetTraceSummaries operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is missing required parameters or has invalid parameters.
- ThrottledException The request exceeds the maximum number of requests per second.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getTraceSummariesPaginator
default GetTraceSummariesPublisher getTraceSummariesPaginator(GetTraceSummariesRequest getTraceSummariesRequest) 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 newSubscription
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 methodsoftware.amazon.awssdk.services.xray.paginators.GetTraceSummariesPublisher publisher = client.getTraceSummariesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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.- Parameters:
getTraceSummariesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is missing required parameters or has invalid parameters.
- ThrottledException The request exceeds the maximum number of requests per second.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getTraceSummariesPaginator
default GetTraceSummariesPublisher getTraceSummariesPaginator(Consumer<GetTraceSummariesRequest.Builder> getTraceSummariesRequest) 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 newSubscription
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 methodsoftware.amazon.awssdk.services.xray.paginators.GetTraceSummariesPublisher publisher = client.getTraceSummariesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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 viaGetTraceSummariesRequest.builder()
- Parameters:
getTraceSummariesRequest
- AConsumer
that will call methods onGetTraceSummariesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is missing required parameters or has invalid parameters.
- ThrottledException The request exceeds the maximum number of requests per second.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listResourcePolicies
default CompletableFuture<ListResourcePoliciesResponse> listResourcePolicies(ListResourcePoliciesRequest listResourcePoliciesRequest) Returns the list of resource policies in the target Amazon Web Services account.
- Parameters:
listResourcePoliciesRequest
-- Returns:
- A Java Future containing the result of the ListResourcePolicies operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is missing required parameters or has invalid parameters.
- ThrottledException The request exceeds the maximum number of requests per second.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listResourcePolicies
default CompletableFuture<ListResourcePoliciesResponse> listResourcePolicies(Consumer<ListResourcePoliciesRequest.Builder> listResourcePoliciesRequest) Returns the list of resource policies in the target Amazon Web Services account.
This is a convenience which creates an instance of the
ListResourcePoliciesRequest.Builder
avoiding the need to create one manually viaListResourcePoliciesRequest.builder()
- Parameters:
listResourcePoliciesRequest
- AConsumer
that will call methods onListResourcePoliciesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListResourcePolicies operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is missing required parameters or has invalid parameters.
- ThrottledException The request exceeds the maximum number of requests per second.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listResourcePoliciesPaginator
default ListResourcePoliciesPublisher listResourcePoliciesPaginator(ListResourcePoliciesRequest listResourcePoliciesRequest) This is a variant of
listResourcePolicies(software.amazon.awssdk.services.xray.model.ListResourcePoliciesRequest)
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 newSubscription
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 methodsoftware.amazon.awssdk.services.xray.paginators.ListResourcePoliciesPublisher publisher = client.listResourcePoliciesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.xray.paginators.ListResourcePoliciesPublisher publisher = client.listResourcePoliciesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.xray.model.ListResourcePoliciesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.xray.model.ListResourcePoliciesResponse response) { //... }; });
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
listResourcePolicies(software.amazon.awssdk.services.xray.model.ListResourcePoliciesRequest)
operation.- Parameters:
listResourcePoliciesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is missing required parameters or has invalid parameters.
- ThrottledException The request exceeds the maximum number of requests per second.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listResourcePoliciesPaginator
default ListResourcePoliciesPublisher listResourcePoliciesPaginator(Consumer<ListResourcePoliciesRequest.Builder> listResourcePoliciesRequest) This is a variant of
listResourcePolicies(software.amazon.awssdk.services.xray.model.ListResourcePoliciesRequest)
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 newSubscription
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 methodsoftware.amazon.awssdk.services.xray.paginators.ListResourcePoliciesPublisher publisher = client.listResourcePoliciesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.xray.paginators.ListResourcePoliciesPublisher publisher = client.listResourcePoliciesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.xray.model.ListResourcePoliciesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.xray.model.ListResourcePoliciesResponse response) { //... }; });
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
listResourcePolicies(software.amazon.awssdk.services.xray.model.ListResourcePoliciesRequest)
operation.
This is a convenience which creates an instance of the
ListResourcePoliciesRequest.Builder
avoiding the need to create one manually viaListResourcePoliciesRequest.builder()
- Parameters:
listResourcePoliciesRequest
- AConsumer
that will call methods onListResourcePoliciesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is missing required parameters or has invalid parameters.
- ThrottledException The request exceeds the maximum number of requests per second.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Returns a list of tags that are applied to the specified Amazon Web Services X-Ray group or sampling rule.
- Parameters:
listTagsForResourceRequest
-- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is missing required parameters or has invalid parameters.
- ThrottledException The request exceeds the maximum number of requests per second.
- ResourceNotFoundException The resource was not found. Verify that the name or Amazon Resource Name (ARN) of the resource is correct.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Returns a list of tags that are applied to the specified Amazon Web Services 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 viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is missing required parameters or has invalid parameters.
- ThrottledException The request exceeds the maximum number of requests per second.
- ResourceNotFoundException The resource was not found. Verify that the name or Amazon Resource Name (ARN) of the resource is correct.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResourcePaginator
default ListTagsForResourcePublisher listTagsForResourcePaginator(ListTagsForResourceRequest listTagsForResourceRequest) This is a variant of
listTagsForResource(software.amazon.awssdk.services.xray.model.ListTagsForResourceRequest)
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 newSubscription
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 methodsoftware.amazon.awssdk.services.xray.paginators.ListTagsForResourcePublisher publisher = client.listTagsForResourcePaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.xray.paginators.ListTagsForResourcePublisher publisher = client.listTagsForResourcePaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.xray.model.ListTagsForResourceResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.xray.model.ListTagsForResourceResponse response) { //... }; });
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
listTagsForResource(software.amazon.awssdk.services.xray.model.ListTagsForResourceRequest)
operation.- Parameters:
listTagsForResourceRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is missing required parameters or has invalid parameters.
- ThrottledException The request exceeds the maximum number of requests per second.
- ResourceNotFoundException The resource was not found. Verify that the name or Amazon Resource Name (ARN) of the resource is correct.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResourcePaginator
default ListTagsForResourcePublisher listTagsForResourcePaginator(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) This is a variant of
listTagsForResource(software.amazon.awssdk.services.xray.model.ListTagsForResourceRequest)
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 newSubscription
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 methodsoftware.amazon.awssdk.services.xray.paginators.ListTagsForResourcePublisher publisher = client.listTagsForResourcePaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.xray.paginators.ListTagsForResourcePublisher publisher = client.listTagsForResourcePaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.xray.model.ListTagsForResourceResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.xray.model.ListTagsForResourceResponse response) { //... }; });
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
listTagsForResource(software.amazon.awssdk.services.xray.model.ListTagsForResourceRequest)
operation.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builder
avoiding the need to create one manually viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is missing required parameters or has invalid parameters.
- ThrottledException The request exceeds the maximum number of requests per second.
- ResourceNotFoundException The resource was not found. Verify that the name or Amazon Resource Name (ARN) of the resource is correct.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putEncryptionConfig
default CompletableFuture<PutEncryptionConfigResponse> putEncryptionConfig(PutEncryptionConfigRequest putEncryptionConfigRequest) Updates the encryption configuration for X-Ray data.
- Parameters:
putEncryptionConfigRequest
-- Returns:
- A Java Future containing the result of the PutEncryptionConfig operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is missing required parameters or has invalid parameters.
- ThrottledException The request exceeds the maximum number of requests per second.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putEncryptionConfig
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 viaPutEncryptionConfigRequest.builder()
- Parameters:
putEncryptionConfigRequest
- AConsumer
that will call methods onPutEncryptionConfigRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the PutEncryptionConfig operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is missing required parameters or has invalid parameters.
- ThrottledException The request exceeds the maximum number of requests per second.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putResourcePolicy
default CompletableFuture<PutResourcePolicyResponse> putResourcePolicy(PutResourcePolicyRequest putResourcePolicyRequest) Sets the resource policy to grant one or more Amazon Web Services services and accounts permissions to access X-Ray. Each resource policy will be associated with a specific Amazon Web Services account. Each Amazon Web Services account can have a maximum of 5 resource policies, and each policy name must be unique within that account. The maximum size of each resource policy is 5KB.
- Parameters:
putResourcePolicyRequest
-- Returns:
- A Java Future containing the result of the PutResourcePolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- MalformedPolicyDocumentException Invalid policy document provided in request.
- LockoutPreventionException The provided resource policy would prevent the caller of this request from calling PutResourcePolicy in the future.
- InvalidPolicyRevisionIdException A policy revision id was provided which does not match the latest
policy revision. This exception is also if a policy revision id of 0 is provided via
PutResourcePolicy
and a policy with the same name already exists. - PolicySizeLimitExceededException Exceeded the maximum size for a resource policy.
- PolicyCountLimitExceededException Exceeded the maximum number of resource policies for a target Amazon Web Services account.
- ThrottledException The request exceeds the maximum number of requests per second.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putResourcePolicy
default CompletableFuture<PutResourcePolicyResponse> putResourcePolicy(Consumer<PutResourcePolicyRequest.Builder> putResourcePolicyRequest) Sets the resource policy to grant one or more Amazon Web Services services and accounts permissions to access X-Ray. Each resource policy will be associated with a specific Amazon Web Services account. Each Amazon Web Services account can have a maximum of 5 resource policies, and each policy name must be unique within that account. The maximum size of each resource policy is 5KB.
This is a convenience which creates an instance of the
PutResourcePolicyRequest.Builder
avoiding the need to create one manually viaPutResourcePolicyRequest.builder()
- Parameters:
putResourcePolicyRequest
- AConsumer
that will call methods onPutResourcePolicyRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the PutResourcePolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- MalformedPolicyDocumentException Invalid policy document provided in request.
- LockoutPreventionException The provided resource policy would prevent the caller of this request from calling PutResourcePolicy in the future.
- InvalidPolicyRevisionIdException A policy revision id was provided which does not match the latest
policy revision. This exception is also if a policy revision id of 0 is provided via
PutResourcePolicy
and a policy with the same name already exists. - PolicySizeLimitExceededException Exceeded the maximum size for a resource policy.
- PolicyCountLimitExceededException Exceeded the maximum number of resource policies for a target Amazon Web Services account.
- ThrottledException The request exceeds the maximum number of requests per second.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putTelemetryRecords
default CompletableFuture<PutTelemetryRecordsResponse> putTelemetryRecords(PutTelemetryRecordsRequest putTelemetryRecordsRequest) Used by the Amazon Web Services X-Ray daemon to upload telemetry.
- Parameters:
putTelemetryRecordsRequest
-- Returns:
- A Java Future containing the result of the PutTelemetryRecords operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is missing required parameters or has invalid parameters.
- ThrottledException The request exceeds the maximum number of requests per second.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putTelemetryRecords
default CompletableFuture<PutTelemetryRecordsResponse> putTelemetryRecords(Consumer<PutTelemetryRecordsRequest.Builder> putTelemetryRecordsRequest) Used by the Amazon Web Services 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 viaPutTelemetryRecordsRequest.builder()
- Parameters:
putTelemetryRecordsRequest
- AConsumer
that will call methods onPutTelemetryRecordsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the PutTelemetryRecords operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is missing required parameters or has invalid parameters.
- ThrottledException The request exceeds the maximum number of requests per second.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putTraceSegments
default CompletableFuture<PutTraceSegmentsResponse> putTraceSegments(PutTraceSegmentsRequest putTraceSegmentsRequest) Uploads segment documents to Amazon Web Services 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 Amazon Web Services X-Ray Segment Documents in the Amazon Web Services 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
or1.480615200010E9
. -
end_time
- Time the segment or subsegment was closed. For example,1480615200.090
or1.480615200090E9
. Specify either anend_time
orin_progress
. -
in_progress
- Set totrue
instead of specifying anend_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, or58406520
in hexadecimal. -
A 96-bit identifier for the trace, globally unique, in 24 hexadecimal digits.
- Parameters:
putTraceSegmentsRequest
-- Returns:
- A Java Future containing the result of the PutTraceSegments operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is missing required parameters or has invalid parameters.
- ThrottledException The request exceeds the maximum number of requests per second.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
putTraceSegments
default CompletableFuture<PutTraceSegmentsResponse> putTraceSegments(Consumer<PutTraceSegmentsRequest.Builder> putTraceSegmentsRequest) Uploads segment documents to Amazon Web Services 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 Amazon Web Services X-Ray Segment Documents in the Amazon Web Services 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
or1.480615200010E9
. -
end_time
- Time the segment or subsegment was closed. For example,1480615200.090
or1.480615200090E9
. Specify either anend_time
orin_progress
. -
in_progress
- Set totrue
instead of specifying anend_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, or58406520
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 viaPutTraceSegmentsRequest.builder()
- Parameters:
putTraceSegmentsRequest
- AConsumer
that will call methods onPutTraceSegmentsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the PutTraceSegments operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is missing required parameters or has invalid parameters.
- ThrottledException The request exceeds the maximum number of requests per second.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
tagResource
Applies tags to an existing Amazon Web Services X-Ray group or sampling rule.
- Parameters:
tagResourceRequest
-- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is missing required parameters or has invalid parameters.
- ThrottledException The request exceeds the maximum number of requests per second.
- ResourceNotFoundException The resource was not found. Verify that the name or Amazon Resource Name (ARN) of the resource is correct.
- TooManyTagsException You have exceeded the maximum number of tags you can apply to this resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
tagResource
default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) Applies tags to an existing Amazon Web Services 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 viaTagResourceRequest.builder()
- Parameters:
tagResourceRequest
- AConsumer
that will call methods onTagResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is missing required parameters or has invalid parameters.
- ThrottledException The request exceeds the maximum number of requests per second.
- ResourceNotFoundException The resource was not found. Verify that the name or Amazon Resource Name (ARN) of the resource is correct.
- TooManyTagsException You have exceeded the maximum number of tags you can apply to this resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest) Removes tags from an Amazon Web Services X-Ray group or sampling rule. You cannot edit or delete system tags (those with an
aws:
prefix).- Parameters:
untagResourceRequest
-- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is missing required parameters or has invalid parameters.
- ThrottledException The request exceeds the maximum number of requests per second.
- ResourceNotFoundException The resource was not found. Verify that the name or Amazon Resource Name (ARN) of the resource is correct.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes tags from an Amazon Web Services 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 viaUntagResourceRequest.builder()
- Parameters:
untagResourceRequest
- AConsumer
that will call methods onUntagResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is missing required parameters or has invalid parameters.
- ThrottledException The request exceeds the maximum number of requests per second.
- ResourceNotFoundException The resource was not found. Verify that the name or Amazon Resource Name (ARN) of the resource is correct.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateGroup
Updates a group resource.
- Parameters:
updateGroupRequest
-- Returns:
- A Java Future containing the result of the UpdateGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is missing required parameters or has invalid parameters.
- ThrottledException The request exceeds the maximum number of requests per second.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateGroup
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 viaUpdateGroupRequest.builder()
- Parameters:
updateGroupRequest
- AConsumer
that will call methods onUpdateGroupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is missing required parameters or has invalid parameters.
- ThrottledException The request exceeds the maximum number of requests per second.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateSamplingRule
default CompletableFuture<UpdateSamplingRuleResponse> updateSamplingRule(UpdateSamplingRuleRequest updateSamplingRuleRequest) Modifies a sampling rule's configuration.
- Parameters:
updateSamplingRuleRequest
-- Returns:
- A Java Future containing the result of the UpdateSamplingRule operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is missing required parameters or has invalid parameters.
- ThrottledException The request exceeds the maximum number of requests per second.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateSamplingRule
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 viaUpdateSamplingRuleRequest.builder()
- Parameters:
updateSamplingRuleRequest
- AConsumer
that will call methods onUpdateSamplingRuleRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateSamplingRule operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidRequestException The request is missing required parameters or has invalid parameters.
- ThrottledException The request exceeds the maximum number of requests per second.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-
create
Create aXRayAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aXRayAsyncClient
.
-