software.amazon.awssdk.services.xray.XRayAsyncClient Maven / Gradle / Ivy
/*
* Copyright 2014-2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.xray;
import java.util.concurrent.CompletableFuture;
import java.util.function.Consumer;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.core.SdkClient;
import software.amazon.awssdk.services.xray.model.BatchGetTracesRequest;
import software.amazon.awssdk.services.xray.model.BatchGetTracesResponse;
import software.amazon.awssdk.services.xray.model.CreateGroupRequest;
import software.amazon.awssdk.services.xray.model.CreateGroupResponse;
import software.amazon.awssdk.services.xray.model.CreateSamplingRuleRequest;
import software.amazon.awssdk.services.xray.model.CreateSamplingRuleResponse;
import software.amazon.awssdk.services.xray.model.DeleteGroupRequest;
import software.amazon.awssdk.services.xray.model.DeleteGroupResponse;
import software.amazon.awssdk.services.xray.model.DeleteSamplingRuleRequest;
import software.amazon.awssdk.services.xray.model.DeleteSamplingRuleResponse;
import software.amazon.awssdk.services.xray.model.GetEncryptionConfigRequest;
import software.amazon.awssdk.services.xray.model.GetEncryptionConfigResponse;
import software.amazon.awssdk.services.xray.model.GetGroupRequest;
import software.amazon.awssdk.services.xray.model.GetGroupResponse;
import software.amazon.awssdk.services.xray.model.GetGroupsRequest;
import software.amazon.awssdk.services.xray.model.GetGroupsResponse;
import software.amazon.awssdk.services.xray.model.GetSamplingRulesRequest;
import software.amazon.awssdk.services.xray.model.GetSamplingRulesResponse;
import software.amazon.awssdk.services.xray.model.GetSamplingStatisticSummariesRequest;
import software.amazon.awssdk.services.xray.model.GetSamplingStatisticSummariesResponse;
import software.amazon.awssdk.services.xray.model.GetSamplingTargetsRequest;
import software.amazon.awssdk.services.xray.model.GetSamplingTargetsResponse;
import software.amazon.awssdk.services.xray.model.GetServiceGraphRequest;
import software.amazon.awssdk.services.xray.model.GetServiceGraphResponse;
import software.amazon.awssdk.services.xray.model.GetTimeSeriesServiceStatisticsRequest;
import software.amazon.awssdk.services.xray.model.GetTimeSeriesServiceStatisticsResponse;
import software.amazon.awssdk.services.xray.model.GetTraceGraphRequest;
import software.amazon.awssdk.services.xray.model.GetTraceGraphResponse;
import software.amazon.awssdk.services.xray.model.GetTraceSummariesRequest;
import software.amazon.awssdk.services.xray.model.GetTraceSummariesResponse;
import software.amazon.awssdk.services.xray.model.PutEncryptionConfigRequest;
import software.amazon.awssdk.services.xray.model.PutEncryptionConfigResponse;
import software.amazon.awssdk.services.xray.model.PutTelemetryRecordsRequest;
import software.amazon.awssdk.services.xray.model.PutTelemetryRecordsResponse;
import software.amazon.awssdk.services.xray.model.PutTraceSegmentsRequest;
import software.amazon.awssdk.services.xray.model.PutTraceSegmentsResponse;
import software.amazon.awssdk.services.xray.model.UpdateGroupRequest;
import software.amazon.awssdk.services.xray.model.UpdateGroupResponse;
import software.amazon.awssdk.services.xray.model.UpdateSamplingRuleRequest;
import software.amazon.awssdk.services.xray.model.UpdateSamplingRuleResponse;
import software.amazon.awssdk.services.xray.paginators.BatchGetTracesPublisher;
import software.amazon.awssdk.services.xray.paginators.GetGroupsPublisher;
import software.amazon.awssdk.services.xray.paginators.GetSamplingRulesPublisher;
import software.amazon.awssdk.services.xray.paginators.GetSamplingStatisticSummariesPublisher;
import software.amazon.awssdk.services.xray.paginators.GetServiceGraphPublisher;
import software.amazon.awssdk.services.xray.paginators.GetTimeSeriesServiceStatisticsPublisher;
import software.amazon.awssdk.services.xray.paginators.GetTraceGraphPublisher;
import software.amazon.awssdk.services.xray.paginators.GetTraceSummariesPublisher;
/**
* Service client for accessing AWS X-Ray asynchronously. This can be created using the static {@link #builder()}
* method.
*
*
* AWS X-Ray provides APIs for managing debug traces and retrieving service maps and other data created by processing
* those traces.
*
*/
@Generated("software.amazon.awssdk:codegen")
public interface XRayAsyncClient extends SdkClient {
String SERVICE_NAME = "xray";
/**
* Create a {@link XRayAsyncClient} with the region loaded from the
* {@link software.amazon.awssdk.regions.providers.DefaultAwsRegionProviderChain} and credentials loaded from the
* {@link software.amazon.awssdk.auth.credentials.DefaultCredentialsProvider}.
*/
static XRayAsyncClient create() {
return builder().build();
}
/**
* Create a builder that can be used to configure and create a {@link XRayAsyncClient}.
*/
static XRayAsyncClientBuilder builder() {
return new DefaultXRayAsyncClientBuilder();
}
/**
*
* 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.
*
*
* @param batchGetTracesRequest
* @return 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.
*
* - 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.
*
* @sample XRayAsyncClient.BatchGetTraces
* @see AWS API
* Documentation
*/
default CompletableFuture batchGetTraces(BatchGetTracesRequest batchGetTracesRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link BatchGetTracesRequest.Builder} avoiding the need to
* create one manually via {@link BatchGetTracesRequest#builder()}
*
*
* @param batchGetTracesRequest
* A {@link Consumer} that will call methods on {@link BatchGetTracesRequest.Builder} to create a request.
* @return 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.
*
* - 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.
*
* @sample XRayAsyncClient.BatchGetTraces
* @see AWS API
* Documentation
*/
default CompletableFuture batchGetTraces(Consumer batchGetTracesRequest) {
return batchGetTraces(BatchGetTracesRequest.builder().applyMutation(batchGetTracesRequest).build());
}
/**
*
* Retrieves a list of traces specified by ID. Each trace is a collection of segment documents that originates from
* a single request. Use GetTraceSummaries to get a list of trace IDs.
*
*
*
* This is a variant of {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.xray.paginators.BatchGetTracesPublisher publisher = client.batchGetTracesPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.xray.paginators.BatchGetTracesPublisher publisher = client.batchGetTracesPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.xray.model.BatchGetTracesResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Note: If you prefer to have control on service calls, use the
* {@link #batchGetTraces(software.amazon.awssdk.services.xray.model.BatchGetTracesRequest)} operation.
*
*
* @param batchGetTracesRequest
* @return 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.
*
* - 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.
*
* @sample XRayAsyncClient.BatchGetTraces
* @see AWS API
* Documentation
*/
default BatchGetTracesPublisher batchGetTracesPaginator(BatchGetTracesRequest batchGetTracesRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Retrieves a list of traces specified by ID. Each trace is a collection of segment documents that originates from
* a single request. Use GetTraceSummaries to get a list of trace IDs.
*
*
*
* This is a variant of {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.xray.paginators.BatchGetTracesPublisher publisher = client.batchGetTracesPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.xray.paginators.BatchGetTracesPublisher publisher = client.batchGetTracesPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.xray.model.BatchGetTracesResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Note: If you prefer to have control on service calls, use the
* {@link #batchGetTraces(software.amazon.awssdk.services.xray.model.BatchGetTracesRequest)} operation.
*
*
* This is a convenience which creates an instance of the {@link BatchGetTracesRequest.Builder} avoiding the need to
* create one manually via {@link BatchGetTracesRequest#builder()}
*
*
* @param batchGetTracesRequest
* A {@link Consumer} that will call methods on {@link BatchGetTracesRequest.Builder} to create a request.
* @return 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.
*
* - 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.
*
* @sample XRayAsyncClient.BatchGetTraces
* @see AWS API
* Documentation
*/
default BatchGetTracesPublisher batchGetTracesPaginator(Consumer batchGetTracesRequest) {
return batchGetTracesPaginator(BatchGetTracesRequest.builder().applyMutation(batchGetTracesRequest).build());
}
/**
*
* Creates a group resource with a name and a filter expression.
*
*
* @param createGroupRequest
* @return 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.
*
* - 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.
*
* @sample XRayAsyncClient.CreateGroup
* @see AWS API
* Documentation
*/
default CompletableFuture createGroup(CreateGroupRequest createGroupRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Creates a group resource with a name and a filter expression.
*
*
*
* This is a convenience which creates an instance of the {@link CreateGroupRequest.Builder} avoiding the need to
* create one manually via {@link CreateGroupRequest#builder()}
*
*
* @param createGroupRequest
* A {@link Consumer} that will call methods on {@link CreateGroupRequest.Builder} to create a request.
* @return 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.
*
* - 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.
*
* @sample XRayAsyncClient.CreateGroup
* @see AWS API
* Documentation
*/
default CompletableFuture createGroup(Consumer createGroupRequest) {
return createGroup(CreateGroupRequest.builder().applyMutation(createGroupRequest).build());
}
/**
*
* 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.
*
*
* @param createSamplingRuleRequest
* @return 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.
*
* - 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.
*
* @sample XRayAsyncClient.CreateSamplingRule
* @see AWS API
* Documentation
*/
default CompletableFuture createSamplingRule(CreateSamplingRuleRequest createSamplingRuleRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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 {@link CreateSamplingRuleRequest.Builder} avoiding the
* need to create one manually via {@link CreateSamplingRuleRequest#builder()}
*
*
* @param createSamplingRuleRequest
* A {@link Consumer} that will call methods on {@link CreateSamplingRuleRequest.Builder} to create a
* request.
* @return 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.
*
* - 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.
*
* @sample XRayAsyncClient.CreateSamplingRule
* @see AWS API
* Documentation
*/
default CompletableFuture createSamplingRule(
Consumer createSamplingRuleRequest) {
return createSamplingRule(CreateSamplingRuleRequest.builder().applyMutation(createSamplingRuleRequest).build());
}
/**
*
* Deletes a group resource.
*
*
* @param deleteGroupRequest
* @return 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.
*
* - 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.
*
* @sample XRayAsyncClient.DeleteGroup
* @see AWS API
* Documentation
*/
default CompletableFuture deleteGroup(DeleteGroupRequest deleteGroupRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Deletes a group resource.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteGroupRequest.Builder} avoiding the need to
* create one manually via {@link DeleteGroupRequest#builder()}
*
*
* @param deleteGroupRequest
* A {@link Consumer} that will call methods on {@link DeleteGroupRequest.Builder} to create a request.
* @return 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.
*
* - 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.
*
* @sample XRayAsyncClient.DeleteGroup
* @see AWS API
* Documentation
*/
default CompletableFuture deleteGroup(Consumer deleteGroupRequest) {
return deleteGroup(DeleteGroupRequest.builder().applyMutation(deleteGroupRequest).build());
}
/**
*
* Deletes a sampling rule.
*
*
* @param deleteSamplingRuleRequest
* @return 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.
*
* - 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.
*
* @sample XRayAsyncClient.DeleteSamplingRule
* @see AWS API
* Documentation
*/
default CompletableFuture deleteSamplingRule(DeleteSamplingRuleRequest deleteSamplingRuleRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Deletes a sampling rule.
*
*
*
* This is a convenience which creates an instance of the {@link DeleteSamplingRuleRequest.Builder} avoiding the
* need to create one manually via {@link DeleteSamplingRuleRequest#builder()}
*
*
* @param deleteSamplingRuleRequest
* A {@link Consumer} that will call methods on {@link DeleteSamplingRuleRequest.Builder} to create a
* request.
* @return 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.
*
* - 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.
*
* @sample XRayAsyncClient.DeleteSamplingRule
* @see AWS API
* Documentation
*/
default CompletableFuture deleteSamplingRule(
Consumer deleteSamplingRuleRequest) {
return deleteSamplingRule(DeleteSamplingRuleRequest.builder().applyMutation(deleteSamplingRuleRequest).build());
}
/**
*
* Retrieves the current encryption configuration for X-Ray data.
*
*
* @param getEncryptionConfigRequest
* @return 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.
*
* - 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.
*
* @sample XRayAsyncClient.GetEncryptionConfig
* @see AWS API
* Documentation
*/
default CompletableFuture getEncryptionConfig(
GetEncryptionConfigRequest getEncryptionConfigRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Retrieves the current encryption configuration for X-Ray data.
*
*
*
* This is a convenience which creates an instance of the {@link GetEncryptionConfigRequest.Builder} avoiding the
* need to create one manually via {@link GetEncryptionConfigRequest#builder()}
*
*
* @param getEncryptionConfigRequest
* A {@link Consumer} that will call methods on {@link GetEncryptionConfigRequest.Builder} to create a
* request.
* @return 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.
*
* - 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.
*
* @sample XRayAsyncClient.GetEncryptionConfig
* @see AWS API
* Documentation
*/
default CompletableFuture getEncryptionConfig(
Consumer getEncryptionConfigRequest) {
return getEncryptionConfig(GetEncryptionConfigRequest.builder().applyMutation(getEncryptionConfigRequest).build());
}
/**
*
* Retrieves the current encryption configuration for X-Ray data.
*
*
* @return 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.
*
* - 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.
*
* @sample XRayAsyncClient.GetEncryptionConfig
* @see AWS API
* Documentation
*/
default CompletableFuture getEncryptionConfig() {
return getEncryptionConfig(GetEncryptionConfigRequest.builder().build());
}
/**
*
* Retrieves group resource details.
*
*
* @param getGroupRequest
* @return 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.
*
* - 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.
*
* @sample XRayAsyncClient.GetGroup
* @see AWS API
* Documentation
*/
default CompletableFuture getGroup(GetGroupRequest getGroupRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Retrieves group resource details.
*
*
*
* This is a convenience which creates an instance of the {@link GetGroupRequest.Builder} avoiding the need to
* create one manually via {@link GetGroupRequest#builder()}
*
*
* @param getGroupRequest
* A {@link Consumer} that will call methods on {@link GetGroupRequest.Builder} to create a request.
* @return 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.
*
* - 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.
*
* @sample XRayAsyncClient.GetGroup
* @see AWS API
* Documentation
*/
default CompletableFuture getGroup(Consumer getGroupRequest) {
return getGroup(GetGroupRequest.builder().applyMutation(getGroupRequest).build());
}
/**
*
* Retrieves all active group details.
*
*
* @param getGroupsRequest
* @return 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.
*
* - 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.
*
* @sample XRayAsyncClient.GetGroups
* @see AWS API
* Documentation
*/
default CompletableFuture getGroups(GetGroupsRequest getGroupsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Retrieves all active group details.
*
*
*
* This is a convenience which creates an instance of the {@link GetGroupsRequest.Builder} avoiding the need to
* create one manually via {@link GetGroupsRequest#builder()}
*
*
* @param getGroupsRequest
* A {@link Consumer} that will call methods on {@link GetGroupsRequest.Builder} to create a request.
* @return 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.
*
* - 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.
*
* @sample XRayAsyncClient.GetGroups
* @see AWS API
* Documentation
*/
default CompletableFuture getGroups(Consumer getGroupsRequest) {
return getGroups(GetGroupsRequest.builder().applyMutation(getGroupsRequest).build());
}
/**
*
* Retrieves all active group details.
*
*
* @return 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.
*
* - 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.
*
* @sample XRayAsyncClient.GetGroups
* @see AWS API
* Documentation
*/
default CompletableFuture getGroups() {
return getGroups(GetGroupsRequest.builder().build());
}
/**
*
* Retrieves all active group details.
*
*
*
* This is a variant of {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.xray.paginators.GetGroupsPublisher publisher = client.getGroupsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.xray.paginators.GetGroupsPublisher publisher = client.getGroupsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.xray.model.GetGroupsResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Note: If you prefer to have control on service calls, use the
* {@link #getGroups(software.amazon.awssdk.services.xray.model.GetGroupsRequest)} operation.
*
*
* @return 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.
*
* - 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.
*
* @sample XRayAsyncClient.GetGroups
* @see AWS API
* Documentation
*/
default GetGroupsPublisher getGroupsPaginator() {
return getGroupsPaginator(GetGroupsRequest.builder().build());
}
/**
*
* Retrieves all active group details.
*
*
*
* This is a variant of {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.xray.paginators.GetGroupsPublisher publisher = client.getGroupsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.xray.paginators.GetGroupsPublisher publisher = client.getGroupsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.xray.model.GetGroupsResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Note: If you prefer to have control on service calls, use the
* {@link #getGroups(software.amazon.awssdk.services.xray.model.GetGroupsRequest)} operation.
*
*
* @param getGroupsRequest
* @return 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.
*
* - 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.
*
* @sample XRayAsyncClient.GetGroups
* @see AWS API
* Documentation
*/
default GetGroupsPublisher getGroupsPaginator(GetGroupsRequest getGroupsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Retrieves all active group details.
*
*
*
* This is a variant of {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.xray.paginators.GetGroupsPublisher publisher = client.getGroupsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.xray.paginators.GetGroupsPublisher publisher = client.getGroupsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.xray.model.GetGroupsResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Note: If you prefer to have control on service calls, use the
* {@link #getGroups(software.amazon.awssdk.services.xray.model.GetGroupsRequest)} operation.
*
*
* This is a convenience which creates an instance of the {@link GetGroupsRequest.Builder} avoiding the need to
* create one manually via {@link GetGroupsRequest#builder()}
*
*
* @param getGroupsRequest
* A {@link Consumer} that will call methods on {@link GetGroupsRequest.Builder} to create a request.
* @return 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.
*
* - 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.
*
* @sample XRayAsyncClient.GetGroups
* @see AWS API
* Documentation
*/
default GetGroupsPublisher getGroupsPaginator(Consumer getGroupsRequest) {
return getGroupsPaginator(GetGroupsRequest.builder().applyMutation(getGroupsRequest).build());
}
/**
*
* Retrieves all sampling rules.
*
*
* @param getSamplingRulesRequest
* @return 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.
*
* - 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.
*
* @sample XRayAsyncClient.GetSamplingRules
* @see AWS API
* Documentation
*/
default CompletableFuture getSamplingRules(GetSamplingRulesRequest getSamplingRulesRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Retrieves all sampling rules.
*
*
*
* This is a convenience which creates an instance of the {@link GetSamplingRulesRequest.Builder} avoiding the need
* to create one manually via {@link GetSamplingRulesRequest#builder()}
*
*
* @param getSamplingRulesRequest
* A {@link Consumer} that will call methods on {@link GetSamplingRulesRequest.Builder} to create a request.
* @return 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.
*
* - 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.
*
* @sample XRayAsyncClient.GetSamplingRules
* @see AWS API
* Documentation
*/
default CompletableFuture getSamplingRules(
Consumer getSamplingRulesRequest) {
return getSamplingRules(GetSamplingRulesRequest.builder().applyMutation(getSamplingRulesRequest).build());
}
/**
*
* Retrieves all sampling rules.
*
*
* @return 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.
*
* - 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.
*
* @sample XRayAsyncClient.GetSamplingRules
* @see AWS API
* Documentation
*/
default CompletableFuture getSamplingRules() {
return getSamplingRules(GetSamplingRulesRequest.builder().build());
}
/**
*
* Retrieves all sampling rules.
*
*
*
* This is a variant of
* {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.xray.paginators.GetSamplingRulesPublisher publisher = client.getSamplingRulesPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.xray.paginators.GetSamplingRulesPublisher publisher = client.getSamplingRulesPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.xray.model.GetSamplingRulesResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Note: If you prefer to have control on service calls, use the
* {@link #getSamplingRules(software.amazon.awssdk.services.xray.model.GetSamplingRulesRequest)} operation.
*
*
* @return 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.
*
* - 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.
*
* @sample XRayAsyncClient.GetSamplingRules
* @see AWS API
* Documentation
*/
default GetSamplingRulesPublisher getSamplingRulesPaginator() {
return getSamplingRulesPaginator(GetSamplingRulesRequest.builder().build());
}
/**
*
* Retrieves all sampling rules.
*
*
*
* This is a variant of
* {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.xray.paginators.GetSamplingRulesPublisher publisher = client.getSamplingRulesPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.xray.paginators.GetSamplingRulesPublisher publisher = client.getSamplingRulesPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.xray.model.GetSamplingRulesResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Note: If you prefer to have control on service calls, use the
* {@link #getSamplingRules(software.amazon.awssdk.services.xray.model.GetSamplingRulesRequest)} operation.
*
*
* @param getSamplingRulesRequest
* @return 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.
*
* - 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.
*
* @sample XRayAsyncClient.GetSamplingRules
* @see AWS API
* Documentation
*/
default GetSamplingRulesPublisher getSamplingRulesPaginator(GetSamplingRulesRequest getSamplingRulesRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Retrieves all sampling rules.
*
*
*
* This is a variant of
* {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.xray.paginators.GetSamplingRulesPublisher publisher = client.getSamplingRulesPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.xray.paginators.GetSamplingRulesPublisher publisher = client.getSamplingRulesPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.xray.model.GetSamplingRulesResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Note: If you prefer to have control on service calls, use the
* {@link #getSamplingRules(software.amazon.awssdk.services.xray.model.GetSamplingRulesRequest)} operation.
*
*
* This is a convenience which creates an instance of the {@link GetSamplingRulesRequest.Builder} avoiding the need
* to create one manually via {@link GetSamplingRulesRequest#builder()}
*
*
* @param getSamplingRulesRequest
* A {@link Consumer} that will call methods on {@link GetSamplingRulesRequest.Builder} to create a request.
* @return 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.
*
* - 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.
*
* @sample XRayAsyncClient.GetSamplingRules
* @see AWS API
* Documentation
*/
default GetSamplingRulesPublisher getSamplingRulesPaginator(Consumer getSamplingRulesRequest) {
return getSamplingRulesPaginator(GetSamplingRulesRequest.builder().applyMutation(getSamplingRulesRequest).build());
}
/**
*
* Retrieves information about recent sampling results for all sampling rules.
*
*
* @param getSamplingStatisticSummariesRequest
* @return 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.
*
* - 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.
*
* @sample XRayAsyncClient.GetSamplingStatisticSummaries
* @see AWS API Documentation
*/
default CompletableFuture getSamplingStatisticSummaries(
GetSamplingStatisticSummariesRequest getSamplingStatisticSummariesRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Retrieves information about recent sampling results for all sampling rules.
*
*
*
* This is a convenience which creates an instance of the {@link GetSamplingStatisticSummariesRequest.Builder}
* avoiding the need to create one manually via {@link GetSamplingStatisticSummariesRequest#builder()}
*
*
* @param getSamplingStatisticSummariesRequest
* A {@link Consumer} that will call methods on {@link GetSamplingStatisticSummariesRequest.Builder} to
* create a request.
* @return 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.
*
* - 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.
*
* @sample XRayAsyncClient.GetSamplingStatisticSummaries
* @see AWS API Documentation
*/
default CompletableFuture getSamplingStatisticSummaries(
Consumer getSamplingStatisticSummariesRequest) {
return getSamplingStatisticSummaries(GetSamplingStatisticSummariesRequest.builder()
.applyMutation(getSamplingStatisticSummariesRequest).build());
}
/**
*
* Retrieves information about recent sampling results for all sampling rules.
*
*
* @return 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.
*
* - 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.
*
* @sample XRayAsyncClient.GetSamplingStatisticSummaries
* @see AWS API Documentation
*/
default CompletableFuture getSamplingStatisticSummaries() {
return getSamplingStatisticSummaries(GetSamplingStatisticSummariesRequest.builder().build());
}
/**
*
* Retrieves information about recent sampling results for all sampling rules.
*
*
*
* This is a variant of
* {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.xray.paginators.GetSamplingStatisticSummariesPublisher publisher = client.getSamplingStatisticSummariesPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.xray.paginators.GetSamplingStatisticSummariesPublisher publisher = client.getSamplingStatisticSummariesPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.xray.model.GetSamplingStatisticSummariesResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Note: If you prefer to have control on service calls, use the
* {@link #getSamplingStatisticSummaries(software.amazon.awssdk.services.xray.model.GetSamplingStatisticSummariesRequest)}
* operation.
*
*
* @return 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.
*
* - 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.
*
* @sample XRayAsyncClient.GetSamplingStatisticSummaries
* @see AWS API Documentation
*/
default GetSamplingStatisticSummariesPublisher getSamplingStatisticSummariesPaginator() {
return getSamplingStatisticSummariesPaginator(GetSamplingStatisticSummariesRequest.builder().build());
}
/**
*
* Retrieves information about recent sampling results for all sampling rules.
*
*
*
* This is a variant of
* {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.xray.paginators.GetSamplingStatisticSummariesPublisher publisher = client.getSamplingStatisticSummariesPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.xray.paginators.GetSamplingStatisticSummariesPublisher publisher = client.getSamplingStatisticSummariesPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.xray.model.GetSamplingStatisticSummariesResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Note: If you prefer to have control on service calls, use the
* {@link #getSamplingStatisticSummaries(software.amazon.awssdk.services.xray.model.GetSamplingStatisticSummariesRequest)}
* operation.
*
*
* @param getSamplingStatisticSummariesRequest
* @return 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.
*
* - 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.
*
* @sample XRayAsyncClient.GetSamplingStatisticSummaries
* @see AWS API Documentation
*/
default GetSamplingStatisticSummariesPublisher getSamplingStatisticSummariesPaginator(
GetSamplingStatisticSummariesRequest getSamplingStatisticSummariesRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Retrieves information about recent sampling results for all sampling rules.
*
*
*
* This is a variant of
* {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.xray.paginators.GetSamplingStatisticSummariesPublisher publisher = client.getSamplingStatisticSummariesPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.xray.paginators.GetSamplingStatisticSummariesPublisher publisher = client.getSamplingStatisticSummariesPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.xray.model.GetSamplingStatisticSummariesResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Note: If you prefer to have control on service calls, use the
* {@link #getSamplingStatisticSummaries(software.amazon.awssdk.services.xray.model.GetSamplingStatisticSummariesRequest)}
* operation.
*
*
* This is a convenience which creates an instance of the {@link GetSamplingStatisticSummariesRequest.Builder}
* avoiding the need to create one manually via {@link GetSamplingStatisticSummariesRequest#builder()}
*
*
* @param getSamplingStatisticSummariesRequest
* A {@link Consumer} that will call methods on {@link GetSamplingStatisticSummariesRequest.Builder} to
* create a request.
* @return 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.
*
* - 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.
*
* @sample XRayAsyncClient.GetSamplingStatisticSummaries
* @see AWS API Documentation
*/
default GetSamplingStatisticSummariesPublisher getSamplingStatisticSummariesPaginator(
Consumer getSamplingStatisticSummariesRequest) {
return getSamplingStatisticSummariesPaginator(GetSamplingStatisticSummariesRequest.builder()
.applyMutation(getSamplingStatisticSummariesRequest).build());
}
/**
*
* Requests a sampling quota for rules that the service is using to sample requests.
*
*
* @param getSamplingTargetsRequest
* @return 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.
*
* - 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.
*
* @sample XRayAsyncClient.GetSamplingTargets
* @see AWS API
* Documentation
*/
default CompletableFuture getSamplingTargets(GetSamplingTargetsRequest getSamplingTargetsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Requests a sampling quota for rules that the service is using to sample requests.
*
*
*
* This is a convenience which creates an instance of the {@link GetSamplingTargetsRequest.Builder} avoiding the
* need to create one manually via {@link GetSamplingTargetsRequest#builder()}
*
*
* @param getSamplingTargetsRequest
* A {@link Consumer} that will call methods on {@link GetSamplingTargetsRequest.Builder} to create a
* request.
* @return 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.
*
* - 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.
*
* @sample XRayAsyncClient.GetSamplingTargets
* @see AWS API
* Documentation
*/
default CompletableFuture getSamplingTargets(
Consumer getSamplingTargetsRequest) {
return getSamplingTargets(GetSamplingTargetsRequest.builder().applyMutation(getSamplingTargetsRequest).build());
}
/**
*
* Retrieves a document that describes services that process incoming requests, and downstream services that they
* call as a result. Root services process incoming requests and make calls to downstream services. Root services
* are applications that use the AWS X-Ray SDK. Downstream services can be other applications, AWS resources, HTTP
* web APIs, or SQL databases.
*
*
* @param getServiceGraphRequest
* @return 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.
*
* - 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.
*
* @sample XRayAsyncClient.GetServiceGraph
* @see AWS API
* Documentation
*/
default CompletableFuture getServiceGraph(GetServiceGraphRequest getServiceGraphRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Retrieves a document that describes services that process incoming requests, and downstream services that they
* call as a result. Root services process incoming requests and make calls to downstream services. Root services
* are applications that use the AWS X-Ray SDK. Downstream services can be other applications, AWS resources, HTTP
* web APIs, or SQL databases.
*
*
*
* This is a convenience which creates an instance of the {@link GetServiceGraphRequest.Builder} avoiding the need
* to create one manually via {@link GetServiceGraphRequest#builder()}
*
*
* @param getServiceGraphRequest
* A {@link Consumer} that will call methods on {@link GetServiceGraphRequest.Builder} to create a request.
* @return 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.
*
* - 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.
*
* @sample XRayAsyncClient.GetServiceGraph
* @see AWS API
* Documentation
*/
default CompletableFuture getServiceGraph(
Consumer getServiceGraphRequest) {
return getServiceGraph(GetServiceGraphRequest.builder().applyMutation(getServiceGraphRequest).build());
}
/**
*
* Retrieves a document that describes services that process incoming requests, and downstream services that they
* call as a result. Root services process incoming requests and make calls to downstream services. Root services
* are applications that use the AWS X-Ray SDK. Downstream services can be other applications, AWS resources, HTTP
* web APIs, or SQL databases.
*
*
*
* This is a variant of {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.xray.paginators.GetServiceGraphPublisher publisher = client.getServiceGraphPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.xray.paginators.GetServiceGraphPublisher publisher = client.getServiceGraphPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.xray.model.GetServiceGraphResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Note: If you prefer to have control on service calls, use the
* {@link #getServiceGraph(software.amazon.awssdk.services.xray.model.GetServiceGraphRequest)} operation.
*
*
* @param getServiceGraphRequest
* @return 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.
*
* - 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.
*
* @sample XRayAsyncClient.GetServiceGraph
* @see AWS API
* Documentation
*/
default GetServiceGraphPublisher getServiceGraphPaginator(GetServiceGraphRequest getServiceGraphRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Retrieves a document that describes services that process incoming requests, and downstream services that they
* call as a result. Root services process incoming requests and make calls to downstream services. Root services
* are applications that use the AWS X-Ray SDK. Downstream services can be other applications, AWS resources, HTTP
* web APIs, or SQL databases.
*
*
*
* This is a variant of {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.xray.paginators.GetServiceGraphPublisher publisher = client.getServiceGraphPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.xray.paginators.GetServiceGraphPublisher publisher = client.getServiceGraphPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.xray.model.GetServiceGraphResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Note: If you prefer to have control on service calls, use the
* {@link #getServiceGraph(software.amazon.awssdk.services.xray.model.GetServiceGraphRequest)} operation.
*
*
* This is a convenience which creates an instance of the {@link GetServiceGraphRequest.Builder} avoiding the need
* to create one manually via {@link GetServiceGraphRequest#builder()}
*
*
* @param getServiceGraphRequest
* A {@link Consumer} that will call methods on {@link GetServiceGraphRequest.Builder} to create a request.
* @return 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.
*
* - 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.
*
* @sample XRayAsyncClient.GetServiceGraph
* @see AWS API
* Documentation
*/
default GetServiceGraphPublisher getServiceGraphPaginator(Consumer getServiceGraphRequest) {
return getServiceGraphPaginator(GetServiceGraphRequest.builder().applyMutation(getServiceGraphRequest).build());
}
/**
*
* Get an aggregation of service statistics defined by a specific time range.
*
*
* @param getTimeSeriesServiceStatisticsRequest
* @return 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.
*
* - 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.
*
* @sample XRayAsyncClient.GetTimeSeriesServiceStatistics
* @see AWS API Documentation
*/
default CompletableFuture getTimeSeriesServiceStatistics(
GetTimeSeriesServiceStatisticsRequest getTimeSeriesServiceStatisticsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Get an aggregation of service statistics defined by a specific time range.
*
*
*
* This is a convenience which creates an instance of the {@link GetTimeSeriesServiceStatisticsRequest.Builder}
* avoiding the need to create one manually via {@link GetTimeSeriesServiceStatisticsRequest#builder()}
*
*
* @param getTimeSeriesServiceStatisticsRequest
* A {@link Consumer} that will call methods on {@link GetTimeSeriesServiceStatisticsRequest.Builder} to
* create a request.
* @return 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.
*
* - 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.
*
* @sample XRayAsyncClient.GetTimeSeriesServiceStatistics
* @see AWS API Documentation
*/
default CompletableFuture getTimeSeriesServiceStatistics(
Consumer getTimeSeriesServiceStatisticsRequest) {
return getTimeSeriesServiceStatistics(GetTimeSeriesServiceStatisticsRequest.builder()
.applyMutation(getTimeSeriesServiceStatisticsRequest).build());
}
/**
*
* Get an aggregation of service statistics defined by a specific time range.
*
*
*
* This is a variant of
* {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.xray.paginators.GetTimeSeriesServiceStatisticsPublisher publisher = client.getTimeSeriesServiceStatisticsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.xray.paginators.GetTimeSeriesServiceStatisticsPublisher publisher = client.getTimeSeriesServiceStatisticsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.xray.model.GetTimeSeriesServiceStatisticsResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Note: If you prefer to have control on service calls, use the
* {@link #getTimeSeriesServiceStatistics(software.amazon.awssdk.services.xray.model.GetTimeSeriesServiceStatisticsRequest)}
* operation.
*
*
* @param getTimeSeriesServiceStatisticsRequest
* @return 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.
*
* - 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.
*
* @sample XRayAsyncClient.GetTimeSeriesServiceStatistics
* @see AWS API Documentation
*/
default GetTimeSeriesServiceStatisticsPublisher getTimeSeriesServiceStatisticsPaginator(
GetTimeSeriesServiceStatisticsRequest getTimeSeriesServiceStatisticsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Get an aggregation of service statistics defined by a specific time range.
*
*
*
* This is a variant of
* {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.xray.paginators.GetTimeSeriesServiceStatisticsPublisher publisher = client.getTimeSeriesServiceStatisticsPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.xray.paginators.GetTimeSeriesServiceStatisticsPublisher publisher = client.getTimeSeriesServiceStatisticsPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.xray.model.GetTimeSeriesServiceStatisticsResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Note: If you prefer to have control on service calls, use the
* {@link #getTimeSeriesServiceStatistics(software.amazon.awssdk.services.xray.model.GetTimeSeriesServiceStatisticsRequest)}
* operation.
*
*
* This is a convenience which creates an instance of the {@link GetTimeSeriesServiceStatisticsRequest.Builder}
* avoiding the need to create one manually via {@link GetTimeSeriesServiceStatisticsRequest#builder()}
*
*
* @param getTimeSeriesServiceStatisticsRequest
* A {@link Consumer} that will call methods on {@link GetTimeSeriesServiceStatisticsRequest.Builder} to
* create a request.
* @return 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.
*
* - 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.
*
* @sample XRayAsyncClient.GetTimeSeriesServiceStatistics
* @see AWS API Documentation
*/
default GetTimeSeriesServiceStatisticsPublisher getTimeSeriesServiceStatisticsPaginator(
Consumer getTimeSeriesServiceStatisticsRequest) {
return getTimeSeriesServiceStatisticsPaginator(GetTimeSeriesServiceStatisticsRequest.builder()
.applyMutation(getTimeSeriesServiceStatisticsRequest).build());
}
/**
*
* Retrieves a service graph for one or more specific trace IDs.
*
*
* @param getTraceGraphRequest
* @return 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.
*
* - 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.
*
* @sample XRayAsyncClient.GetTraceGraph
* @see AWS API
* Documentation
*/
default CompletableFuture getTraceGraph(GetTraceGraphRequest getTraceGraphRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Retrieves a service graph for one or more specific trace IDs.
*
*
*
* This is a convenience which creates an instance of the {@link GetTraceGraphRequest.Builder} avoiding the need to
* create one manually via {@link GetTraceGraphRequest#builder()}
*
*
* @param getTraceGraphRequest
* A {@link Consumer} that will call methods on {@link GetTraceGraphRequest.Builder} to create a request.
* @return 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.
*
* - 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.
*
* @sample XRayAsyncClient.GetTraceGraph
* @see AWS API
* Documentation
*/
default CompletableFuture getTraceGraph(Consumer getTraceGraphRequest) {
return getTraceGraph(GetTraceGraphRequest.builder().applyMutation(getTraceGraphRequest).build());
}
/**
*
* Retrieves a service graph for one or more specific trace IDs.
*
*
*
* This is a variant of {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.xray.paginators.GetTraceGraphPublisher publisher = client.getTraceGraphPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.xray.paginators.GetTraceGraphPublisher publisher = client.getTraceGraphPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.xray.model.GetTraceGraphResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Note: If you prefer to have control on service calls, use the
* {@link #getTraceGraph(software.amazon.awssdk.services.xray.model.GetTraceGraphRequest)} operation.
*
*
* @param getTraceGraphRequest
* @return 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.
*
* - 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.
*
* @sample XRayAsyncClient.GetTraceGraph
* @see AWS API
* Documentation
*/
default GetTraceGraphPublisher getTraceGraphPaginator(GetTraceGraphRequest getTraceGraphRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Retrieves a service graph for one or more specific trace IDs.
*
*
*
* This is a variant of {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.xray.paginators.GetTraceGraphPublisher publisher = client.getTraceGraphPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.xray.paginators.GetTraceGraphPublisher publisher = client.getTraceGraphPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.xray.model.GetTraceGraphResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Note: If you prefer to have control on service calls, use the
* {@link #getTraceGraph(software.amazon.awssdk.services.xray.model.GetTraceGraphRequest)} operation.
*
*
* This is a convenience which creates an instance of the {@link GetTraceGraphRequest.Builder} avoiding the need to
* create one manually via {@link GetTraceGraphRequest#builder()}
*
*
* @param getTraceGraphRequest
* A {@link Consumer} that will call methods on {@link GetTraceGraphRequest.Builder} to create a request.
* @return 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.
*
* - 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.
*
* @sample XRayAsyncClient.GetTraceGraph
* @see AWS API
* Documentation
*/
default GetTraceGraphPublisher getTraceGraphPaginator(Consumer getTraceGraphRequest) {
return getTraceGraphPaginator(GetTraceGraphRequest.builder().applyMutation(getTraceGraphRequest).build());
}
/**
*
* Retrieves IDs and metadata for traces available for a specified time frame using an optional filter. To get the
* full traces, pass the trace IDs to BatchGetTraces.
*
*
* A filter expression can target traced requests that hit specific service nodes or edges, have errors, or come
* from a known user. For example, the following filter expression targets traces that pass through
* api.example.com:
*
*
* service("api.example.com")
*
*
* This filter expression finds traces that have an annotation named account with the value
* 12345:
*
*
* annotation.account = "12345"
*
*
* For a full list of indexed fields and keywords that you can use in filter expressions, see Using Filter Expressions in
* the AWS X-Ray Developer Guide.
*
*
* @param getTraceSummariesRequest
* @return 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.
*
* - 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.
*
* @sample XRayAsyncClient.GetTraceSummaries
* @see AWS API
* Documentation
*/
default CompletableFuture getTraceSummaries(GetTraceSummariesRequest getTraceSummariesRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Retrieves IDs and metadata for traces available for a specified time frame using an optional filter. To get the
* full traces, pass the trace IDs to BatchGetTraces.
*
*
* A filter expression can target traced requests that hit specific service nodes or edges, have errors, or come
* from a known user. For example, the following filter expression targets traces that pass through
* api.example.com:
*
*
* service("api.example.com")
*
*
* This filter expression finds traces that have an annotation named account with the value
* 12345:
*
*
* annotation.account = "12345"
*
*
* For a full list of indexed fields and keywords that you can use in filter expressions, see Using Filter Expressions in
* the AWS X-Ray Developer Guide.
*
*
*
* This is a convenience which creates an instance of the {@link GetTraceSummariesRequest.Builder} avoiding the need
* to create one manually via {@link GetTraceSummariesRequest#builder()}
*
*
* @param getTraceSummariesRequest
* A {@link Consumer} that will call methods on {@link GetTraceSummariesRequest.Builder} to create a request.
* @return 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.
*
* - 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.
*
* @sample XRayAsyncClient.GetTraceSummaries
* @see AWS API
* Documentation
*/
default CompletableFuture getTraceSummaries(
Consumer getTraceSummariesRequest) {
return getTraceSummaries(GetTraceSummariesRequest.builder().applyMutation(getTraceSummariesRequest).build());
}
/**
*
* Retrieves IDs and metadata for traces available for a specified time frame using an optional filter. To get the
* full traces, pass the trace IDs to BatchGetTraces.
*
*
* A filter expression can target traced requests that hit specific service nodes or edges, have errors, or come
* from a known user. For example, the following filter expression targets traces that pass through
* api.example.com:
*
*
* service("api.example.com")
*
*
* This filter expression finds traces that have an annotation named account with the value
* 12345:
*
*
* annotation.account = "12345"
*
*
* For a full list of indexed fields and keywords that you can use in filter expressions, see Using Filter Expressions in
* the AWS X-Ray Developer Guide.
*
*
*
* This is a variant of
* {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.xray.paginators.GetTraceSummariesPublisher publisher = client.getTraceSummariesPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.xray.paginators.GetTraceSummariesPublisher publisher = client.getTraceSummariesPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.xray.model.GetTraceSummariesResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Note: If you prefer to have control on service calls, use the
* {@link #getTraceSummaries(software.amazon.awssdk.services.xray.model.GetTraceSummariesRequest)} operation.
*
*
* @param getTraceSummariesRequest
* @return 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.
*
* - 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.
*
* @sample XRayAsyncClient.GetTraceSummaries
* @see AWS API
* Documentation
*/
default GetTraceSummariesPublisher getTraceSummariesPaginator(GetTraceSummariesRequest getTraceSummariesRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Retrieves IDs and metadata for traces available for a specified time frame using an optional filter. To get the
* full traces, pass the trace IDs to BatchGetTraces.
*
*
* A filter expression can target traced requests that hit specific service nodes or edges, have errors, or come
* from a known user. For example, the following filter expression targets traces that pass through
* api.example.com:
*
*
* service("api.example.com")
*
*
* This filter expression finds traces that have an annotation named account with the value
* 12345:
*
*
* annotation.account = "12345"
*
*
* For a full list of indexed fields and keywords that you can use in filter expressions, see Using Filter Expressions in
* the AWS X-Ray Developer Guide.
*
*
*
* This is a variant of
* {@link #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
* {@link org.reactivestreams.Publisher#subscribe(org.reactivestreams.Subscriber)}. Each call to the subscribe
* method will result in a new {@link org.reactivestreams.Subscription} i.e., a new contract to stream data from the
* starting request.
*
*
*
* The following are few ways to use the response class:
*
* 1) Using the subscribe helper method
*
*
* {@code
* software.amazon.awssdk.services.xray.paginators.GetTraceSummariesPublisher publisher = client.getTraceSummariesPaginator(request);
* CompletableFuture future = publisher.subscribe(res -> { // Do something with the response });
* future.get();
* }
*
*
* 2) Using a custom subscriber
*
*
* {@code
* software.amazon.awssdk.services.xray.paginators.GetTraceSummariesPublisher publisher = client.getTraceSummariesPaginator(request);
* publisher.subscribe(new Subscriber() {
*
* public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
*
*
* public void onNext(software.amazon.awssdk.services.xray.model.GetTraceSummariesResponse response) { //... };
* });}
*
*
* As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
*
* Note: If you prefer to have control on service calls, use the
* {@link #getTraceSummaries(software.amazon.awssdk.services.xray.model.GetTraceSummariesRequest)} operation.
*
*
* This is a convenience which creates an instance of the {@link GetTraceSummariesRequest.Builder} avoiding the need
* to create one manually via {@link GetTraceSummariesRequest#builder()}
*
*
* @param getTraceSummariesRequest
* A {@link Consumer} that will call methods on {@link GetTraceSummariesRequest.Builder} to create a request.
* @return 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.
*
* - 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.
*
* @sample XRayAsyncClient.GetTraceSummaries
* @see AWS API
* Documentation
*/
default GetTraceSummariesPublisher getTraceSummariesPaginator(
Consumer getTraceSummariesRequest) {
return getTraceSummariesPaginator(GetTraceSummariesRequest.builder().applyMutation(getTraceSummariesRequest).build());
}
/**
*
* Updates the encryption configuration for X-Ray data.
*
*
* @param putEncryptionConfigRequest
* @return 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.
*
* - 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.
*
* @sample XRayAsyncClient.PutEncryptionConfig
* @see AWS API
* Documentation
*/
default CompletableFuture putEncryptionConfig(
PutEncryptionConfigRequest putEncryptionConfigRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Updates the encryption configuration for X-Ray data.
*
*
*
* This is a convenience which creates an instance of the {@link PutEncryptionConfigRequest.Builder} avoiding the
* need to create one manually via {@link PutEncryptionConfigRequest#builder()}
*
*
* @param putEncryptionConfigRequest
* A {@link Consumer} that will call methods on {@link PutEncryptionConfigRequest.Builder} to create a
* request.
* @return 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.
*
* - 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.
*
* @sample XRayAsyncClient.PutEncryptionConfig
* @see AWS API
* Documentation
*/
default CompletableFuture putEncryptionConfig(
Consumer putEncryptionConfigRequest) {
return putEncryptionConfig(PutEncryptionConfigRequest.builder().applyMutation(putEncryptionConfigRequest).build());
}
/**
*
* Used by the AWS X-Ray daemon to upload telemetry.
*
*
* @param putTelemetryRecordsRequest
* @return 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.
*
* - 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.
*
* @sample XRayAsyncClient.PutTelemetryRecords
* @see AWS API
* Documentation
*/
default CompletableFuture putTelemetryRecords(
PutTelemetryRecordsRequest putTelemetryRecordsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Used by the AWS X-Ray daemon to upload telemetry.
*
*
*
* This is a convenience which creates an instance of the {@link PutTelemetryRecordsRequest.Builder} avoiding the
* need to create one manually via {@link PutTelemetryRecordsRequest#builder()}
*
*
* @param putTelemetryRecordsRequest
* A {@link Consumer} that will call methods on {@link PutTelemetryRecordsRequest.Builder} to create a
* request.
* @return 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.
*
* - 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.
*
* @sample XRayAsyncClient.PutTelemetryRecords
* @see AWS API
* Documentation
*/
default CompletableFuture putTelemetryRecords(
Consumer putTelemetryRecordsRequest) {
return putTelemetryRecords(PutTelemetryRecordsRequest.builder().applyMutation(putTelemetryRecordsRequest).build());
}
/**
*
* Uploads segment documents to AWS X-Ray. The X-Ray SDK generates segment documents and sends them to the X-Ray
* daemon, which uploads them in batches. A segment document can be a completed segment, an in-progress segment, or
* an array of subsegments.
*
*
* Segments must include the following fields. For the full segment document schema, see AWS X-Ray Segment
* Documents in the AWS X-Ray Developer Guide.
*
*
* Required Segment Document Fields
*
*
* -
*
* name - The name of the service that handled the request.
*
*
* -
*
* id - A 64-bit identifier for the segment, unique among segments in the same trace, in 16 hexadecimal
* digits.
*
*
* -
*
* trace_id - A unique identifier that connects all segments and subsegments originating from a single
* client request.
*
*
* -
*
* start_time - Time the segment or subsegment was created, in floating point seconds in epoch time,
* accurate to milliseconds. For example, 1480615200.010 or 1.480615200010E9.
*
*
* -
*
* end_time - Time the segment or subsegment was closed. For example, 1480615200.090 or
* 1.480615200090E9. Specify either an end_time or in_progress.
*
*
* -
*
* in_progress - Set to true instead of specifying an end_time to record that
* a segment has been started, but is not complete. Send an in progress segment when your application receives a
* request that will take a long time to serve, to trace the fact that the request was received. When the response
* is sent, send the complete segment to overwrite the in-progress segment.
*
*
*
*
* A trace_id consists of three numbers separated by hyphens. For example,
* 1-58406520-a006649127e371903a2de979. This includes:
*
*
* Trace ID Format
*
*
* -
*
* The version number, i.e. 1.
*
*
* -
*
* The time of the original request, in Unix epoch time, in 8 hexadecimal digits. For example, 10:00AM December 2nd,
* 2016 PST in epoch time is 1480615200 seconds, or 58406520 in hexadecimal.
*
*
* -
*
* A 96-bit identifier for the trace, globally unique, in 24 hexadecimal digits.
*
*
*
*
* @param putTraceSegmentsRequest
* @return 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.
*
* - 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.
*
* @sample XRayAsyncClient.PutTraceSegments
* @see AWS API
* Documentation
*/
default CompletableFuture putTraceSegments(PutTraceSegmentsRequest putTraceSegmentsRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Uploads segment documents to AWS X-Ray. The X-Ray SDK generates segment documents and sends them to the X-Ray
* daemon, which uploads them in batches. A segment document can be a completed segment, an in-progress segment, or
* an array of subsegments.
*
*
* Segments must include the following fields. For the full segment document schema, see AWS X-Ray Segment
* Documents in the AWS X-Ray Developer Guide.
*
*
* Required Segment Document Fields
*
*
* -
*
* name - The name of the service that handled the request.
*
*
* -
*
* id - A 64-bit identifier for the segment, unique among segments in the same trace, in 16 hexadecimal
* digits.
*
*
* -
*
* trace_id - A unique identifier that connects all segments and subsegments originating from a single
* client request.
*
*
* -
*
* start_time - Time the segment or subsegment was created, in floating point seconds in epoch time,
* accurate to milliseconds. For example, 1480615200.010 or 1.480615200010E9.
*
*
* -
*
* end_time - Time the segment or subsegment was closed. For example, 1480615200.090 or
* 1.480615200090E9. Specify either an end_time or in_progress.
*
*
* -
*
* in_progress - Set to true instead of specifying an end_time to record that
* a segment has been started, but is not complete. Send an in progress segment when your application receives a
* request that will take a long time to serve, to trace the fact that the request was received. When the response
* is sent, send the complete segment to overwrite the in-progress segment.
*
*
*
*
* A trace_id consists of three numbers separated by hyphens. For example,
* 1-58406520-a006649127e371903a2de979. This includes:
*
*
* Trace ID Format
*
*
* -
*
* The version number, i.e. 1.
*
*
* -
*
* The time of the original request, in Unix epoch time, in 8 hexadecimal digits. For example, 10:00AM December 2nd,
* 2016 PST in epoch time is 1480615200 seconds, or 58406520 in hexadecimal.
*
*
* -
*
* A 96-bit identifier for the trace, globally unique, in 24 hexadecimal digits.
*
*
*
*
*
* This is a convenience which creates an instance of the {@link PutTraceSegmentsRequest.Builder} avoiding the need
* to create one manually via {@link PutTraceSegmentsRequest#builder()}
*
*
* @param putTraceSegmentsRequest
* A {@link Consumer} that will call methods on {@link PutTraceSegmentsRequest.Builder} to create a request.
* @return 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.
*
* - 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.
*
* @sample XRayAsyncClient.PutTraceSegments
* @see AWS API
* Documentation
*/
default CompletableFuture putTraceSegments(
Consumer putTraceSegmentsRequest) {
return putTraceSegments(PutTraceSegmentsRequest.builder().applyMutation(putTraceSegmentsRequest).build());
}
/**
*
* Updates a group resource.
*
*
* @param updateGroupRequest
* @return 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.
*
* - 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.
*
* @sample XRayAsyncClient.UpdateGroup
* @see AWS API
* Documentation
*/
default CompletableFuture updateGroup(UpdateGroupRequest updateGroupRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Updates a group resource.
*
*
*
* This is a convenience which creates an instance of the {@link UpdateGroupRequest.Builder} avoiding the need to
* create one manually via {@link UpdateGroupRequest#builder()}
*
*
* @param updateGroupRequest
* A {@link Consumer} that will call methods on {@link UpdateGroupRequest.Builder} to create a request.
* @return 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.
*
* - 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.
*
* @sample XRayAsyncClient.UpdateGroup
* @see AWS API
* Documentation
*/
default CompletableFuture updateGroup(Consumer updateGroupRequest) {
return updateGroup(UpdateGroupRequest.builder().applyMutation(updateGroupRequest).build());
}
/**
*
* Modifies a sampling rule's configuration.
*
*
* @param updateSamplingRuleRequest
* @return 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.
*
* - 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.
*
* @sample XRayAsyncClient.UpdateSamplingRule
* @see AWS API
* Documentation
*/
default CompletableFuture updateSamplingRule(UpdateSamplingRuleRequest updateSamplingRuleRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Modifies a sampling rule's configuration.
*
*
*
* This is a convenience which creates an instance of the {@link UpdateSamplingRuleRequest.Builder} avoiding the
* need to create one manually via {@link UpdateSamplingRuleRequest#builder()}
*
*
* @param updateSamplingRuleRequest
* A {@link Consumer} that will call methods on {@link UpdateSamplingRuleRequest.Builder} to create a
* request.
* @return 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.
*
* - 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.
*
* @sample XRayAsyncClient.UpdateSamplingRule
* @see AWS API
* Documentation
*/
default CompletableFuture updateSamplingRule(
Consumer updateSamplingRuleRequest) {
return updateSamplingRule(UpdateSamplingRuleRequest.builder().applyMutation(updateSamplingRuleRequest).build());
}
}