Interface XRayAsyncClient

All Superinterfaces:
AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient
@Generated("software.amazon.awssdk:codegen") @SdkPublicApi @ThreadSafe public interface XRayAsyncClient extends AwsClient
Service client for accessing AWS X-Ray asynchronously. This can be created using the static builder() method.The asynchronous client performs non-blocking I/O when configured with any SdkAsyncHttpClient supported in the SDK. However, full non-blocking is not guaranteed as the async client may perform blocking calls in some cases such as credentials retrieval and endpoint discovery as part of the async API call.

Amazon Web Services X-Ray provides APIs for managing debug traces and retrieving service maps and other data created by processing those traces.

  • Field Details

  • Method Details

    • batchGetTraces

      default CompletableFuture<BatchGetTracesResponse> batchGetTraces(BatchGetTracesRequest batchGetTracesRequest)

      You cannot find traces through this API if Transaction Search is enabled since trace is not indexed in X-Ray.

      Retrieves a list of traces specified by ID. Each trace is a collection of segment documents that originates from a single request. Use GetTraceSummaries to get a list of trace IDs.

      Parameters:
      batchGetTracesRequest -
      Returns:
      A Java Future containing the result of the BatchGetTraces operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException The request is missing required parameters or has invalid parameters.
      • ThrottledException The request exceeds the maximum number of requests per second.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • batchGetTraces

      default CompletableFuture<BatchGetTracesResponse> batchGetTraces(Consumer<BatchGetTracesRequest.Builder> batchGetTracesRequest)

      You cannot find traces through this API if Transaction Search is enabled since trace is not indexed in X-Ray.

      Retrieves a list of traces specified by ID. Each trace is a collection of segment documents that originates from a single request. Use GetTraceSummaries to get a list of trace IDs.


      This is a convenience which creates an instance of the BatchGetTracesRequest.Builder avoiding the need to create one manually via BatchGetTracesRequest.builder()

      Parameters:
      batchGetTracesRequest - A Consumer that will call methods on BatchGetTracesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the BatchGetTraces operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException The request is missing required parameters or has invalid parameters.
      • ThrottledException The request exceeds the maximum number of requests per second.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • batchGetTracesPaginator

      default BatchGetTracesPublisher batchGetTracesPaginator(BatchGetTracesRequest batchGetTracesRequest)

      This is a variant of batchGetTraces(software.amazon.awssdk.services.xray.model.BatchGetTracesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.xray.paginators.BatchGetTracesPublisher publisher = client.batchGetTracesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.xray.paginators.BatchGetTracesPublisher publisher = client.batchGetTracesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.xray.model.BatchGetTracesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.xray.model.BatchGetTracesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the batchGetTraces(software.amazon.awssdk.services.xray.model.BatchGetTracesRequest) operation.

      Parameters:
      batchGetTracesRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException The request is missing required parameters or has invalid parameters.
      • ThrottledException The request exceeds the maximum number of requests per second.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • batchGetTracesPaginator

      default BatchGetTracesPublisher batchGetTracesPaginator(Consumer<BatchGetTracesRequest.Builder> batchGetTracesRequest)

      This is a variant of batchGetTraces(software.amazon.awssdk.services.xray.model.BatchGetTracesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.xray.paginators.BatchGetTracesPublisher publisher = client.batchGetTracesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.xray.paginators.BatchGetTracesPublisher publisher = client.batchGetTracesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.xray.model.BatchGetTracesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.xray.model.BatchGetTracesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the batchGetTraces(software.amazon.awssdk.services.xray.model.BatchGetTracesRequest) operation.


      This is a convenience which creates an instance of the BatchGetTracesRequest.Builder avoiding the need to create one manually via BatchGetTracesRequest.builder()

      Parameters:
      batchGetTracesRequest - A Consumer that will call methods on BatchGetTracesRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException The request is missing required parameters or has invalid parameters.
      • ThrottledException The request exceeds the maximum number of requests per second.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • cancelTraceRetrieval

      default CompletableFuture<CancelTraceRetrievalResponse> cancelTraceRetrieval(CancelTraceRetrievalRequest cancelTraceRetrievalRequest)

      Cancels an ongoing trace retrieval job initiated by StartTraceRetrieval using the provided RetrievalToken. A successful cancellation will return an HTTP 200 response.

      Parameters:
      cancelTraceRetrievalRequest -
      Returns:
      A Java Future containing the result of the CancelTraceRetrieval operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException The request is missing required parameters or has invalid parameters.
      • ThrottledException The request exceeds the maximum number of requests per second.
      • ResourceNotFoundException The resource was not found. Verify that the name or Amazon Resource Name (ARN) of the resource is correct.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • cancelTraceRetrieval

      default CompletableFuture<CancelTraceRetrievalResponse> cancelTraceRetrieval(Consumer<CancelTraceRetrievalRequest.Builder> cancelTraceRetrievalRequest)

      Cancels an ongoing trace retrieval job initiated by StartTraceRetrieval using the provided RetrievalToken. A successful cancellation will return an HTTP 200 response.


      This is a convenience which creates an instance of the CancelTraceRetrievalRequest.Builder avoiding the need to create one manually via CancelTraceRetrievalRequest.builder()

      Parameters:
      cancelTraceRetrievalRequest - A Consumer that will call methods on CancelTraceRetrievalRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CancelTraceRetrieval operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException The request is missing required parameters or has invalid parameters.
      • ThrottledException The request exceeds the maximum number of requests per second.
      • ResourceNotFoundException The resource was not found. Verify that the name or Amazon Resource Name (ARN) of the resource is correct.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createGroup

      default CompletableFuture<CreateGroupResponse> createGroup(CreateGroupRequest createGroupRequest)

      Creates a group resource with a name and a filter expression.

      Parameters:
      createGroupRequest -
      Returns:
      A Java Future containing the result of the CreateGroup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException The request is missing required parameters or has invalid parameters.
      • ThrottledException The request exceeds the maximum number of requests per second.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createGroup

      default CompletableFuture<CreateGroupResponse> createGroup(Consumer<CreateGroupRequest.Builder> createGroupRequest)

      Creates a group resource with a name and a filter expression.


      This is a convenience which creates an instance of the CreateGroupRequest.Builder avoiding the need to create one manually via CreateGroupRequest.builder()

      Parameters:
      createGroupRequest - A Consumer that will call methods on CreateGroupRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateGroup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException The request is missing required parameters or has invalid parameters.
      • ThrottledException The request exceeds the maximum number of requests per second.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createSamplingRule

      default CompletableFuture<CreateSamplingRuleResponse> createSamplingRule(CreateSamplingRuleRequest createSamplingRuleRequest)

      Creates a rule to control sampling behavior for instrumented applications. Services retrieve rules with GetSamplingRules, and evaluate each rule in ascending order of priority for each request. If a rule matches, the service records a trace, borrowing it from the reservoir size. After 10 seconds, the service reports back to X-Ray with GetSamplingTargets to get updated versions of each in-use rule. The updated rule contains a trace quota that the service can use instead of borrowing from the reservoir.

      Parameters:
      createSamplingRuleRequest -
      Returns:
      A Java Future containing the result of the CreateSamplingRule operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException The request is missing required parameters or has invalid parameters.
      • ThrottledException The request exceeds the maximum number of requests per second.
      • RuleLimitExceededException You have reached the maximum number of sampling rules.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createSamplingRule

      default CompletableFuture<CreateSamplingRuleResponse> createSamplingRule(Consumer<CreateSamplingRuleRequest.Builder> createSamplingRuleRequest)

      Creates a rule to control sampling behavior for instrumented applications. Services retrieve rules with GetSamplingRules, and evaluate each rule in ascending order of priority for each request. If a rule matches, the service records a trace, borrowing it from the reservoir size. After 10 seconds, the service reports back to X-Ray with GetSamplingTargets to get updated versions of each in-use rule. The updated rule contains a trace quota that the service can use instead of borrowing from the reservoir.


      This is a convenience which creates an instance of the CreateSamplingRuleRequest.Builder avoiding the need to create one manually via CreateSamplingRuleRequest.builder()

      Parameters:
      createSamplingRuleRequest - A Consumer that will call methods on CreateSamplingRuleRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreateSamplingRule operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException The request is missing required parameters or has invalid parameters.
      • ThrottledException The request exceeds the maximum number of requests per second.
      • RuleLimitExceededException You have reached the maximum number of sampling rules.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteGroup

      default CompletableFuture<DeleteGroupResponse> deleteGroup(DeleteGroupRequest deleteGroupRequest)

      Deletes a group resource.

      Parameters:
      deleteGroupRequest -
      Returns:
      A Java Future containing the result of the DeleteGroup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException The request is missing required parameters or has invalid parameters.
      • ThrottledException The request exceeds the maximum number of requests per second.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteGroup

      default CompletableFuture<DeleteGroupResponse> deleteGroup(Consumer<DeleteGroupRequest.Builder> deleteGroupRequest)

      Deletes a group resource.


      This is a convenience which creates an instance of the DeleteGroupRequest.Builder avoiding the need to create one manually via DeleteGroupRequest.builder()

      Parameters:
      deleteGroupRequest - A Consumer that will call methods on DeleteGroupRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteGroup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException The request is missing required parameters or has invalid parameters.
      • ThrottledException The request exceeds the maximum number of requests per second.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteResourcePolicy

      default CompletableFuture<DeleteResourcePolicyResponse> deleteResourcePolicy(DeleteResourcePolicyRequest deleteResourcePolicyRequest)

      Deletes a resource policy from the target Amazon Web Services account.

      Parameters:
      deleteResourcePolicyRequest -
      Returns:
      A Java Future containing the result of the DeleteResourcePolicy operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException The request is missing required parameters or has invalid parameters.
      • InvalidPolicyRevisionIdException A policy revision id was provided which does not match the latest policy revision. This exception is also if a policy revision id of 0 is provided via PutResourcePolicy and a policy with the same name already exists.
      • ThrottledException The request exceeds the maximum number of requests per second.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteResourcePolicy

      default CompletableFuture<DeleteResourcePolicyResponse> deleteResourcePolicy(Consumer<DeleteResourcePolicyRequest.Builder> deleteResourcePolicyRequest)

      Deletes a resource policy from the target Amazon Web Services account.


      This is a convenience which creates an instance of the DeleteResourcePolicyRequest.Builder avoiding the need to create one manually via DeleteResourcePolicyRequest.builder()

      Parameters:
      deleteResourcePolicyRequest - A Consumer that will call methods on DeleteResourcePolicyRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteResourcePolicy operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException The request is missing required parameters or has invalid parameters.
      • InvalidPolicyRevisionIdException A policy revision id was provided which does not match the latest policy revision. This exception is also if a policy revision id of 0 is provided via PutResourcePolicy and a policy with the same name already exists.
      • ThrottledException The request exceeds the maximum number of requests per second.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteSamplingRule

      default CompletableFuture<DeleteSamplingRuleResponse> deleteSamplingRule(DeleteSamplingRuleRequest deleteSamplingRuleRequest)

      Deletes a sampling rule.

      Parameters:
      deleteSamplingRuleRequest -
      Returns:
      A Java Future containing the result of the DeleteSamplingRule operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException The request is missing required parameters or has invalid parameters.
      • ThrottledException The request exceeds the maximum number of requests per second.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deleteSamplingRule

      default CompletableFuture<DeleteSamplingRuleResponse> deleteSamplingRule(Consumer<DeleteSamplingRuleRequest.Builder> deleteSamplingRuleRequest)

      Deletes a sampling rule.


      This is a convenience which creates an instance of the DeleteSamplingRuleRequest.Builder avoiding the need to create one manually via DeleteSamplingRuleRequest.builder()

      Parameters:
      deleteSamplingRuleRequest - A Consumer that will call methods on DeleteSamplingRuleRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeleteSamplingRule operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException The request is missing required parameters or has invalid parameters.
      • ThrottledException The request exceeds the maximum number of requests per second.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getEncryptionConfig

      default CompletableFuture<GetEncryptionConfigResponse> getEncryptionConfig(GetEncryptionConfigRequest getEncryptionConfigRequest)

      Retrieves the current encryption configuration for X-Ray data.

      Parameters:
      getEncryptionConfigRequest -
      Returns:
      A Java Future containing the result of the GetEncryptionConfig operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException The request is missing required parameters or has invalid parameters.
      • ThrottledException The request exceeds the maximum number of requests per second.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getEncryptionConfig

      default CompletableFuture<GetEncryptionConfigResponse> getEncryptionConfig(Consumer<GetEncryptionConfigRequest.Builder> getEncryptionConfigRequest)

      Retrieves the current encryption configuration for X-Ray data.


      This is a convenience which creates an instance of the GetEncryptionConfigRequest.Builder avoiding the need to create one manually via GetEncryptionConfigRequest.builder()

      Parameters:
      getEncryptionConfigRequest - A Consumer that will call methods on GetEncryptionConfigRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetEncryptionConfig operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException The request is missing required parameters or has invalid parameters.
      • ThrottledException The request exceeds the maximum number of requests per second.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getEncryptionConfig

      default CompletableFuture<GetEncryptionConfigResponse> getEncryptionConfig()

      Retrieves the current encryption configuration for X-Ray data.

      Returns:
      A Java Future containing the result of the GetEncryptionConfig operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException The request is missing required parameters or has invalid parameters.
      • ThrottledException The request exceeds the maximum number of requests per second.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getGroup

      default CompletableFuture<GetGroupResponse> getGroup(GetGroupRequest getGroupRequest)

      Retrieves group resource details.

      Parameters:
      getGroupRequest -
      Returns:
      A Java Future containing the result of the GetGroup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException The request is missing required parameters or has invalid parameters.
      • ThrottledException The request exceeds the maximum number of requests per second.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getGroup

      default CompletableFuture<GetGroupResponse> getGroup(Consumer<GetGroupRequest.Builder> getGroupRequest)

      Retrieves group resource details.


      This is a convenience which creates an instance of the GetGroupRequest.Builder avoiding the need to create one manually via GetGroupRequest.builder()

      Parameters:
      getGroupRequest - A Consumer that will call methods on GetGroupRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetGroup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException The request is missing required parameters or has invalid parameters.
      • ThrottledException The request exceeds the maximum number of requests per second.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getGroups

      default CompletableFuture<GetGroupsResponse> getGroups(GetGroupsRequest getGroupsRequest)

      Retrieves all active group details.

      Parameters:
      getGroupsRequest -
      Returns:
      A Java Future containing the result of the GetGroups operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException The request is missing required parameters or has invalid parameters.
      • ThrottledException The request exceeds the maximum number of requests per second.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getGroups

      default CompletableFuture<GetGroupsResponse> getGroups(Consumer<GetGroupsRequest.Builder> getGroupsRequest)

      Retrieves all active group details.


      This is a convenience which creates an instance of the GetGroupsRequest.Builder avoiding the need to create one manually via GetGroupsRequest.builder()

      Parameters:
      getGroupsRequest - A Consumer that will call methods on GetGroupsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetGroups operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException The request is missing required parameters or has invalid parameters.
      • ThrottledException The request exceeds the maximum number of requests per second.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getGroups

      default CompletableFuture<GetGroupsResponse> getGroups()

      Retrieves all active group details.

      Returns:
      A Java Future containing the result of the GetGroups operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException The request is missing required parameters or has invalid parameters.
      • ThrottledException The request exceeds the maximum number of requests per second.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getGroupsPaginator

      default GetGroupsPublisher getGroupsPaginator()

      This is a variant of getGroups(software.amazon.awssdk.services.xray.model.GetGroupsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.xray.paginators.GetGroupsPublisher publisher = client.getGroupsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.xray.paginators.GetGroupsPublisher publisher = client.getGroupsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.xray.model.GetGroupsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.xray.model.GetGroupsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the getGroups(software.amazon.awssdk.services.xray.model.GetGroupsRequest) operation.

      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException The request is missing required parameters or has invalid parameters.
      • ThrottledException The request exceeds the maximum number of requests per second.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getGroupsPaginator

      default GetGroupsPublisher getGroupsPaginator(GetGroupsRequest getGroupsRequest)

      This is a variant of getGroups(software.amazon.awssdk.services.xray.model.GetGroupsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.xray.paginators.GetGroupsPublisher publisher = client.getGroupsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.xray.paginators.GetGroupsPublisher publisher = client.getGroupsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.xray.model.GetGroupsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.xray.model.GetGroupsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the getGroups(software.amazon.awssdk.services.xray.model.GetGroupsRequest) operation.

      Parameters:
      getGroupsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException The request is missing required parameters or has invalid parameters.
      • ThrottledException The request exceeds the maximum number of requests per second.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getGroupsPaginator

      default GetGroupsPublisher getGroupsPaginator(Consumer<GetGroupsRequest.Builder> getGroupsRequest)

      This is a variant of getGroups(software.amazon.awssdk.services.xray.model.GetGroupsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.xray.paginators.GetGroupsPublisher publisher = client.getGroupsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.xray.paginators.GetGroupsPublisher publisher = client.getGroupsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.xray.model.GetGroupsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.xray.model.GetGroupsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the getGroups(software.amazon.awssdk.services.xray.model.GetGroupsRequest) operation.


      This is a convenience which creates an instance of the GetGroupsRequest.Builder avoiding the need to create one manually via GetGroupsRequest.builder()

      Parameters:
      getGroupsRequest - A Consumer that will call methods on GetGroupsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException The request is missing required parameters or has invalid parameters.
      • ThrottledException The request exceeds the maximum number of requests per second.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getIndexingRules

      default CompletableFuture<GetIndexingRulesResponse> getIndexingRules(GetIndexingRulesRequest getIndexingRulesRequest)

      Retrieves all indexing rules.

      Indexing rules are used to determine the server-side sampling rate for spans ingested through the CloudWatchLogs destination and indexed by X-Ray. For more information, see Transaction Search.

      Parameters:
      getIndexingRulesRequest -
      Returns:
      A Java Future containing the result of the GetIndexingRules operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException The request is missing required parameters or has invalid parameters.
      • ThrottledException The request exceeds the maximum number of requests per second.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getIndexingRules

      default CompletableFuture<GetIndexingRulesResponse> getIndexingRules(Consumer<GetIndexingRulesRequest.Builder> getIndexingRulesRequest)

      Retrieves all indexing rules.

      Indexing rules are used to determine the server-side sampling rate for spans ingested through the CloudWatchLogs destination and indexed by X-Ray. For more information, see Transaction Search.


      This is a convenience which creates an instance of the GetIndexingRulesRequest.Builder avoiding the need to create one manually via GetIndexingRulesRequest.builder()

      Parameters:
      getIndexingRulesRequest - A Consumer that will call methods on GetIndexingRulesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetIndexingRules operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException The request is missing required parameters or has invalid parameters.
      • ThrottledException The request exceeds the maximum number of requests per second.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getInsight

      default CompletableFuture<GetInsightResponse> getInsight(GetInsightRequest getInsightRequest)

      Retrieves the summary information of an insight. This includes impact to clients and root cause services, the top anomalous services, the category, the state of the insight, and the start and end time of the insight.

      Parameters:
      getInsightRequest -
      Returns:
      A Java Future containing the result of the GetInsight operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException The request is missing required parameters or has invalid parameters.
      • ThrottledException The request exceeds the maximum number of requests per second.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getInsight

      default CompletableFuture<GetInsightResponse> getInsight(Consumer<GetInsightRequest.Builder> getInsightRequest)

      Retrieves the summary information of an insight. This includes impact to clients and root cause services, the top anomalous services, the category, the state of the insight, and the start and end time of the insight.


      This is a convenience which creates an instance of the GetInsightRequest.Builder avoiding the need to create one manually via GetInsightRequest.builder()

      Parameters:
      getInsightRequest - A Consumer that will call methods on GetInsightRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetInsight operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException The request is missing required parameters or has invalid parameters.
      • ThrottledException The request exceeds the maximum number of requests per second.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getInsightEvents

      default CompletableFuture<GetInsightEventsResponse> getInsightEvents(GetInsightEventsRequest getInsightEventsRequest)

      X-Ray reevaluates insights periodically until they're resolved, and records each intermediate state as an event. You can review an insight's events in the Impact Timeline on the Inspect page in the X-Ray console.

      Parameters:
      getInsightEventsRequest -
      Returns:
      A Java Future containing the result of the GetInsightEvents operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException The request is missing required parameters or has invalid parameters.
      • ThrottledException The request exceeds the maximum number of requests per second.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getInsightEvents

      default CompletableFuture<GetInsightEventsResponse> getInsightEvents(Consumer<GetInsightEventsRequest.Builder> getInsightEventsRequest)

      X-Ray reevaluates insights periodically until they're resolved, and records each intermediate state as an event. You can review an insight's events in the Impact Timeline on the Inspect page in the X-Ray console.


      This is a convenience which creates an instance of the GetInsightEventsRequest.Builder avoiding the need to create one manually via GetInsightEventsRequest.builder()

      Parameters:
      getInsightEventsRequest - A Consumer that will call methods on GetInsightEventsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetInsightEvents operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException The request is missing required parameters or has invalid parameters.
      • ThrottledException The request exceeds the maximum number of requests per second.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getInsightEventsPaginator

      default GetInsightEventsPublisher getInsightEventsPaginator(GetInsightEventsRequest getInsightEventsRequest)

      This is a variant of getInsightEvents(software.amazon.awssdk.services.xray.model.GetInsightEventsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.xray.paginators.GetInsightEventsPublisher publisher = client.getInsightEventsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.xray.paginators.GetInsightEventsPublisher publisher = client.getInsightEventsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.xray.model.GetInsightEventsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.xray.model.GetInsightEventsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the getInsightEvents(software.amazon.awssdk.services.xray.model.GetInsightEventsRequest) operation.

      Parameters:
      getInsightEventsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException The request is missing required parameters or has invalid parameters.
      • ThrottledException The request exceeds the maximum number of requests per second.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getInsightEventsPaginator

      default GetInsightEventsPublisher getInsightEventsPaginator(Consumer<GetInsightEventsRequest.Builder> getInsightEventsRequest)

      This is a variant of getInsightEvents(software.amazon.awssdk.services.xray.model.GetInsightEventsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.xray.paginators.GetInsightEventsPublisher publisher = client.getInsightEventsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.xray.paginators.GetInsightEventsPublisher publisher = client.getInsightEventsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.xray.model.GetInsightEventsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.xray.model.GetInsightEventsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the getInsightEvents(software.amazon.awssdk.services.xray.model.GetInsightEventsRequest) operation.


      This is a convenience which creates an instance of the GetInsightEventsRequest.Builder avoiding the need to create one manually via GetInsightEventsRequest.builder()

      Parameters:
      getInsightEventsRequest - A Consumer that will call methods on GetInsightEventsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException The request is missing required parameters or has invalid parameters.
      • ThrottledException The request exceeds the maximum number of requests per second.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getInsightImpactGraph

      default CompletableFuture<GetInsightImpactGraphResponse> getInsightImpactGraph(GetInsightImpactGraphRequest getInsightImpactGraphRequest)

      Retrieves a service graph structure filtered by the specified insight. The service graph is limited to only structural information. For a complete service graph, use this API with the GetServiceGraph API.

      Parameters:
      getInsightImpactGraphRequest -
      Returns:
      A Java Future containing the result of the GetInsightImpactGraph operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException The request is missing required parameters or has invalid parameters.
      • ThrottledException The request exceeds the maximum number of requests per second.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getInsightImpactGraph

      default CompletableFuture<GetInsightImpactGraphResponse> getInsightImpactGraph(Consumer<GetInsightImpactGraphRequest.Builder> getInsightImpactGraphRequest)

      Retrieves a service graph structure filtered by the specified insight. The service graph is limited to only structural information. For a complete service graph, use this API with the GetServiceGraph API.


      This is a convenience which creates an instance of the GetInsightImpactGraphRequest.Builder avoiding the need to create one manually via GetInsightImpactGraphRequest.builder()

      Parameters:
      getInsightImpactGraphRequest - A Consumer that will call methods on GetInsightImpactGraphRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetInsightImpactGraph operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException The request is missing required parameters or has invalid parameters.
      • ThrottledException The request exceeds the maximum number of requests per second.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getInsightSummaries

      default CompletableFuture<GetInsightSummariesResponse> getInsightSummaries(GetInsightSummariesRequest getInsightSummariesRequest)

      Retrieves the summaries of all insights in the specified group matching the provided filter values.

      Parameters:
      getInsightSummariesRequest -
      Returns:
      A Java Future containing the result of the GetInsightSummaries operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException The request is missing required parameters or has invalid parameters.
      • ThrottledException The request exceeds the maximum number of requests per second.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getInsightSummaries

      default CompletableFuture<GetInsightSummariesResponse> getInsightSummaries(Consumer<GetInsightSummariesRequest.Builder> getInsightSummariesRequest)

      Retrieves the summaries of all insights in the specified group matching the provided filter values.


      This is a convenience which creates an instance of the GetInsightSummariesRequest.Builder avoiding the need to create one manually via GetInsightSummariesRequest.builder()

      Parameters:
      getInsightSummariesRequest - A Consumer that will call methods on GetInsightSummariesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetInsightSummaries operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException The request is missing required parameters or has invalid parameters.
      • ThrottledException The request exceeds the maximum number of requests per second.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getInsightSummariesPaginator

      default GetInsightSummariesPublisher getInsightSummariesPaginator(GetInsightSummariesRequest getInsightSummariesRequest)

      This is a variant of getInsightSummaries(software.amazon.awssdk.services.xray.model.GetInsightSummariesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.xray.paginators.GetInsightSummariesPublisher publisher = client.getInsightSummariesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.xray.paginators.GetInsightSummariesPublisher publisher = client.getInsightSummariesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.xray.model.GetInsightSummariesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.xray.model.GetInsightSummariesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the getInsightSummaries(software.amazon.awssdk.services.xray.model.GetInsightSummariesRequest) operation.

      Parameters:
      getInsightSummariesRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException The request is missing required parameters or has invalid parameters.
      • ThrottledException The request exceeds the maximum number of requests per second.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getInsightSummariesPaginator

      default GetInsightSummariesPublisher getInsightSummariesPaginator(Consumer<GetInsightSummariesRequest.Builder> getInsightSummariesRequest)

      This is a variant of getInsightSummaries(software.amazon.awssdk.services.xray.model.GetInsightSummariesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.xray.paginators.GetInsightSummariesPublisher publisher = client.getInsightSummariesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.xray.paginators.GetInsightSummariesPublisher publisher = client.getInsightSummariesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.xray.model.GetInsightSummariesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.xray.model.GetInsightSummariesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the getInsightSummaries(software.amazon.awssdk.services.xray.model.GetInsightSummariesRequest) operation.


      This is a convenience which creates an instance of the GetInsightSummariesRequest.Builder avoiding the need to create one manually via GetInsightSummariesRequest.builder()

      Parameters:
      getInsightSummariesRequest - A Consumer that will call methods on GetInsightSummariesRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException The request is missing required parameters or has invalid parameters.
      • ThrottledException The request exceeds the maximum number of requests per second.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getRetrievedTracesGraph

      default CompletableFuture<GetRetrievedTracesGraphResponse> getRetrievedTracesGraph(GetRetrievedTracesGraphRequest getRetrievedTracesGraphRequest)

      Retrieves a service graph for traces based on the specified RetrievalToken from the CloudWatch log group generated by Transaction Search. This API does not initiate a retrieval job. You must first execute StartTraceRetrieval to obtain the required RetrievalToken.

      The trace graph describes services that process incoming requests and any downstream services they call, which may include Amazon Web Services resources, external APIs, or databases.

      The response is empty until the RetrievalStatus is COMPLETE. Retry the request after the status changes from RUNNING or SCHEDULED to COMPLETE to access the full service graph.

      When CloudWatch log is the destination, this API can support cross-account observability and service graph retrieval across linked accounts.

      For retrieving graphs from X-Ray directly as opposed to the Transaction-Search Log group, see GetTraceGraph.

      Parameters:
      getRetrievedTracesGraphRequest -
      Returns:
      A Java Future containing the result of the GetRetrievedTracesGraph operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException The request is missing required parameters or has invalid parameters.
      • ThrottledException The request exceeds the maximum number of requests per second.
      • ResourceNotFoundException The resource was not found. Verify that the name or Amazon Resource Name (ARN) of the resource is correct.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getRetrievedTracesGraph

      default CompletableFuture<GetRetrievedTracesGraphResponse> getRetrievedTracesGraph(Consumer<GetRetrievedTracesGraphRequest.Builder> getRetrievedTracesGraphRequest)

      Retrieves a service graph for traces based on the specified RetrievalToken from the CloudWatch log group generated by Transaction Search. This API does not initiate a retrieval job. You must first execute StartTraceRetrieval to obtain the required RetrievalToken.

      The trace graph describes services that process incoming requests and any downstream services they call, which may include Amazon Web Services resources, external APIs, or databases.

      The response is empty until the RetrievalStatus is COMPLETE. Retry the request after the status changes from RUNNING or SCHEDULED to COMPLETE to access the full service graph.

      When CloudWatch log is the destination, this API can support cross-account observability and service graph retrieval across linked accounts.

      For retrieving graphs from X-Ray directly as opposed to the Transaction-Search Log group, see GetTraceGraph.


      This is a convenience which creates an instance of the GetRetrievedTracesGraphRequest.Builder avoiding the need to create one manually via GetRetrievedTracesGraphRequest.builder()

      Parameters:
      getRetrievedTracesGraphRequest - A Consumer that will call methods on GetRetrievedTracesGraphRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetRetrievedTracesGraph operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException The request is missing required parameters or has invalid parameters.
      • ThrottledException The request exceeds the maximum number of requests per second.
      • ResourceNotFoundException The resource was not found. Verify that the name or Amazon Resource Name (ARN) of the resource is correct.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getSamplingRules

      default CompletableFuture<GetSamplingRulesResponse> getSamplingRules(GetSamplingRulesRequest getSamplingRulesRequest)

      Retrieves all sampling rules.

      Parameters:
      getSamplingRulesRequest -
      Returns:
      A Java Future containing the result of the GetSamplingRules operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException The request is missing required parameters or has invalid parameters.
      • ThrottledException The request exceeds the maximum number of requests per second.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getSamplingRules

      default CompletableFuture<GetSamplingRulesResponse> getSamplingRules(Consumer<GetSamplingRulesRequest.Builder> getSamplingRulesRequest)

      Retrieves all sampling rules.


      This is a convenience which creates an instance of the GetSamplingRulesRequest.Builder avoiding the need to create one manually via GetSamplingRulesRequest.builder()

      Parameters:
      getSamplingRulesRequest - A Consumer that will call methods on GetSamplingRulesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetSamplingRules operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException The request is missing required parameters or has invalid parameters.
      • ThrottledException The request exceeds the maximum number of requests per second.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getSamplingRules

      default CompletableFuture<GetSamplingRulesResponse> getSamplingRules()

      Retrieves all sampling rules.

      Returns:
      A Java Future containing the result of the GetSamplingRules operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException The request is missing required parameters or has invalid parameters.
      • ThrottledException The request exceeds the maximum number of requests per second.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getSamplingRulesPaginator

      default GetSamplingRulesPublisher getSamplingRulesPaginator()

      This is a variant of getSamplingRules(software.amazon.awssdk.services.xray.model.GetSamplingRulesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.xray.paginators.GetSamplingRulesPublisher publisher = client.getSamplingRulesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.xray.paginators.GetSamplingRulesPublisher publisher = client.getSamplingRulesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.xray.model.GetSamplingRulesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.xray.model.GetSamplingRulesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the getSamplingRules(software.amazon.awssdk.services.xray.model.GetSamplingRulesRequest) operation.

      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException The request is missing required parameters or has invalid parameters.
      • ThrottledException The request exceeds the maximum number of requests per second.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getSamplingRulesPaginator

      default GetSamplingRulesPublisher getSamplingRulesPaginator(GetSamplingRulesRequest getSamplingRulesRequest)

      This is a variant of getSamplingRules(software.amazon.awssdk.services.xray.model.GetSamplingRulesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.xray.paginators.GetSamplingRulesPublisher publisher = client.getSamplingRulesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.xray.paginators.GetSamplingRulesPublisher publisher = client.getSamplingRulesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.xray.model.GetSamplingRulesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.xray.model.GetSamplingRulesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the getSamplingRules(software.amazon.awssdk.services.xray.model.GetSamplingRulesRequest) operation.

      Parameters:
      getSamplingRulesRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException The request is missing required parameters or has invalid parameters.
      • ThrottledException The request exceeds the maximum number of requests per second.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getSamplingRulesPaginator

      default GetSamplingRulesPublisher getSamplingRulesPaginator(Consumer<GetSamplingRulesRequest.Builder> getSamplingRulesRequest)

      This is a variant of getSamplingRules(software.amazon.awssdk.services.xray.model.GetSamplingRulesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.xray.paginators.GetSamplingRulesPublisher publisher = client.getSamplingRulesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.xray.paginators.GetSamplingRulesPublisher publisher = client.getSamplingRulesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.xray.model.GetSamplingRulesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.xray.model.GetSamplingRulesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the getSamplingRules(software.amazon.awssdk.services.xray.model.GetSamplingRulesRequest) operation.


      This is a convenience which creates an instance of the GetSamplingRulesRequest.Builder avoiding the need to create one manually via GetSamplingRulesRequest.builder()

      Parameters:
      getSamplingRulesRequest - A Consumer that will call methods on GetSamplingRulesRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException The request is missing required parameters or has invalid parameters.
      • ThrottledException The request exceeds the maximum number of requests per second.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getSamplingStatisticSummaries

      default CompletableFuture<GetSamplingStatisticSummariesResponse> getSamplingStatisticSummaries(GetSamplingStatisticSummariesRequest getSamplingStatisticSummariesRequest)

      Retrieves information about recent sampling results for all sampling rules.

      Parameters:
      getSamplingStatisticSummariesRequest -
      Returns:
      A Java Future containing the result of the GetSamplingStatisticSummaries operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException The request is missing required parameters or has invalid parameters.
      • ThrottledException The request exceeds the maximum number of requests per second.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getSamplingStatisticSummaries

      default CompletableFuture<GetSamplingStatisticSummariesResponse> getSamplingStatisticSummaries(Consumer<GetSamplingStatisticSummariesRequest.Builder> getSamplingStatisticSummariesRequest)

      Retrieves information about recent sampling results for all sampling rules.


      This is a convenience which creates an instance of the GetSamplingStatisticSummariesRequest.Builder avoiding the need to create one manually via GetSamplingStatisticSummariesRequest.builder()

      Parameters:
      getSamplingStatisticSummariesRequest - A Consumer that will call methods on GetSamplingStatisticSummariesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetSamplingStatisticSummaries operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException The request is missing required parameters or has invalid parameters.
      • ThrottledException The request exceeds the maximum number of requests per second.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getSamplingStatisticSummaries

      default CompletableFuture<GetSamplingStatisticSummariesResponse> getSamplingStatisticSummaries()

      Retrieves information about recent sampling results for all sampling rules.

      Returns:
      A Java Future containing the result of the GetSamplingStatisticSummaries operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException The request is missing required parameters or has invalid parameters.
      • ThrottledException The request exceeds the maximum number of requests per second.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getSamplingStatisticSummariesPaginator

      default GetSamplingStatisticSummariesPublisher getSamplingStatisticSummariesPaginator()

      This is a variant of getSamplingStatisticSummaries(software.amazon.awssdk.services.xray.model.GetSamplingStatisticSummariesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.xray.paginators.GetSamplingStatisticSummariesPublisher publisher = client.getSamplingStatisticSummariesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.xray.paginators.GetSamplingStatisticSummariesPublisher publisher = client.getSamplingStatisticSummariesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.xray.model.GetSamplingStatisticSummariesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.xray.model.GetSamplingStatisticSummariesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the getSamplingStatisticSummaries(software.amazon.awssdk.services.xray.model.GetSamplingStatisticSummariesRequest) operation.

      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException The request is missing required parameters or has invalid parameters.
      • ThrottledException The request exceeds the maximum number of requests per second.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getSamplingStatisticSummariesPaginator

      default GetSamplingStatisticSummariesPublisher getSamplingStatisticSummariesPaginator(GetSamplingStatisticSummariesRequest getSamplingStatisticSummariesRequest)

      This is a variant of getSamplingStatisticSummaries(software.amazon.awssdk.services.xray.model.GetSamplingStatisticSummariesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.xray.paginators.GetSamplingStatisticSummariesPublisher publisher = client.getSamplingStatisticSummariesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.xray.paginators.GetSamplingStatisticSummariesPublisher publisher = client.getSamplingStatisticSummariesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.xray.model.GetSamplingStatisticSummariesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.xray.model.GetSamplingStatisticSummariesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the getSamplingStatisticSummaries(software.amazon.awssdk.services.xray.model.GetSamplingStatisticSummariesRequest) operation.

      Parameters:
      getSamplingStatisticSummariesRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException The request is missing required parameters or has invalid parameters.
      • ThrottledException The request exceeds the maximum number of requests per second.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getSamplingStatisticSummariesPaginator

      default GetSamplingStatisticSummariesPublisher getSamplingStatisticSummariesPaginator(Consumer<GetSamplingStatisticSummariesRequest.Builder> getSamplingStatisticSummariesRequest)

      This is a variant of getSamplingStatisticSummaries(software.amazon.awssdk.services.xray.model.GetSamplingStatisticSummariesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.xray.paginators.GetSamplingStatisticSummariesPublisher publisher = client.getSamplingStatisticSummariesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.xray.paginators.GetSamplingStatisticSummariesPublisher publisher = client.getSamplingStatisticSummariesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.xray.model.GetSamplingStatisticSummariesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.xray.model.GetSamplingStatisticSummariesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the getSamplingStatisticSummaries(software.amazon.awssdk.services.xray.model.GetSamplingStatisticSummariesRequest) operation.


      This is a convenience which creates an instance of the GetSamplingStatisticSummariesRequest.Builder avoiding the need to create one manually via GetSamplingStatisticSummariesRequest.builder()

      Parameters:
      getSamplingStatisticSummariesRequest - A Consumer that will call methods on GetSamplingStatisticSummariesRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException The request is missing required parameters or has invalid parameters.
      • ThrottledException The request exceeds the maximum number of requests per second.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getSamplingTargets

      default CompletableFuture<GetSamplingTargetsResponse> getSamplingTargets(GetSamplingTargetsRequest getSamplingTargetsRequest)

      Requests a sampling quota for rules that the service is using to sample requests.

      Parameters:
      getSamplingTargetsRequest -
      Returns:
      A Java Future containing the result of the GetSamplingTargets operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException The request is missing required parameters or has invalid parameters.
      • ThrottledException The request exceeds the maximum number of requests per second.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getSamplingTargets

      default CompletableFuture<GetSamplingTargetsResponse> getSamplingTargets(Consumer<GetSamplingTargetsRequest.Builder> getSamplingTargetsRequest)

      Requests a sampling quota for rules that the service is using to sample requests.


      This is a convenience which creates an instance of the GetSamplingTargetsRequest.Builder avoiding the need to create one manually via GetSamplingTargetsRequest.builder()

      Parameters:
      getSamplingTargetsRequest - A Consumer that will call methods on GetSamplingTargetsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetSamplingTargets operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException The request is missing required parameters or has invalid parameters.
      • ThrottledException The request exceeds the maximum number of requests per second.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getServiceGraph

      default CompletableFuture<GetServiceGraphResponse> getServiceGraph(GetServiceGraphRequest getServiceGraphRequest)

      Retrieves a document that describes services that process incoming requests, and downstream services that they call as a result. Root services process incoming requests and make calls to downstream services. Root services are applications that use the Amazon Web Services X-Ray SDK. Downstream services can be other applications, Amazon Web Services resources, HTTP web APIs, or SQL databases.

      Parameters:
      getServiceGraphRequest -
      Returns:
      A Java Future containing the result of the GetServiceGraph operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException The request is missing required parameters or has invalid parameters.
      • ThrottledException The request exceeds the maximum number of requests per second.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getServiceGraph

      default CompletableFuture<GetServiceGraphResponse> getServiceGraph(Consumer<GetServiceGraphRequest.Builder> getServiceGraphRequest)

      Retrieves a document that describes services that process incoming requests, and downstream services that they call as a result. Root services process incoming requests and make calls to downstream services. Root services are applications that use the Amazon Web Services X-Ray SDK. Downstream services can be other applications, Amazon Web Services resources, HTTP web APIs, or SQL databases.


      This is a convenience which creates an instance of the GetServiceGraphRequest.Builder avoiding the need to create one manually via GetServiceGraphRequest.builder()

      Parameters:
      getServiceGraphRequest - A Consumer that will call methods on GetServiceGraphRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetServiceGraph operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException The request is missing required parameters or has invalid parameters.
      • ThrottledException The request exceeds the maximum number of requests per second.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getServiceGraphPaginator

      default GetServiceGraphPublisher getServiceGraphPaginator(GetServiceGraphRequest getServiceGraphRequest)

      This is a variant of getServiceGraph(software.amazon.awssdk.services.xray.model.GetServiceGraphRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.xray.paginators.GetServiceGraphPublisher publisher = client.getServiceGraphPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.xray.paginators.GetServiceGraphPublisher publisher = client.getServiceGraphPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.xray.model.GetServiceGraphResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.xray.model.GetServiceGraphResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the getServiceGraph(software.amazon.awssdk.services.xray.model.GetServiceGraphRequest) operation.

      Parameters:
      getServiceGraphRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException The request is missing required parameters or has invalid parameters.
      • ThrottledException The request exceeds the maximum number of requests per second.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getServiceGraphPaginator

      default GetServiceGraphPublisher getServiceGraphPaginator(Consumer<GetServiceGraphRequest.Builder> getServiceGraphRequest)

      This is a variant of getServiceGraph(software.amazon.awssdk.services.xray.model.GetServiceGraphRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.xray.paginators.GetServiceGraphPublisher publisher = client.getServiceGraphPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.xray.paginators.GetServiceGraphPublisher publisher = client.getServiceGraphPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.xray.model.GetServiceGraphResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.xray.model.GetServiceGraphResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the getServiceGraph(software.amazon.awssdk.services.xray.model.GetServiceGraphRequest) operation.


      This is a convenience which creates an instance of the GetServiceGraphRequest.Builder avoiding the need to create one manually via GetServiceGraphRequest.builder()

      Parameters:
      getServiceGraphRequest - A Consumer that will call methods on GetServiceGraphRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException The request is missing required parameters or has invalid parameters.
      • ThrottledException The request exceeds the maximum number of requests per second.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getTimeSeriesServiceStatistics

      default CompletableFuture<GetTimeSeriesServiceStatisticsResponse> getTimeSeriesServiceStatistics(GetTimeSeriesServiceStatisticsRequest getTimeSeriesServiceStatisticsRequest)

      Get an aggregation of service statistics defined by a specific time range.

      Parameters:
      getTimeSeriesServiceStatisticsRequest -
      Returns:
      A Java Future containing the result of the GetTimeSeriesServiceStatistics operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException The request is missing required parameters or has invalid parameters.
      • ThrottledException The request exceeds the maximum number of requests per second.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getTimeSeriesServiceStatistics

      default CompletableFuture<GetTimeSeriesServiceStatisticsResponse> getTimeSeriesServiceStatistics(Consumer<GetTimeSeriesServiceStatisticsRequest.Builder> getTimeSeriesServiceStatisticsRequest)

      Get an aggregation of service statistics defined by a specific time range.


      This is a convenience which creates an instance of the GetTimeSeriesServiceStatisticsRequest.Builder avoiding the need to create one manually via GetTimeSeriesServiceStatisticsRequest.builder()

      Parameters:
      getTimeSeriesServiceStatisticsRequest - A Consumer that will call methods on GetTimeSeriesServiceStatisticsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetTimeSeriesServiceStatistics operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException The request is missing required parameters or has invalid parameters.
      • ThrottledException The request exceeds the maximum number of requests per second.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getTimeSeriesServiceStatisticsPaginator

      default GetTimeSeriesServiceStatisticsPublisher getTimeSeriesServiceStatisticsPaginator(GetTimeSeriesServiceStatisticsRequest getTimeSeriesServiceStatisticsRequest)

      This is a variant of getTimeSeriesServiceStatistics(software.amazon.awssdk.services.xray.model.GetTimeSeriesServiceStatisticsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.xray.paginators.GetTimeSeriesServiceStatisticsPublisher publisher = client.getTimeSeriesServiceStatisticsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.xray.paginators.GetTimeSeriesServiceStatisticsPublisher publisher = client.getTimeSeriesServiceStatisticsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.xray.model.GetTimeSeriesServiceStatisticsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.xray.model.GetTimeSeriesServiceStatisticsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the getTimeSeriesServiceStatistics(software.amazon.awssdk.services.xray.model.GetTimeSeriesServiceStatisticsRequest) operation.

      Parameters:
      getTimeSeriesServiceStatisticsRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException The request is missing required parameters or has invalid parameters.
      • ThrottledException The request exceeds the maximum number of requests per second.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getTimeSeriesServiceStatisticsPaginator

      default GetTimeSeriesServiceStatisticsPublisher getTimeSeriesServiceStatisticsPaginator(Consumer<GetTimeSeriesServiceStatisticsRequest.Builder> getTimeSeriesServiceStatisticsRequest)

      This is a variant of getTimeSeriesServiceStatistics(software.amazon.awssdk.services.xray.model.GetTimeSeriesServiceStatisticsRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.xray.paginators.GetTimeSeriesServiceStatisticsPublisher publisher = client.getTimeSeriesServiceStatisticsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.xray.paginators.GetTimeSeriesServiceStatisticsPublisher publisher = client.getTimeSeriesServiceStatisticsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.xray.model.GetTimeSeriesServiceStatisticsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.xray.model.GetTimeSeriesServiceStatisticsResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the getTimeSeriesServiceStatistics(software.amazon.awssdk.services.xray.model.GetTimeSeriesServiceStatisticsRequest) operation.


      This is a convenience which creates an instance of the GetTimeSeriesServiceStatisticsRequest.Builder avoiding the need to create one manually via GetTimeSeriesServiceStatisticsRequest.builder()

      Parameters:
      getTimeSeriesServiceStatisticsRequest - A Consumer that will call methods on GetTimeSeriesServiceStatisticsRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException The request is missing required parameters or has invalid parameters.
      • ThrottledException The request exceeds the maximum number of requests per second.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getTraceGraph

      default CompletableFuture<GetTraceGraphResponse> getTraceGraph(GetTraceGraphRequest getTraceGraphRequest)

      Retrieves a service graph for one or more specific trace IDs.

      Parameters:
      getTraceGraphRequest -
      Returns:
      A Java Future containing the result of the GetTraceGraph operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException The request is missing required parameters or has invalid parameters.
      • ThrottledException The request exceeds the maximum number of requests per second.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getTraceGraph

      default CompletableFuture<GetTraceGraphResponse> getTraceGraph(Consumer<GetTraceGraphRequest.Builder> getTraceGraphRequest)

      Retrieves a service graph for one or more specific trace IDs.


      This is a convenience which creates an instance of the GetTraceGraphRequest.Builder avoiding the need to create one manually via GetTraceGraphRequest.builder()

      Parameters:
      getTraceGraphRequest - A Consumer that will call methods on GetTraceGraphRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetTraceGraph operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException The request is missing required parameters or has invalid parameters.
      • ThrottledException The request exceeds the maximum number of requests per second.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getTraceGraphPaginator

      default GetTraceGraphPublisher getTraceGraphPaginator(GetTraceGraphRequest getTraceGraphRequest)

      This is a variant of getTraceGraph(software.amazon.awssdk.services.xray.model.GetTraceGraphRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.xray.paginators.GetTraceGraphPublisher publisher = client.getTraceGraphPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.xray.paginators.GetTraceGraphPublisher publisher = client.getTraceGraphPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.xray.model.GetTraceGraphResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.xray.model.GetTraceGraphResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the getTraceGraph(software.amazon.awssdk.services.xray.model.GetTraceGraphRequest) operation.

      Parameters:
      getTraceGraphRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException The request is missing required parameters or has invalid parameters.
      • ThrottledException The request exceeds the maximum number of requests per second.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getTraceGraphPaginator

      default GetTraceGraphPublisher getTraceGraphPaginator(Consumer<GetTraceGraphRequest.Builder> getTraceGraphRequest)

      This is a variant of getTraceGraph(software.amazon.awssdk.services.xray.model.GetTraceGraphRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.xray.paginators.GetTraceGraphPublisher publisher = client.getTraceGraphPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.xray.paginators.GetTraceGraphPublisher publisher = client.getTraceGraphPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.xray.model.GetTraceGraphResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.xray.model.GetTraceGraphResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the getTraceGraph(software.amazon.awssdk.services.xray.model.GetTraceGraphRequest) operation.


      This is a convenience which creates an instance of the GetTraceGraphRequest.Builder avoiding the need to create one manually via GetTraceGraphRequest.builder()

      Parameters:
      getTraceGraphRequest - A Consumer that will call methods on GetTraceGraphRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException The request is missing required parameters or has invalid parameters.
      • ThrottledException The request exceeds the maximum number of requests per second.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getTraceSegmentDestination

      default CompletableFuture<GetTraceSegmentDestinationResponse> getTraceSegmentDestination(GetTraceSegmentDestinationRequest getTraceSegmentDestinationRequest)

      Retrieves the current destination of data sent to PutTraceSegments and OpenTelemetry protocol (OTLP) endpoint. The Transaction Search feature requires a CloudWatchLogs destination. For more information, see Transaction Search and OpenTelemetry.

      Parameters:
      getTraceSegmentDestinationRequest -
      Returns:
      A Java Future containing the result of the GetTraceSegmentDestination operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException The request is missing required parameters or has invalid parameters.
      • ThrottledException The request exceeds the maximum number of requests per second.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getTraceSegmentDestination

      default CompletableFuture<GetTraceSegmentDestinationResponse> getTraceSegmentDestination(Consumer<GetTraceSegmentDestinationRequest.Builder> getTraceSegmentDestinationRequest)

      Retrieves the current destination of data sent to PutTraceSegments and OpenTelemetry protocol (OTLP) endpoint. The Transaction Search feature requires a CloudWatchLogs destination. For more information, see Transaction Search and OpenTelemetry.


      This is a convenience which creates an instance of the GetTraceSegmentDestinationRequest.Builder avoiding the need to create one manually via GetTraceSegmentDestinationRequest.builder()

      Parameters:
      getTraceSegmentDestinationRequest - A Consumer that will call methods on GetTraceSegmentDestinationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetTraceSegmentDestination operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException The request is missing required parameters or has invalid parameters.
      • ThrottledException The request exceeds the maximum number of requests per second.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getTraceSummaries

      default CompletableFuture<GetTraceSummariesResponse> getTraceSummaries(GetTraceSummariesRequest getTraceSummariesRequest)

      Retrieves IDs and annotations for traces available for a specified time frame using an optional filter. To get the full traces, pass the trace IDs to BatchGetTraces.

      A filter expression can target traced requests that hit specific service nodes or edges, have errors, or come from a known user. For example, the following filter expression targets traces that pass through api.example.com:

      service("api.example.com")

      This filter expression finds traces that have an annotation named account with the value 12345:

      annotation.account = "12345"

      For a full list of indexed fields and keywords that you can use in filter expressions, see Use filter expressions in the Amazon Web Services X-Ray Developer Guide.

      Parameters:
      getTraceSummariesRequest -
      Returns:
      A Java Future containing the result of the GetTraceSummaries operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException The request is missing required parameters or has invalid parameters.
      • ThrottledException The request exceeds the maximum number of requests per second.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getTraceSummaries

      default CompletableFuture<GetTraceSummariesResponse> getTraceSummaries(Consumer<GetTraceSummariesRequest.Builder> getTraceSummariesRequest)

      Retrieves IDs and annotations for traces available for a specified time frame using an optional filter. To get the full traces, pass the trace IDs to BatchGetTraces.

      A filter expression can target traced requests that hit specific service nodes or edges, have errors, or come from a known user. For example, the following filter expression targets traces that pass through api.example.com:

      service("api.example.com")

      This filter expression finds traces that have an annotation named account with the value 12345:

      annotation.account = "12345"

      For a full list of indexed fields and keywords that you can use in filter expressions, see Use filter expressions in the Amazon Web Services X-Ray Developer Guide.


      This is a convenience which creates an instance of the GetTraceSummariesRequest.Builder avoiding the need to create one manually via GetTraceSummariesRequest.builder()

      Parameters:
      getTraceSummariesRequest - A Consumer that will call methods on GetTraceSummariesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetTraceSummaries operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException The request is missing required parameters or has invalid parameters.
      • ThrottledException The request exceeds the maximum number of requests per second.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getTraceSummariesPaginator

      default GetTraceSummariesPublisher getTraceSummariesPaginator(GetTraceSummariesRequest getTraceSummariesRequest)

      This is a variant of getTraceSummaries(software.amazon.awssdk.services.xray.model.GetTraceSummariesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.xray.paginators.GetTraceSummariesPublisher publisher = client.getTraceSummariesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.xray.paginators.GetTraceSummariesPublisher publisher = client.getTraceSummariesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.xray.model.GetTraceSummariesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.xray.model.GetTraceSummariesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the getTraceSummaries(software.amazon.awssdk.services.xray.model.GetTraceSummariesRequest) operation.

      Parameters:
      getTraceSummariesRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException The request is missing required parameters or has invalid parameters.
      • ThrottledException The request exceeds the maximum number of requests per second.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getTraceSummariesPaginator

      default GetTraceSummariesPublisher getTraceSummariesPaginator(Consumer<GetTraceSummariesRequest.Builder> getTraceSummariesRequest)

      This is a variant of getTraceSummaries(software.amazon.awssdk.services.xray.model.GetTraceSummariesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.xray.paginators.GetTraceSummariesPublisher publisher = client.getTraceSummariesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.xray.paginators.GetTraceSummariesPublisher publisher = client.getTraceSummariesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.xray.model.GetTraceSummariesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.xray.model.GetTraceSummariesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the getTraceSummaries(software.amazon.awssdk.services.xray.model.GetTraceSummariesRequest) operation.


      This is a convenience which creates an instance of the GetTraceSummariesRequest.Builder avoiding the need to create one manually via GetTraceSummariesRequest.builder()

      Parameters:
      getTraceSummariesRequest - A Consumer that will call methods on GetTraceSummariesRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException The request is missing required parameters or has invalid parameters.
      • ThrottledException The request exceeds the maximum number of requests per second.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listResourcePolicies

      default CompletableFuture<ListResourcePoliciesResponse> listResourcePolicies(ListResourcePoliciesRequest listResourcePoliciesRequest)

      Returns the list of resource policies in the target Amazon Web Services account.

      Parameters:
      listResourcePoliciesRequest -
      Returns:
      A Java Future containing the result of the ListResourcePolicies operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException The request is missing required parameters or has invalid parameters.
      • ThrottledException The request exceeds the maximum number of requests per second.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listResourcePolicies

      default CompletableFuture<ListResourcePoliciesResponse> listResourcePolicies(Consumer<ListResourcePoliciesRequest.Builder> listResourcePoliciesRequest)

      Returns the list of resource policies in the target Amazon Web Services account.


      This is a convenience which creates an instance of the ListResourcePoliciesRequest.Builder avoiding the need to create one manually via ListResourcePoliciesRequest.builder()

      Parameters:
      listResourcePoliciesRequest - A Consumer that will call methods on ListResourcePoliciesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListResourcePolicies operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException The request is missing required parameters or has invalid parameters.
      • ThrottledException The request exceeds the maximum number of requests per second.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listResourcePoliciesPaginator

      default ListResourcePoliciesPublisher listResourcePoliciesPaginator(ListResourcePoliciesRequest listResourcePoliciesRequest)

      This is a variant of listResourcePolicies(software.amazon.awssdk.services.xray.model.ListResourcePoliciesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.xray.paginators.ListResourcePoliciesPublisher publisher = client.listResourcePoliciesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.xray.paginators.ListResourcePoliciesPublisher publisher = client.listResourcePoliciesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.xray.model.ListResourcePoliciesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.xray.model.ListResourcePoliciesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listResourcePolicies(software.amazon.awssdk.services.xray.model.ListResourcePoliciesRequest) operation.

      Parameters:
      listResourcePoliciesRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException The request is missing required parameters or has invalid parameters.
      • ThrottledException The request exceeds the maximum number of requests per second.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listResourcePoliciesPaginator

      default ListResourcePoliciesPublisher listResourcePoliciesPaginator(Consumer<ListResourcePoliciesRequest.Builder> listResourcePoliciesRequest)

      This is a variant of listResourcePolicies(software.amazon.awssdk.services.xray.model.ListResourcePoliciesRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.xray.paginators.ListResourcePoliciesPublisher publisher = client.listResourcePoliciesPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.xray.paginators.ListResourcePoliciesPublisher publisher = client.listResourcePoliciesPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.xray.model.ListResourcePoliciesResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.xray.model.ListResourcePoliciesResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listResourcePolicies(software.amazon.awssdk.services.xray.model.ListResourcePoliciesRequest) operation.


      This is a convenience which creates an instance of the ListResourcePoliciesRequest.Builder avoiding the need to create one manually via ListResourcePoliciesRequest.builder()

      Parameters:
      listResourcePoliciesRequest - A Consumer that will call methods on ListResourcePoliciesRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException The request is missing required parameters or has invalid parameters.
      • ThrottledException The request exceeds the maximum number of requests per second.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listRetrievedTraces

      default CompletableFuture<ListRetrievedTracesResponse> listRetrievedTraces(ListRetrievedTracesRequest listRetrievedTracesRequest)

      Retrieves a list of traces for a given RetrievalToken from the CloudWatch log group generated by Transaction Search. For information on what each trace returns, see BatchGetTraces.

      This API does not initiate a retrieval process. To start a trace retrieval, use StartTraceRetrieval, which generates the required RetrievalToken.

      When the RetrievalStatus is not COMPLETE, the API will return an empty response. Retry the request once the retrieval has completed to access the full list of traces.

      For cross-account observability, this API can retrieve traces from linked accounts when CloudWatch log is set as the destination across relevant accounts. For more details, see CloudWatch cross-account observability.

      For retrieving data from X-Ray directly as opposed to the Transaction Search generated log group, see BatchGetTraces.

      Parameters:
      listRetrievedTracesRequest -
      Returns:
      A Java Future containing the result of the ListRetrievedTraces operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException The request is missing required parameters or has invalid parameters.
      • ThrottledException The request exceeds the maximum number of requests per second.
      • ResourceNotFoundException The resource was not found. Verify that the name or Amazon Resource Name (ARN) of the resource is correct.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listRetrievedTraces

      default CompletableFuture<ListRetrievedTracesResponse> listRetrievedTraces(Consumer<ListRetrievedTracesRequest.Builder> listRetrievedTracesRequest)

      Retrieves a list of traces for a given RetrievalToken from the CloudWatch log group generated by Transaction Search. For information on what each trace returns, see BatchGetTraces.

      This API does not initiate a retrieval process. To start a trace retrieval, use StartTraceRetrieval, which generates the required RetrievalToken.

      When the RetrievalStatus is not COMPLETE, the API will return an empty response. Retry the request once the retrieval has completed to access the full list of traces.

      For cross-account observability, this API can retrieve traces from linked accounts when CloudWatch log is set as the destination across relevant accounts. For more details, see CloudWatch cross-account observability.

      For retrieving data from X-Ray directly as opposed to the Transaction Search generated log group, see BatchGetTraces.


      This is a convenience which creates an instance of the ListRetrievedTracesRequest.Builder avoiding the need to create one manually via ListRetrievedTracesRequest.builder()

      Parameters:
      listRetrievedTracesRequest - A Consumer that will call methods on ListRetrievedTracesRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListRetrievedTraces operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException The request is missing required parameters or has invalid parameters.
      • ThrottledException The request exceeds the maximum number of requests per second.
      • ResourceNotFoundException The resource was not found. Verify that the name or Amazon Resource Name (ARN) of the resource is correct.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTagsForResource

      default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

      Returns a list of tags that are applied to the specified Amazon Web Services X-Ray group or sampling rule.

      Parameters:
      listTagsForResourceRequest -
      Returns:
      A Java Future containing the result of the ListTagsForResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException The request is missing required parameters or has invalid parameters.
      • ThrottledException The request exceeds the maximum number of requests per second.
      • ResourceNotFoundException The resource was not found. Verify that the name or Amazon Resource Name (ARN) of the resource is correct.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTagsForResource

      default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)

      Returns a list of tags that are applied to the specified Amazon Web Services X-Ray group or sampling rule.


      This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the need to create one manually via ListTagsForResourceRequest.builder()

      Parameters:
      listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListTagsForResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException The request is missing required parameters or has invalid parameters.
      • ThrottledException The request exceeds the maximum number of requests per second.
      • ResourceNotFoundException The resource was not found. Verify that the name or Amazon Resource Name (ARN) of the resource is correct.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTagsForResourcePaginator

      default ListTagsForResourcePublisher listTagsForResourcePaginator(ListTagsForResourceRequest listTagsForResourceRequest)

      This is a variant of listTagsForResource(software.amazon.awssdk.services.xray.model.ListTagsForResourceRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.xray.paginators.ListTagsForResourcePublisher publisher = client.listTagsForResourcePaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.xray.paginators.ListTagsForResourcePublisher publisher = client.listTagsForResourcePaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.xray.model.ListTagsForResourceResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.xray.model.ListTagsForResourceResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listTagsForResource(software.amazon.awssdk.services.xray.model.ListTagsForResourceRequest) operation.

      Parameters:
      listTagsForResourceRequest -
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException The request is missing required parameters or has invalid parameters.
      • ThrottledException The request exceeds the maximum number of requests per second.
      • ResourceNotFoundException The resource was not found. Verify that the name or Amazon Resource Name (ARN) of the resource is correct.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listTagsForResourcePaginator

      default ListTagsForResourcePublisher listTagsForResourcePaginator(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)

      This is a variant of listTagsForResource(software.amazon.awssdk.services.xray.model.ListTagsForResourceRequest) operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.

      When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a new Subscription i.e., a new contract to stream data from the starting request.

      The following are few ways to use the response class:

      1) Using the subscribe helper method 
       
 software.amazon.awssdk.services.xray.paginators.ListTagsForResourcePublisher publisher = client.listTagsForResourcePaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.xray.paginators.ListTagsForResourcePublisher publisher = client.listTagsForResourcePaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.xray.model.ListTagsForResourceResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.xray.model.ListTagsForResourceResponse response) { //... };
 });
      As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.

      Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.

      Note: If you prefer to have control on service calls, use the listTagsForResource(software.amazon.awssdk.services.xray.model.ListTagsForResourceRequest) operation.


      This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the need to create one manually via ListTagsForResourceRequest.builder()

      Parameters:
      listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a request.
      Returns:
      A custom publisher that can be subscribed to request a stream of response pages.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException The request is missing required parameters or has invalid parameters.
      • ThrottledException The request exceeds the maximum number of requests per second.
      • ResourceNotFoundException The resource was not found. Verify that the name or Amazon Resource Name (ARN) of the resource is correct.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putEncryptionConfig

      default CompletableFuture<PutEncryptionConfigResponse> putEncryptionConfig(PutEncryptionConfigRequest putEncryptionConfigRequest)

      Updates the encryption configuration for X-Ray data.

      Parameters:
      putEncryptionConfigRequest -
      Returns:
      A Java Future containing the result of the PutEncryptionConfig operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException The request is missing required parameters or has invalid parameters.
      • ThrottledException The request exceeds the maximum number of requests per second.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putEncryptionConfig

      default CompletableFuture<PutEncryptionConfigResponse> putEncryptionConfig(Consumer<PutEncryptionConfigRequest.Builder> putEncryptionConfigRequest)

      Updates the encryption configuration for X-Ray data.


      This is a convenience which creates an instance of the PutEncryptionConfigRequest.Builder avoiding the need to create one manually via PutEncryptionConfigRequest.builder()

      Parameters:
      putEncryptionConfigRequest - A Consumer that will call methods on PutEncryptionConfigRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the PutEncryptionConfig operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException The request is missing required parameters or has invalid parameters.
      • ThrottledException The request exceeds the maximum number of requests per second.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putResourcePolicy

      default CompletableFuture<PutResourcePolicyResponse> putResourcePolicy(PutResourcePolicyRequest putResourcePolicyRequest)

      Sets the resource policy to grant one or more Amazon Web Services services and accounts permissions to access X-Ray. Each resource policy will be associated with a specific Amazon Web Services account. Each Amazon Web Services account can have a maximum of 5 resource policies, and each policy name must be unique within that account. The maximum size of each resource policy is 5KB.

      Parameters:
      putResourcePolicyRequest -
      Returns:
      A Java Future containing the result of the PutResourcePolicy operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • MalformedPolicyDocumentException Invalid policy document provided in request.
      • LockoutPreventionException The provided resource policy would prevent the caller of this request from calling PutResourcePolicy in the future.
      • InvalidPolicyRevisionIdException A policy revision id was provided which does not match the latest policy revision. This exception is also if a policy revision id of 0 is provided via PutResourcePolicy and a policy with the same name already exists.
      • PolicySizeLimitExceededException Exceeded the maximum size for a resource policy.
      • PolicyCountLimitExceededException Exceeded the maximum number of resource policies for a target Amazon Web Services account.
      • ThrottledException The request exceeds the maximum number of requests per second.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putResourcePolicy

      default CompletableFuture<PutResourcePolicyResponse> putResourcePolicy(Consumer<PutResourcePolicyRequest.Builder> putResourcePolicyRequest)

      Sets the resource policy to grant one or more Amazon Web Services services and accounts permissions to access X-Ray. Each resource policy will be associated with a specific Amazon Web Services account. Each Amazon Web Services account can have a maximum of 5 resource policies, and each policy name must be unique within that account. The maximum size of each resource policy is 5KB.


      This is a convenience which creates an instance of the PutResourcePolicyRequest.Builder avoiding the need to create one manually via PutResourcePolicyRequest.builder()

      Parameters:
      putResourcePolicyRequest - A Consumer that will call methods on PutResourcePolicyRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the PutResourcePolicy operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • MalformedPolicyDocumentException Invalid policy document provided in request.
      • LockoutPreventionException The provided resource policy would prevent the caller of this request from calling PutResourcePolicy in the future.
      • InvalidPolicyRevisionIdException A policy revision id was provided which does not match the latest policy revision. This exception is also if a policy revision id of 0 is provided via PutResourcePolicy and a policy with the same name already exists.
      • PolicySizeLimitExceededException Exceeded the maximum size for a resource policy.
      • PolicyCountLimitExceededException Exceeded the maximum number of resource policies for a target Amazon Web Services account.
      • ThrottledException The request exceeds the maximum number of requests per second.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putTelemetryRecords

      default CompletableFuture<PutTelemetryRecordsResponse> putTelemetryRecords(PutTelemetryRecordsRequest putTelemetryRecordsRequest)

      Used by the Amazon Web Services X-Ray daemon to upload telemetry.

      Parameters:
      putTelemetryRecordsRequest -
      Returns:
      A Java Future containing the result of the PutTelemetryRecords operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException The request is missing required parameters or has invalid parameters.
      • ThrottledException The request exceeds the maximum number of requests per second.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putTelemetryRecords

      default CompletableFuture<PutTelemetryRecordsResponse> putTelemetryRecords(Consumer<PutTelemetryRecordsRequest.Builder> putTelemetryRecordsRequest)

      Used by the Amazon Web Services X-Ray daemon to upload telemetry.


      This is a convenience which creates an instance of the PutTelemetryRecordsRequest.Builder avoiding the need to create one manually via PutTelemetryRecordsRequest.builder()

      Parameters:
      putTelemetryRecordsRequest - A Consumer that will call methods on PutTelemetryRecordsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the PutTelemetryRecords operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException The request is missing required parameters or has invalid parameters.
      • ThrottledException The request exceeds the maximum number of requests per second.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putTraceSegments

      default CompletableFuture<PutTraceSegmentsResponse> putTraceSegments(PutTraceSegmentsRequest putTraceSegmentsRequest)

      Uploads segment documents to Amazon Web Services X-Ray. A segment document can be a completed segment, an in-progress segment, or an array of subsegments.

      Segments must include the following fields. For the full segment document schema, see Amazon Web Services X-Ray Segment Documents in the Amazon Web Services X-Ray Developer Guide.

      Required segment document fields

      • name - The name of the service that handled the request.

      • id - A 64-bit identifier for the segment, unique among segments in the same trace, in 16 hexadecimal digits.

      • trace_id - A unique identifier that connects all segments and subsegments originating from a single client request.

      • start_time - Time the segment or subsegment was created, in floating point seconds in epoch time, accurate to milliseconds. For example, 1480615200.010 or 1.480615200010E9.

      • end_time - Time the segment or subsegment was closed. For example, 1480615200.090 or 1.480615200090E9. Specify either an end_time or in_progress.

      • in_progress - Set to true instead of specifying an end_time to record that a segment has been started, but is not complete. Send an in-progress segment when your application receives a request that will take a long time to serve, to trace that the request was received. When the response is sent, send the complete segment to overwrite the in-progress segment.

      A trace_id consists of three numbers separated by hyphens. For example, 1-58406520-a006649127e371903a2de979. For trace IDs created by an X-Ray SDK, or by Amazon Web Services services integrated with X-Ray, a trace ID includes:

      Trace ID Format

      • The version number, for instance, 1.

      • The time of the original request, in Unix epoch time, in 8 hexadecimal digits. For example, 10:00AM December 2nd, 2016 PST in epoch time is 1480615200 seconds, or 58406520 in hexadecimal.

      • A 96-bit identifier for the trace, globally unique, in 24 hexadecimal digits.

      Trace IDs created via OpenTelemetry have a different format based on the W3C Trace Context specification. A W3C trace ID must be formatted in the X-Ray trace ID format when sending to X-Ray. For example, a W3C trace ID 4efaaf4d1e8720b39541901950019ee5 should be formatted as 1-4efaaf4d-1e8720b39541901950019ee5 when sending to X-Ray. While X-Ray trace IDs include the original request timestamp in Unix epoch time, this is not required or validated.

      Parameters:
      putTraceSegmentsRequest -
      Returns:
      A Java Future containing the result of the PutTraceSegments operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException The request is missing required parameters or has invalid parameters.
      • ThrottledException The request exceeds the maximum number of requests per second.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putTraceSegments

      default CompletableFuture<PutTraceSegmentsResponse> putTraceSegments(Consumer<PutTraceSegmentsRequest.Builder> putTraceSegmentsRequest)

      Uploads segment documents to Amazon Web Services X-Ray. A segment document can be a completed segment, an in-progress segment, or an array of subsegments.

      Segments must include the following fields. For the full segment document schema, see Amazon Web Services X-Ray Segment Documents in the Amazon Web Services X-Ray Developer Guide.

      Required segment document fields

      • name - The name of the service that handled the request.

      • id - A 64-bit identifier for the segment, unique among segments in the same trace, in 16 hexadecimal digits.

      • trace_id - A unique identifier that connects all segments and subsegments originating from a single client request.

      • start_time - Time the segment or subsegment was created, in floating point seconds in epoch time, accurate to milliseconds. For example, 1480615200.010 or 1.480615200010E9.

      • end_time - Time the segment or subsegment was closed. For example, 1480615200.090 or 1.480615200090E9. Specify either an end_time or in_progress.

      • in_progress - Set to true instead of specifying an end_time to record that a segment has been started, but is not complete. Send an in-progress segment when your application receives a request that will take a long time to serve, to trace that the request was received. When the response is sent, send the complete segment to overwrite the in-progress segment.

      A trace_id consists of three numbers separated by hyphens. For example, 1-58406520-a006649127e371903a2de979. For trace IDs created by an X-Ray SDK, or by Amazon Web Services services integrated with X-Ray, a trace ID includes:

      Trace ID Format

      • The version number, for instance, 1.

      • The time of the original request, in Unix epoch time, in 8 hexadecimal digits. For example, 10:00AM December 2nd, 2016 PST in epoch time is 1480615200 seconds, or 58406520 in hexadecimal.

      • A 96-bit identifier for the trace, globally unique, in 24 hexadecimal digits.

      Trace IDs created via OpenTelemetry have a different format based on the W3C Trace Context specification. A W3C trace ID must be formatted in the X-Ray trace ID format when sending to X-Ray. For example, a W3C trace ID 4efaaf4d1e8720b39541901950019ee5 should be formatted as 1-4efaaf4d-1e8720b39541901950019ee5 when sending to X-Ray. While X-Ray trace IDs include the original request timestamp in Unix epoch time, this is not required or validated.


      This is a convenience which creates an instance of the PutTraceSegmentsRequest.Builder avoiding the need to create one manually via PutTraceSegmentsRequest.builder()

      Parameters:
      putTraceSegmentsRequest - A Consumer that will call methods on PutTraceSegmentsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the PutTraceSegments operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException The request is missing required parameters or has invalid parameters.
      • ThrottledException The request exceeds the maximum number of requests per second.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startTraceRetrieval

      default CompletableFuture<StartTraceRetrievalResponse> startTraceRetrieval(StartTraceRetrievalRequest startTraceRetrievalRequest)

      Initiates a trace retrieval process using the specified time range and for the given trace IDs in the Transaction Search generated CloudWatch log group. For more information, see Transaction Search.

      API returns a RetrievalToken, which can be used with ListRetrievedTraces or GetRetrievedTracesGraph to fetch results. Retrievals will time out after 60 minutes. To execute long time ranges, consider segmenting into multiple retrievals.

      If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account to retrieve data from a linked source account, as long as both accounts have transaction search enabled.

      For retrieving data from X-Ray directly as opposed to the Transaction-Search Log group, see BatchGetTraces.

      Parameters:
      startTraceRetrievalRequest -
      Returns:
      A Java Future containing the result of the StartTraceRetrieval operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException The request is missing required parameters or has invalid parameters.
      • ThrottledException The request exceeds the maximum number of requests per second.
      • ResourceNotFoundException The resource was not found. Verify that the name or Amazon Resource Name (ARN) of the resource is correct.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • startTraceRetrieval

      default CompletableFuture<StartTraceRetrievalResponse> startTraceRetrieval(Consumer<StartTraceRetrievalRequest.Builder> startTraceRetrievalRequest)

      Initiates a trace retrieval process using the specified time range and for the given trace IDs in the Transaction Search generated CloudWatch log group. For more information, see Transaction Search.

      API returns a RetrievalToken, which can be used with ListRetrievedTraces or GetRetrievedTracesGraph to fetch results. Retrievals will time out after 60 minutes. To execute long time ranges, consider segmenting into multiple retrievals.

      If you are using CloudWatch cross-account observability, you can use this operation in a monitoring account to retrieve data from a linked source account, as long as both accounts have transaction search enabled.

      For retrieving data from X-Ray directly as opposed to the Transaction-Search Log group, see BatchGetTraces.


      This is a convenience which creates an instance of the StartTraceRetrievalRequest.Builder avoiding the need to create one manually via StartTraceRetrievalRequest.builder()

      Parameters:
      startTraceRetrievalRequest - A Consumer that will call methods on StartTraceRetrievalRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the StartTraceRetrieval operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException The request is missing required parameters or has invalid parameters.
      • ThrottledException The request exceeds the maximum number of requests per second.
      • ResourceNotFoundException The resource was not found. Verify that the name or Amazon Resource Name (ARN) of the resource is correct.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • tagResource

      default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest)

      Applies tags to an existing Amazon Web Services X-Ray group or sampling rule.

      Parameters:
      tagResourceRequest -
      Returns:
      A Java Future containing the result of the TagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException The request is missing required parameters or has invalid parameters.
      • ThrottledException The request exceeds the maximum number of requests per second.
      • ResourceNotFoundException The resource was not found. Verify that the name or Amazon Resource Name (ARN) of the resource is correct.
      • TooManyTagsException You have exceeded the maximum number of tags you can apply to this resource.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • tagResource

      default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)

      Applies tags to an existing Amazon Web Services X-Ray group or sampling rule.


      This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to create one manually via TagResourceRequest.builder()

      Parameters:
      tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the TagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException The request is missing required parameters or has invalid parameters.
      • ThrottledException The request exceeds the maximum number of requests per second.
      • ResourceNotFoundException The resource was not found. Verify that the name or Amazon Resource Name (ARN) of the resource is correct.
      • TooManyTagsException You have exceeded the maximum number of tags you can apply to this resource.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • untagResource

      default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest)

      Removes tags from an Amazon Web Services X-Ray group or sampling rule. You cannot edit or delete system tags (those with an aws: prefix).

      Parameters:
      untagResourceRequest -
      Returns:
      A Java Future containing the result of the UntagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException The request is missing required parameters or has invalid parameters.
      • ThrottledException The request exceeds the maximum number of requests per second.
      • ResourceNotFoundException The resource was not found. Verify that the name or Amazon Resource Name (ARN) of the resource is correct.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • untagResource

      default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)

      Removes tags from an Amazon Web Services X-Ray group or sampling rule. You cannot edit or delete system tags (those with an aws: prefix).


      This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to create one manually via UntagResourceRequest.builder()

      Parameters:
      untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UntagResource operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException The request is missing required parameters or has invalid parameters.
      • ThrottledException The request exceeds the maximum number of requests per second.
      • ResourceNotFoundException The resource was not found. Verify that the name or Amazon Resource Name (ARN) of the resource is correct.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateGroup

      default CompletableFuture<UpdateGroupResponse> updateGroup(UpdateGroupRequest updateGroupRequest)

      Updates a group resource.

      Parameters:
      updateGroupRequest -
      Returns:
      A Java Future containing the result of the UpdateGroup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException The request is missing required parameters or has invalid parameters.
      • ThrottledException The request exceeds the maximum number of requests per second.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateGroup

      default CompletableFuture<UpdateGroupResponse> updateGroup(Consumer<UpdateGroupRequest.Builder> updateGroupRequest)

      Updates a group resource.


      This is a convenience which creates an instance of the UpdateGroupRequest.Builder avoiding the need to create one manually via UpdateGroupRequest.builder()

      Parameters:
      updateGroupRequest - A Consumer that will call methods on UpdateGroupRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateGroup operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException The request is missing required parameters or has invalid parameters.
      • ThrottledException The request exceeds the maximum number of requests per second.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateIndexingRule

      default CompletableFuture<UpdateIndexingRuleResponse> updateIndexingRule(UpdateIndexingRuleRequest updateIndexingRuleRequest)

      Modifies an indexing rule’s configuration.

      Indexing rules are used for determining the sampling rate for spans indexed from CloudWatch Logs. For more information, see Transaction Search.

      Parameters:
      updateIndexingRuleRequest -
      Returns:
      A Java Future containing the result of the UpdateIndexingRule operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException The request is missing required parameters or has invalid parameters.
      • ThrottledException The request exceeds the maximum number of requests per second.
      • ResourceNotFoundException The resource was not found. Verify that the name or Amazon Resource Name (ARN) of the resource is correct.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateIndexingRule

      default CompletableFuture<UpdateIndexingRuleResponse> updateIndexingRule(Consumer<UpdateIndexingRuleRequest.Builder> updateIndexingRuleRequest)

      Modifies an indexing rule’s configuration.

      Indexing rules are used for determining the sampling rate for spans indexed from CloudWatch Logs. For more information, see Transaction Search.


      This is a convenience which creates an instance of the UpdateIndexingRuleRequest.Builder avoiding the need to create one manually via UpdateIndexingRuleRequest.builder()

      Parameters:
      updateIndexingRuleRequest - A Consumer that will call methods on UpdateIndexingRuleRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateIndexingRule operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException The request is missing required parameters or has invalid parameters.
      • ThrottledException The request exceeds the maximum number of requests per second.
      • ResourceNotFoundException The resource was not found. Verify that the name or Amazon Resource Name (ARN) of the resource is correct.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateSamplingRule

      default CompletableFuture<UpdateSamplingRuleResponse> updateSamplingRule(UpdateSamplingRuleRequest updateSamplingRuleRequest)

      Modifies a sampling rule's configuration.

      Parameters:
      updateSamplingRuleRequest -
      Returns:
      A Java Future containing the result of the UpdateSamplingRule operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException The request is missing required parameters or has invalid parameters.
      • ThrottledException The request exceeds the maximum number of requests per second.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateSamplingRule

      default CompletableFuture<UpdateSamplingRuleResponse> updateSamplingRule(Consumer<UpdateSamplingRuleRequest.Builder> updateSamplingRuleRequest)

      Modifies a sampling rule's configuration.


      This is a convenience which creates an instance of the UpdateSamplingRuleRequest.Builder avoiding the need to create one manually via UpdateSamplingRuleRequest.builder()

      Parameters:
      updateSamplingRuleRequest - A Consumer that will call methods on UpdateSamplingRuleRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateSamplingRule operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException The request is missing required parameters or has invalid parameters.
      • ThrottledException The request exceeds the maximum number of requests per second.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateTraceSegmentDestination

      default CompletableFuture<UpdateTraceSegmentDestinationResponse> updateTraceSegmentDestination(UpdateTraceSegmentDestinationRequest updateTraceSegmentDestinationRequest)

      Modifies the destination of data sent to PutTraceSegments. The Transaction Search feature requires the CloudWatchLogs destination. For more information, see Transaction Search.

      Parameters:
      updateTraceSegmentDestinationRequest -
      Returns:
      A Java Future containing the result of the UpdateTraceSegmentDestination operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException The request is missing required parameters or has invalid parameters.
      • ThrottledException The request exceeds the maximum number of requests per second.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • updateTraceSegmentDestination

      default CompletableFuture<UpdateTraceSegmentDestinationResponse> updateTraceSegmentDestination(Consumer<UpdateTraceSegmentDestinationRequest.Builder> updateTraceSegmentDestinationRequest)

      Modifies the destination of data sent to PutTraceSegments. The Transaction Search feature requires the CloudWatchLogs destination. For more information, see Transaction Search.


      This is a convenience which creates an instance of the UpdateTraceSegmentDestinationRequest.Builder avoiding the need to create one manually via UpdateTraceSegmentDestinationRequest.builder()

      Parameters:
      updateTraceSegmentDestinationRequest - A Consumer that will call methods on UpdateTraceSegmentDestinationRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the UpdateTraceSegmentDestination operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • InvalidRequestException The request is missing required parameters or has invalid parameters.
      • ThrottledException The request exceeds the maximum number of requests per second.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • XRayException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • serviceClientConfiguration

      default XRayServiceClientConfiguration serviceClientConfiguration()
      Description copied from interface: SdkClient
      The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
      Specified by:
      serviceClientConfiguration in interface AwsClient
      Specified by:
      serviceClientConfiguration in interface SdkClient
      Returns:
      SdkServiceClientConfiguration

    • create

      static XRayAsyncClient create()
      Create a XRayAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

    • builder

      static XRayAsyncClientBuilder builder()
      Create a builder that can be used to configure and create a XRayAsyncClient.