Package software.amazon.awssdk.services.pi

Interface PiAsyncClient

All Superinterfaces:
AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface PiAsyncClient extends AwsClient
Service client for accessing AWS PI asynchronously. This can be created using the static builder() method. Amazon RDS Performance Insights

Amazon RDS Performance Insights enables you to monitor and explore different dimensions of database load based on data captured from a running DB instance. The guide provides detailed information about Performance Insights data types, parameters and errors.

When Performance Insights is enabled, the Amazon RDS Performance Insights API provides visibility into the performance of your DB instance. Amazon CloudWatch provides the authoritative source for Amazon Web Services service-vended monitoring metrics. Performance Insights offers a domain-specific view of DB load.

DB load is measured as average active sessions. Performance Insights provides the data to API consumers as a two-dimensional time-series dataset. The time dimension provides DB load data for each time point in the queried time range. Each time point decomposes overall load in relation to the requested dimensions, measured at that time point. Examples include SQL, Wait event, User, and Host.

  • Field Details

  • Method Details

    • createPerformanceAnalysisReport

      default CompletableFuture<CreatePerformanceAnalysisReportResponse> createPerformanceAnalysisReport(CreatePerformanceAnalysisReportRequest createPerformanceAnalysisReportRequest)

      Creates a new performance analysis report for a specific time period for the DB instance.

      Parameters:
      createPerformanceAnalysisReportRequest -
      Returns:
      A Java Future containing the result of the CreatePerformanceAnalysisReport operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • InvalidArgumentException One of the arguments provided is invalid for this request.
      • InternalServiceErrorException The request failed due to an unknown error.
      • NotAuthorizedException The user is not authorized to perform this request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • PiException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • createPerformanceAnalysisReport

      default CompletableFuture<CreatePerformanceAnalysisReportResponse> createPerformanceAnalysisReport(Consumer<CreatePerformanceAnalysisReportRequest.Builder> createPerformanceAnalysisReportRequest)

      Creates a new performance analysis report for a specific time period for the DB instance.


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

      Parameters:
      createPerformanceAnalysisReportRequest - A Consumer that will call methods on CreatePerformanceAnalysisReportRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the CreatePerformanceAnalysisReport operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • InvalidArgumentException One of the arguments provided is invalid for this request.
      • InternalServiceErrorException The request failed due to an unknown error.
      • NotAuthorizedException The user is not authorized to perform this request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • PiException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deletePerformanceAnalysisReport

      default CompletableFuture<DeletePerformanceAnalysisReportResponse> deletePerformanceAnalysisReport(DeletePerformanceAnalysisReportRequest deletePerformanceAnalysisReportRequest)

      Deletes a performance analysis report.

      Parameters:
      deletePerformanceAnalysisReportRequest -
      Returns:
      A Java Future containing the result of the DeletePerformanceAnalysisReport operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • InvalidArgumentException One of the arguments provided is invalid for this request.
      • InternalServiceErrorException The request failed due to an unknown error.
      • NotAuthorizedException The user is not authorized to perform this request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • PiException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • deletePerformanceAnalysisReport

      default CompletableFuture<DeletePerformanceAnalysisReportResponse> deletePerformanceAnalysisReport(Consumer<DeletePerformanceAnalysisReportRequest.Builder> deletePerformanceAnalysisReportRequest)

      Deletes a performance analysis report.


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

      Parameters:
      deletePerformanceAnalysisReportRequest - A Consumer that will call methods on DeletePerformanceAnalysisReportRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DeletePerformanceAnalysisReport operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • InvalidArgumentException One of the arguments provided is invalid for this request.
      • InternalServiceErrorException The request failed due to an unknown error.
      • NotAuthorizedException The user is not authorized to perform this request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • PiException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeDimensionKeys

      default CompletableFuture<DescribeDimensionKeysResponse> describeDimensionKeys(DescribeDimensionKeysRequest describeDimensionKeysRequest)

      For a specific time period, retrieve the top N dimension keys for a metric.

      Each response element returns a maximum of 500 bytes. For larger elements, such as SQL statements, only the first 500 bytes are returned.

      Parameters:
      describeDimensionKeysRequest -
      Returns:
      A Java Future containing the result of the DescribeDimensionKeys operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • InvalidArgumentException One of the arguments provided is invalid for this request.
      • InternalServiceErrorException The request failed due to an unknown error.
      • NotAuthorizedException The user is not authorized to perform this request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • PiException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeDimensionKeys

      default CompletableFuture<DescribeDimensionKeysResponse> describeDimensionKeys(Consumer<DescribeDimensionKeysRequest.Builder> describeDimensionKeysRequest)

      For a specific time period, retrieve the top N dimension keys for a metric.

      Each response element returns a maximum of 500 bytes. For larger elements, such as SQL statements, only the first 500 bytes are returned.


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

      Parameters:
      describeDimensionKeysRequest - A Consumer that will call methods on DescribeDimensionKeysRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DescribeDimensionKeys operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • InvalidArgumentException One of the arguments provided is invalid for this request.
      • InternalServiceErrorException The request failed due to an unknown error.
      • NotAuthorizedException The user is not authorized to perform this request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • PiException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeDimensionKeysPaginator

      default DescribeDimensionKeysPublisher describeDimensionKeysPaginator(DescribeDimensionKeysRequest describeDimensionKeysRequest)

      For a specific time period, retrieve the top N dimension keys for a metric.

      Each response element returns a maximum of 500 bytes. For larger elements, such as SQL statements, only the first 500 bytes are returned.


      This is a variant of describeDimensionKeys(software.amazon.awssdk.services.pi.model.DescribeDimensionKeysRequest) 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.pi.paginators.DescribeDimensionKeysPublisher publisher = client.describeDimensionKeysPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.pi.paginators.DescribeDimensionKeysPublisher publisher = client.describeDimensionKeysPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.pi.model.DescribeDimensionKeysResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.pi.model.DescribeDimensionKeysResponse 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 describeDimensionKeys(software.amazon.awssdk.services.pi.model.DescribeDimensionKeysRequest) operation.

      Parameters:
      describeDimensionKeysRequest -
      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.
      • InvalidArgumentException One of the arguments provided is invalid for this request.
      • InternalServiceErrorException The request failed due to an unknown error.
      • NotAuthorizedException The user is not authorized to perform this request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • PiException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • describeDimensionKeysPaginator

      default DescribeDimensionKeysPublisher describeDimensionKeysPaginator(Consumer<DescribeDimensionKeysRequest.Builder> describeDimensionKeysRequest)

      For a specific time period, retrieve the top N dimension keys for a metric.

      Each response element returns a maximum of 500 bytes. For larger elements, such as SQL statements, only the first 500 bytes are returned.


      This is a variant of describeDimensionKeys(software.amazon.awssdk.services.pi.model.DescribeDimensionKeysRequest) 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.pi.paginators.DescribeDimensionKeysPublisher publisher = client.describeDimensionKeysPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.pi.paginators.DescribeDimensionKeysPublisher publisher = client.describeDimensionKeysPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.pi.model.DescribeDimensionKeysResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.pi.model.DescribeDimensionKeysResponse 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 describeDimensionKeys(software.amazon.awssdk.services.pi.model.DescribeDimensionKeysRequest) operation.

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

      Parameters:
      describeDimensionKeysRequest - A Consumer that will call methods on DescribeDimensionKeysRequest.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.
      • InvalidArgumentException One of the arguments provided is invalid for this request.
      • InternalServiceErrorException The request failed due to an unknown error.
      • NotAuthorizedException The user is not authorized to perform this request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • PiException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getDimensionKeyDetails

      default CompletableFuture<GetDimensionKeyDetailsResponse> getDimensionKeyDetails(GetDimensionKeyDetailsRequest getDimensionKeyDetailsRequest)

      Get the attributes of the specified dimension group for a DB instance or data source. For example, if you specify a SQL ID, GetDimensionKeyDetails retrieves the full text of the dimension db.sql.statement associated with this ID. This operation is useful because GetResourceMetrics and DescribeDimensionKeys don't support retrieval of large SQL statement text.

      Parameters:
      getDimensionKeyDetailsRequest -
      Returns:
      A Java Future containing the result of the GetDimensionKeyDetails operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • InvalidArgumentException One of the arguments provided is invalid for this request.
      • InternalServiceErrorException The request failed due to an unknown error.
      • NotAuthorizedException The user is not authorized to perform this request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • PiException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getDimensionKeyDetails

      default CompletableFuture<GetDimensionKeyDetailsResponse> getDimensionKeyDetails(Consumer<GetDimensionKeyDetailsRequest.Builder> getDimensionKeyDetailsRequest)

      Get the attributes of the specified dimension group for a DB instance or data source. For example, if you specify a SQL ID, GetDimensionKeyDetails retrieves the full text of the dimension db.sql.statement associated with this ID. This operation is useful because GetResourceMetrics and DescribeDimensionKeys don't support retrieval of large SQL statement text.


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

      Parameters:
      getDimensionKeyDetailsRequest - A Consumer that will call methods on GetDimensionKeyDetailsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetDimensionKeyDetails operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • InvalidArgumentException One of the arguments provided is invalid for this request.
      • InternalServiceErrorException The request failed due to an unknown error.
      • NotAuthorizedException The user is not authorized to perform this request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • PiException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getPerformanceAnalysisReport

      default CompletableFuture<GetPerformanceAnalysisReportResponse> getPerformanceAnalysisReport(GetPerformanceAnalysisReportRequest getPerformanceAnalysisReportRequest)

      Retrieves the report including the report ID, status, time details, and the insights with recommendations. The report status can be RUNNING, SUCCEEDED, or FAILED. The insights include the description and recommendation fields.

      Parameters:
      getPerformanceAnalysisReportRequest -
      Returns:
      A Java Future containing the result of the GetPerformanceAnalysisReport operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • InvalidArgumentException One of the arguments provided is invalid for this request.
      • InternalServiceErrorException The request failed due to an unknown error.
      • NotAuthorizedException The user is not authorized to perform this request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • PiException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getPerformanceAnalysisReport

      default CompletableFuture<GetPerformanceAnalysisReportResponse> getPerformanceAnalysisReport(Consumer<GetPerformanceAnalysisReportRequest.Builder> getPerformanceAnalysisReportRequest)

      Retrieves the report including the report ID, status, time details, and the insights with recommendations. The report status can be RUNNING, SUCCEEDED, or FAILED. The insights include the description and recommendation fields.


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

      Parameters:
      getPerformanceAnalysisReportRequest - A Consumer that will call methods on GetPerformanceAnalysisReportRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetPerformanceAnalysisReport operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • InvalidArgumentException One of the arguments provided is invalid for this request.
      • InternalServiceErrorException The request failed due to an unknown error.
      • NotAuthorizedException The user is not authorized to perform this request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • PiException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getResourceMetadata

      default CompletableFuture<GetResourceMetadataResponse> getResourceMetadata(GetResourceMetadataRequest getResourceMetadataRequest)

      Retrieve the metadata for different features. For example, the metadata might indicate that a feature is turned on or off on a specific DB instance.

      Parameters:
      getResourceMetadataRequest -
      Returns:
      A Java Future containing the result of the GetResourceMetadata operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • InvalidArgumentException One of the arguments provided is invalid for this request.
      • InternalServiceErrorException The request failed due to an unknown error.
      • NotAuthorizedException The user is not authorized to perform this request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • PiException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getResourceMetadata

      default CompletableFuture<GetResourceMetadataResponse> getResourceMetadata(Consumer<GetResourceMetadataRequest.Builder> getResourceMetadataRequest)

      Retrieve the metadata for different features. For example, the metadata might indicate that a feature is turned on or off on a specific DB instance.


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

      Parameters:
      getResourceMetadataRequest - A Consumer that will call methods on GetResourceMetadataRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetResourceMetadata operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • InvalidArgumentException One of the arguments provided is invalid for this request.
      • InternalServiceErrorException The request failed due to an unknown error.
      • NotAuthorizedException The user is not authorized to perform this request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • PiException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getResourceMetrics

      default CompletableFuture<GetResourceMetricsResponse> getResourceMetrics(GetResourceMetricsRequest getResourceMetricsRequest)

      Retrieve Performance Insights metrics for a set of data sources over a time period. You can provide specific dimension groups and dimensions, and provide aggregation and filtering criteria for each group.

      Each response element returns a maximum of 500 bytes. For larger elements, such as SQL statements, only the first 500 bytes are returned.

      Parameters:
      getResourceMetricsRequest -
      Returns:
      A Java Future containing the result of the GetResourceMetrics operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • InvalidArgumentException One of the arguments provided is invalid for this request.
      • InternalServiceErrorException The request failed due to an unknown error.
      • NotAuthorizedException The user is not authorized to perform this request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • PiException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getResourceMetrics

      default CompletableFuture<GetResourceMetricsResponse> getResourceMetrics(Consumer<GetResourceMetricsRequest.Builder> getResourceMetricsRequest)

      Retrieve Performance Insights metrics for a set of data sources over a time period. You can provide specific dimension groups and dimensions, and provide aggregation and filtering criteria for each group.

      Each response element returns a maximum of 500 bytes. For larger elements, such as SQL statements, only the first 500 bytes are returned.


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

      Parameters:
      getResourceMetricsRequest - A Consumer that will call methods on GetResourceMetricsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GetResourceMetrics operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • InvalidArgumentException One of the arguments provided is invalid for this request.
      • InternalServiceErrorException The request failed due to an unknown error.
      • NotAuthorizedException The user is not authorized to perform this request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • PiException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getResourceMetricsPaginator

      default GetResourceMetricsPublisher getResourceMetricsPaginator(GetResourceMetricsRequest getResourceMetricsRequest)

      Retrieve Performance Insights metrics for a set of data sources over a time period. You can provide specific dimension groups and dimensions, and provide aggregation and filtering criteria for each group.

      Each response element returns a maximum of 500 bytes. For larger elements, such as SQL statements, only the first 500 bytes are returned.


      This is a variant of getResourceMetrics(software.amazon.awssdk.services.pi.model.GetResourceMetricsRequest) 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.pi.paginators.GetResourceMetricsPublisher publisher = client.getResourceMetricsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.pi.paginators.GetResourceMetricsPublisher publisher = client.getResourceMetricsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.pi.model.GetResourceMetricsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.pi.model.GetResourceMetricsResponse 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 getResourceMetrics(software.amazon.awssdk.services.pi.model.GetResourceMetricsRequest) operation.

      Parameters:
      getResourceMetricsRequest -
      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.
      • InvalidArgumentException One of the arguments provided is invalid for this request.
      • InternalServiceErrorException The request failed due to an unknown error.
      • NotAuthorizedException The user is not authorized to perform this request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • PiException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • getResourceMetricsPaginator

      default GetResourceMetricsPublisher getResourceMetricsPaginator(Consumer<GetResourceMetricsRequest.Builder> getResourceMetricsRequest)

      Retrieve Performance Insights metrics for a set of data sources over a time period. You can provide specific dimension groups and dimensions, and provide aggregation and filtering criteria for each group.

      Each response element returns a maximum of 500 bytes. For larger elements, such as SQL statements, only the first 500 bytes are returned.


      This is a variant of getResourceMetrics(software.amazon.awssdk.services.pi.model.GetResourceMetricsRequest) 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.pi.paginators.GetResourceMetricsPublisher publisher = client.getResourceMetricsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.pi.paginators.GetResourceMetricsPublisher publisher = client.getResourceMetricsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.pi.model.GetResourceMetricsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.pi.model.GetResourceMetricsResponse 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 getResourceMetrics(software.amazon.awssdk.services.pi.model.GetResourceMetricsRequest) operation.

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

      Parameters:
      getResourceMetricsRequest - A Consumer that will call methods on GetResourceMetricsRequest.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.
      • InvalidArgumentException One of the arguments provided is invalid for this request.
      • InternalServiceErrorException The request failed due to an unknown error.
      • NotAuthorizedException The user is not authorized to perform this request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • PiException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAvailableResourceDimensions

      default CompletableFuture<ListAvailableResourceDimensionsResponse> listAvailableResourceDimensions(ListAvailableResourceDimensionsRequest listAvailableResourceDimensionsRequest)

      Retrieve the dimensions that can be queried for each specified metric type on a specified DB instance.

      Parameters:
      listAvailableResourceDimensionsRequest -
      Returns:
      A Java Future containing the result of the ListAvailableResourceDimensions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • InvalidArgumentException One of the arguments provided is invalid for this request.
      • InternalServiceErrorException The request failed due to an unknown error.
      • NotAuthorizedException The user is not authorized to perform this request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • PiException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAvailableResourceDimensions

      default CompletableFuture<ListAvailableResourceDimensionsResponse> listAvailableResourceDimensions(Consumer<ListAvailableResourceDimensionsRequest.Builder> listAvailableResourceDimensionsRequest)

      Retrieve the dimensions that can be queried for each specified metric type on a specified DB instance.


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

      Parameters:
      listAvailableResourceDimensionsRequest - A Consumer that will call methods on ListAvailableResourceDimensionsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListAvailableResourceDimensions operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • InvalidArgumentException One of the arguments provided is invalid for this request.
      • InternalServiceErrorException The request failed due to an unknown error.
      • NotAuthorizedException The user is not authorized to perform this request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • PiException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAvailableResourceDimensionsPaginator

      default ListAvailableResourceDimensionsPublisher listAvailableResourceDimensionsPaginator(ListAvailableResourceDimensionsRequest listAvailableResourceDimensionsRequest)

      Retrieve the dimensions that can be queried for each specified metric type on a specified DB instance.


      This is a variant of listAvailableResourceDimensions(software.amazon.awssdk.services.pi.model.ListAvailableResourceDimensionsRequest) 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.pi.paginators.ListAvailableResourceDimensionsPublisher publisher = client.listAvailableResourceDimensionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.pi.paginators.ListAvailableResourceDimensionsPublisher publisher = client.listAvailableResourceDimensionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.pi.model.ListAvailableResourceDimensionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.pi.model.ListAvailableResourceDimensionsResponse 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 listAvailableResourceDimensions(software.amazon.awssdk.services.pi.model.ListAvailableResourceDimensionsRequest) operation.

      Parameters:
      listAvailableResourceDimensionsRequest -
      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.
      • InvalidArgumentException One of the arguments provided is invalid for this request.
      • InternalServiceErrorException The request failed due to an unknown error.
      • NotAuthorizedException The user is not authorized to perform this request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • PiException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAvailableResourceDimensionsPaginator

      default ListAvailableResourceDimensionsPublisher listAvailableResourceDimensionsPaginator(Consumer<ListAvailableResourceDimensionsRequest.Builder> listAvailableResourceDimensionsRequest)

      Retrieve the dimensions that can be queried for each specified metric type on a specified DB instance.


      This is a variant of listAvailableResourceDimensions(software.amazon.awssdk.services.pi.model.ListAvailableResourceDimensionsRequest) 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.pi.paginators.ListAvailableResourceDimensionsPublisher publisher = client.listAvailableResourceDimensionsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.pi.paginators.ListAvailableResourceDimensionsPublisher publisher = client.listAvailableResourceDimensionsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.pi.model.ListAvailableResourceDimensionsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.pi.model.ListAvailableResourceDimensionsResponse 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 listAvailableResourceDimensions(software.amazon.awssdk.services.pi.model.ListAvailableResourceDimensionsRequest) operation.

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

      Parameters:
      listAvailableResourceDimensionsRequest - A Consumer that will call methods on ListAvailableResourceDimensionsRequest.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.
      • InvalidArgumentException One of the arguments provided is invalid for this request.
      • InternalServiceErrorException The request failed due to an unknown error.
      • NotAuthorizedException The user is not authorized to perform this request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • PiException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAvailableResourceMetrics

      default CompletableFuture<ListAvailableResourceMetricsResponse> listAvailableResourceMetrics(ListAvailableResourceMetricsRequest listAvailableResourceMetricsRequest)

      Retrieve metrics of the specified types that can be queried for a specified DB instance.

      Parameters:
      listAvailableResourceMetricsRequest -
      Returns:
      A Java Future containing the result of the ListAvailableResourceMetrics operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • InvalidArgumentException One of the arguments provided is invalid for this request.
      • InternalServiceErrorException The request failed due to an unknown error.
      • NotAuthorizedException The user is not authorized to perform this request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • PiException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAvailableResourceMetrics

      default CompletableFuture<ListAvailableResourceMetricsResponse> listAvailableResourceMetrics(Consumer<ListAvailableResourceMetricsRequest.Builder> listAvailableResourceMetricsRequest)

      Retrieve metrics of the specified types that can be queried for a specified DB instance.


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

      Parameters:
      listAvailableResourceMetricsRequest - A Consumer that will call methods on ListAvailableResourceMetricsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListAvailableResourceMetrics operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • InvalidArgumentException One of the arguments provided is invalid for this request.
      • InternalServiceErrorException The request failed due to an unknown error.
      • NotAuthorizedException The user is not authorized to perform this request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • PiException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAvailableResourceMetricsPaginator

      default ListAvailableResourceMetricsPublisher listAvailableResourceMetricsPaginator(ListAvailableResourceMetricsRequest listAvailableResourceMetricsRequest)

      Retrieve metrics of the specified types that can be queried for a specified DB instance.


      This is a variant of listAvailableResourceMetrics(software.amazon.awssdk.services.pi.model.ListAvailableResourceMetricsRequest) 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.pi.paginators.ListAvailableResourceMetricsPublisher publisher = client.listAvailableResourceMetricsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.pi.paginators.ListAvailableResourceMetricsPublisher publisher = client.listAvailableResourceMetricsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.pi.model.ListAvailableResourceMetricsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.pi.model.ListAvailableResourceMetricsResponse 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 listAvailableResourceMetrics(software.amazon.awssdk.services.pi.model.ListAvailableResourceMetricsRequest) operation.

      Parameters:
      listAvailableResourceMetricsRequest -
      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.
      • InvalidArgumentException One of the arguments provided is invalid for this request.
      • InternalServiceErrorException The request failed due to an unknown error.
      • NotAuthorizedException The user is not authorized to perform this request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • PiException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listAvailableResourceMetricsPaginator

      default ListAvailableResourceMetricsPublisher listAvailableResourceMetricsPaginator(Consumer<ListAvailableResourceMetricsRequest.Builder> listAvailableResourceMetricsRequest)

      Retrieve metrics of the specified types that can be queried for a specified DB instance.


      This is a variant of listAvailableResourceMetrics(software.amazon.awssdk.services.pi.model.ListAvailableResourceMetricsRequest) 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.pi.paginators.ListAvailableResourceMetricsPublisher publisher = client.listAvailableResourceMetricsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.pi.paginators.ListAvailableResourceMetricsPublisher publisher = client.listAvailableResourceMetricsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.pi.model.ListAvailableResourceMetricsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.pi.model.ListAvailableResourceMetricsResponse 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 listAvailableResourceMetrics(software.amazon.awssdk.services.pi.model.ListAvailableResourceMetricsRequest) operation.

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

      Parameters:
      listAvailableResourceMetricsRequest - A Consumer that will call methods on ListAvailableResourceMetricsRequest.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.
      • InvalidArgumentException One of the arguments provided is invalid for this request.
      • InternalServiceErrorException The request failed due to an unknown error.
      • NotAuthorizedException The user is not authorized to perform this request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • PiException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listPerformanceAnalysisReports

      default CompletableFuture<ListPerformanceAnalysisReportsResponse> listPerformanceAnalysisReports(ListPerformanceAnalysisReportsRequest listPerformanceAnalysisReportsRequest)

      Lists all the analysis reports created for the DB instance. The reports are sorted based on the start time of each report.

      Parameters:
      listPerformanceAnalysisReportsRequest -
      Returns:
      A Java Future containing the result of the ListPerformanceAnalysisReports operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • InvalidArgumentException One of the arguments provided is invalid for this request.
      • InternalServiceErrorException The request failed due to an unknown error.
      • NotAuthorizedException The user is not authorized to perform this request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • PiException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listPerformanceAnalysisReports

      default CompletableFuture<ListPerformanceAnalysisReportsResponse> listPerformanceAnalysisReports(Consumer<ListPerformanceAnalysisReportsRequest.Builder> listPerformanceAnalysisReportsRequest)

      Lists all the analysis reports created for the DB instance. The reports are sorted based on the start time of each report.


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

      Parameters:
      listPerformanceAnalysisReportsRequest - A Consumer that will call methods on ListPerformanceAnalysisReportsRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ListPerformanceAnalysisReports operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.
      • InvalidArgumentException One of the arguments provided is invalid for this request.
      • InternalServiceErrorException The request failed due to an unknown error.
      • NotAuthorizedException The user is not authorized to perform this request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • PiException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listPerformanceAnalysisReportsPaginator

      default ListPerformanceAnalysisReportsPublisher listPerformanceAnalysisReportsPaginator(ListPerformanceAnalysisReportsRequest listPerformanceAnalysisReportsRequest)

      Lists all the analysis reports created for the DB instance. The reports are sorted based on the start time of each report.


      This is a variant of listPerformanceAnalysisReports(software.amazon.awssdk.services.pi.model.ListPerformanceAnalysisReportsRequest) 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.pi.paginators.ListPerformanceAnalysisReportsPublisher publisher = client.listPerformanceAnalysisReportsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.pi.paginators.ListPerformanceAnalysisReportsPublisher publisher = client.listPerformanceAnalysisReportsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.pi.model.ListPerformanceAnalysisReportsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.pi.model.ListPerformanceAnalysisReportsResponse 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 listPerformanceAnalysisReports(software.amazon.awssdk.services.pi.model.ListPerformanceAnalysisReportsRequest) operation.

      Parameters:
      listPerformanceAnalysisReportsRequest -
      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.
      • InvalidArgumentException One of the arguments provided is invalid for this request.
      • InternalServiceErrorException The request failed due to an unknown error.
      • NotAuthorizedException The user is not authorized to perform this request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • PiException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • listPerformanceAnalysisReportsPaginator

      default ListPerformanceAnalysisReportsPublisher listPerformanceAnalysisReportsPaginator(Consumer<ListPerformanceAnalysisReportsRequest.Builder> listPerformanceAnalysisReportsRequest)

      Lists all the analysis reports created for the DB instance. The reports are sorted based on the start time of each report.


      This is a variant of listPerformanceAnalysisReports(software.amazon.awssdk.services.pi.model.ListPerformanceAnalysisReportsRequest) 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.pi.paginators.ListPerformanceAnalysisReportsPublisher publisher = client.listPerformanceAnalysisReportsPaginator(request);
 CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
 future.get();
      2) Using a custom subscriber 
       
 software.amazon.awssdk.services.pi.paginators.ListPerformanceAnalysisReportsPublisher publisher = client.listPerformanceAnalysisReportsPaginator(request);
 publisher.subscribe(new Subscriber<software.amazon.awssdk.services.pi.model.ListPerformanceAnalysisReportsResponse>() {
 
 public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
 
 
 public void onNext(software.amazon.awssdk.services.pi.model.ListPerformanceAnalysisReportsResponse 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 listPerformanceAnalysisReports(software.amazon.awssdk.services.pi.model.ListPerformanceAnalysisReportsRequest) operation.

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

      Parameters:
      listPerformanceAnalysisReportsRequest - A Consumer that will call methods on ListPerformanceAnalysisReportsRequest.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.
      • InvalidArgumentException One of the arguments provided is invalid for this request.
      • InternalServiceErrorException The request failed due to an unknown error.
      • NotAuthorizedException The user is not authorized to perform this request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • PiException 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)

      Retrieves all the metadata tags associated with Amazon RDS Performance Insights resource.

      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.
      • InvalidArgumentException One of the arguments provided is invalid for this request.
      • InternalServiceErrorException The request failed due to an unknown error.
      • NotAuthorizedException The user is not authorized to perform this request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • PiException 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)

      Retrieves all the metadata tags associated with Amazon RDS Performance Insights resource.


      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.
      • InvalidArgumentException One of the arguments provided is invalid for this request.
      • InternalServiceErrorException The request failed due to an unknown error.
      • NotAuthorizedException The user is not authorized to perform this request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • PiException 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)

      Adds metadata tags to the Amazon RDS Performance Insights resource.

      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.
      • InvalidArgumentException One of the arguments provided is invalid for this request.
      • InternalServiceErrorException The request failed due to an unknown error.
      • NotAuthorizedException The user is not authorized to perform this request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • PiException 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)

      Adds metadata tags to the Amazon RDS Performance Insights resource.


      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.
      • InvalidArgumentException One of the arguments provided is invalid for this request.
      • InternalServiceErrorException The request failed due to an unknown error.
      • NotAuthorizedException The user is not authorized to perform this request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • PiException 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)

      Deletes the metadata tags from the Amazon RDS Performance Insights resource.

      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.
      • InvalidArgumentException One of the arguments provided is invalid for this request.
      • InternalServiceErrorException The request failed due to an unknown error.
      • NotAuthorizedException The user is not authorized to perform this request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • PiException 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)

      Deletes the metadata tags from the Amazon RDS Performance Insights resource.


      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.
      • InvalidArgumentException One of the arguments provided is invalid for this request.
      • InternalServiceErrorException The request failed due to an unknown error.
      • NotAuthorizedException The user is not authorized to perform this request.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • PiException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • serviceClientConfiguration

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

    • builder

      static PiAsyncClientBuilder builder()
      Create a builder that can be used to configure and create a PiAsyncClient.