Interface RestXmlDataPlaneAsyncClient

All Superinterfaces:
AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient
@Generated("software.amazon.awssdk:codegen") @SdkPublicApi @ThreadSafe public interface RestXmlDataPlaneAsyncClient extends AwsClient
Service client for accessing AWS REST XML Data Plane 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. null

  • Field Details

  • Method Details

    • copyObject

      default CompletableFuture<CopyObjectResponse> copyObject(CopyObjectRequest copyObjectRequest)
      Invokes the CopyObject operation asynchronously.
      Parameters:
      copyObjectRequest -
      Returns:
      A Java Future containing the result of the CopyObject 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • RestXmlDataPlaneException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • copyObject

      default CompletableFuture<CopyObjectResponse> copyObject(Consumer<CopyObjectRequest.Builder> copyObjectRequest)
      Invokes the CopyObject operation asynchronously.

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

      Parameters:
      copyObjectRequest - A Consumer that will call methods on CopyObjectRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CopyObject 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • RestXmlDataPlaneException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getMetricData

      default CompletableFuture<GetMetricDataResponse> getMetricData(GetMetricDataRequest getMetricDataRequest)
      Invokes the GetMetricData operation asynchronously.
      Parameters:
      getMetricDataRequest -
      Returns:
      A Java Future containing the result of the GetMetricData 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • RestXmlDataPlaneException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getMetricData

      default CompletableFuture<GetMetricDataResponse> getMetricData(Consumer<GetMetricDataRequest.Builder> getMetricDataRequest)
      Invokes the GetMetricData operation asynchronously.

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

      Parameters:
      getMetricDataRequest - A Consumer that will call methods on GetMetricDataRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetMetricData 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • RestXmlDataPlaneException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getObject

      default CompletableFuture<GetObjectResponse> getObject(GetObjectRequest getObjectRequest)
      Invokes the GetObject operation asynchronously.
      Parameters:
      getObjectRequest -
      Returns:
      A Java Future containing the result of the GetObject 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • RestXmlDataPlaneException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getObject

      default CompletableFuture<GetObjectResponse> getObject(Consumer<GetObjectRequest.Builder> getObjectRequest)
      Invokes the GetObject operation asynchronously.

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

      Parameters:
      getObjectRequest - A Consumer that will call methods on GetObjectRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetObject 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • RestXmlDataPlaneException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • healthcheck

      default CompletableFuture<HealthcheckResponse> healthcheck(HealthcheckRequest healthcheckRequest)
      Invokes the Healthcheck operation asynchronously.
      Parameters:
      healthcheckRequest -
      Returns:
      A Java Future containing the result of the Healthcheck 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • RestXmlDataPlaneException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • healthcheck

      default CompletableFuture<HealthcheckResponse> healthcheck(Consumer<HealthcheckRequest.Builder> healthcheckRequest)
      Invokes the Healthcheck operation asynchronously.

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

      Parameters:
      healthcheckRequest - A Consumer that will call methods on HealthcheckRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the Healthcheck 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • RestXmlDataPlaneException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putMetricData

      default CompletableFuture<PutMetricDataResponse> putMetricData(PutMetricDataRequest putMetricDataRequest)
      Invokes the PutMetricData operation asynchronously.
      Parameters:
      putMetricDataRequest -
      Returns:
      A Java Future containing the result of the PutMetricData 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • RestXmlDataPlaneException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putMetricData

      default CompletableFuture<PutMetricDataResponse> putMetricData(Consumer<PutMetricDataRequest.Builder> putMetricDataRequest)
      Invokes the PutMetricData operation asynchronously.

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

      Parameters:
      putMetricDataRequest - A Consumer that will call methods on PutMetricDataRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the PutMetricData 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • RestXmlDataPlaneException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putObject

      default CompletableFuture<PutObjectResponse> putObject(PutObjectRequest putObjectRequest)
      Invokes the PutObject operation asynchronously.
      Parameters:
      putObjectRequest -
      Returns:
      A Java Future containing the result of the PutObject 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • RestXmlDataPlaneException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • putObject

      default CompletableFuture<PutObjectResponse> putObject(Consumer<PutObjectRequest.Builder> putObjectRequest)
      Invokes the PutObject operation asynchronously.

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

      Parameters:
      putObjectRequest - A Consumer that will call methods on PutObjectRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the PutObject 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • RestXmlDataPlaneException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • serviceClientConfiguration

      default RestXmlDataPlaneServiceClientConfiguration 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 RestXmlDataPlaneAsyncClient create()
      Create a RestXmlDataPlaneAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

    • builder

      static RestXmlDataPlaneAsyncClientBuilder builder()
      Create a builder that can be used to configure and create a RestXmlDataPlaneAsyncClient.