@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface PiAsyncClient extends SdkClient
builder() method.
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.
To learn more about Performance Insights and Amazon Aurora DB instances, go to the Amazon Aurora User Guide .
To learn more about Performance Insights and Amazon RDS DB instances, go to the Amazon RDS User Guide .
To learn more about Performance Insights and Amazon DocumentDB clusters, go to the Amazon DocumentDB Developer Guide .
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider. |
static String |
SERVICE_NAME |
| Modifier and Type | Method and Description |
|---|---|
static PiAsyncClientBuilder |
builder()
Create a builder that can be used to configure and create a
PiAsyncClient. |
static PiAsyncClient |
create()
Create a
PiAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default CompletableFuture<DescribeDimensionKeysResponse> |
describeDimensionKeys(Consumer<DescribeDimensionKeysRequest.Builder> describeDimensionKeysRequest)
For a specific time period, retrieve the top
N dimension keys for a metric. |
default CompletableFuture<DescribeDimensionKeysResponse> |
describeDimensionKeys(DescribeDimensionKeysRequest describeDimensionKeysRequest)
For a specific time period, retrieve the top
N dimension keys for a metric. |
default DescribeDimensionKeysPublisher |
describeDimensionKeysPaginator(Consumer<DescribeDimensionKeysRequest.Builder> describeDimensionKeysRequest)
For a specific time period, retrieve the top
N dimension keys for a metric. |
default DescribeDimensionKeysPublisher |
describeDimensionKeysPaginator(DescribeDimensionKeysRequest describeDimensionKeysRequest)
For a specific time period, retrieve the top
N dimension keys for a metric. |
default CompletableFuture<GetDimensionKeyDetailsResponse> |
getDimensionKeyDetails(Consumer<GetDimensionKeyDetailsRequest.Builder> getDimensionKeyDetailsRequest)
Get the attributes of the specified dimension group for a DB instance or data source.
|
default CompletableFuture<GetDimensionKeyDetailsResponse> |
getDimensionKeyDetails(GetDimensionKeyDetailsRequest getDimensionKeyDetailsRequest)
Get the attributes of the specified dimension group for a DB instance or data source.
|
default CompletableFuture<GetResourceMetadataResponse> |
getResourceMetadata(Consumer<GetResourceMetadataRequest.Builder> getResourceMetadataRequest)
Retrieve the metadata for different features.
|
default CompletableFuture<GetResourceMetadataResponse> |
getResourceMetadata(GetResourceMetadataRequest getResourceMetadataRequest)
Retrieve the metadata for different features.
|
default CompletableFuture<GetResourceMetricsResponse> |
getResourceMetrics(Consumer<GetResourceMetricsRequest.Builder> getResourceMetricsRequest)
Retrieve Performance Insights metrics for a set of data sources over a time period.
|
default CompletableFuture<GetResourceMetricsResponse> |
getResourceMetrics(GetResourceMetricsRequest getResourceMetricsRequest)
Retrieve Performance Insights metrics for a set of data sources over a time period.
|
default GetResourceMetricsPublisher |
getResourceMetricsPaginator(Consumer<GetResourceMetricsRequest.Builder> getResourceMetricsRequest)
Retrieve Performance Insights metrics for a set of data sources over a time period.
|
default GetResourceMetricsPublisher |
getResourceMetricsPaginator(GetResourceMetricsRequest getResourceMetricsRequest)
Retrieve Performance Insights metrics for a set of data sources over a time period.
|
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.
|
default CompletableFuture<ListAvailableResourceDimensionsResponse> |
listAvailableResourceDimensions(ListAvailableResourceDimensionsRequest listAvailableResourceDimensionsRequest)
Retrieve the dimensions that can be queried for each specified metric type on a specified DB instance.
|
default ListAvailableResourceDimensionsPublisher |
listAvailableResourceDimensionsPaginator(Consumer<ListAvailableResourceDimensionsRequest.Builder> listAvailableResourceDimensionsRequest)
Retrieve the dimensions that can be queried for each specified metric type on a specified DB instance.
|
default ListAvailableResourceDimensionsPublisher |
listAvailableResourceDimensionsPaginator(ListAvailableResourceDimensionsRequest listAvailableResourceDimensionsRequest)
Retrieve the dimensions that can be queried for each specified metric type on a specified DB instance.
|
default CompletableFuture<ListAvailableResourceMetricsResponse> |
listAvailableResourceMetrics(Consumer<ListAvailableResourceMetricsRequest.Builder> listAvailableResourceMetricsRequest)
Retrieve metrics of the specified types that can be queried for a specified DB instance.
|
default CompletableFuture<ListAvailableResourceMetricsResponse> |
listAvailableResourceMetrics(ListAvailableResourceMetricsRequest listAvailableResourceMetricsRequest)
Retrieve metrics of the specified types that can be queried for a specified DB instance.
|
default ListAvailableResourceMetricsPublisher |
listAvailableResourceMetricsPaginator(Consumer<ListAvailableResourceMetricsRequest.Builder> listAvailableResourceMetricsRequest)
Retrieve metrics of the specified types that can be queried for a specified DB instance.
|
default ListAvailableResourceMetricsPublisher |
listAvailableResourceMetricsPaginator(ListAvailableResourceMetricsRequest listAvailableResourceMetricsRequest)
Retrieve metrics of the specified types that can be queried for a specified DB instance.
|
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.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.
describeDimensionKeysRequest - 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()
describeDimensionKeysRequest - A Consumer that will call methods on DescribeDimensionKeysRequest.Builder to create a
request.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.
describeDimensionKeysRequest - 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()
describeDimensionKeysRequest - A Consumer that will call methods on DescribeDimensionKeysRequest.Builder to create a
request.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.
getDimensionKeyDetailsRequest - 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()
getDimensionKeyDetailsRequest - A Consumer that will call methods on GetDimensionKeyDetailsRequest.Builder to create a
request.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.
getResourceMetadataRequest - 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()
getResourceMetadataRequest - A Consumer that will call methods on GetResourceMetadataRequest.Builder to create a
request.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.
getResourceMetricsRequest - 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()
getResourceMetricsRequest - A Consumer that will call methods on GetResourceMetricsRequest.Builder to create a
request.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.
getResourceMetricsRequest - 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()
getResourceMetricsRequest - A Consumer that will call methods on GetResourceMetricsRequest.Builder to create a
request.default CompletableFuture<ListAvailableResourceDimensionsResponse> listAvailableResourceDimensions(ListAvailableResourceDimensionsRequest listAvailableResourceDimensionsRequest)
Retrieve the dimensions that can be queried for each specified metric type on a specified DB instance.
listAvailableResourceDimensionsRequest - 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()
listAvailableResourceDimensionsRequest - A Consumer that will call methods on ListAvailableResourceDimensionsRequest.Builder to
create a request.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.
listAvailableResourceDimensionsRequest - 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()
listAvailableResourceDimensionsRequest - A Consumer that will call methods on ListAvailableResourceDimensionsRequest.Builder to
create a request.default CompletableFuture<ListAvailableResourceMetricsResponse> listAvailableResourceMetrics(ListAvailableResourceMetricsRequest listAvailableResourceMetricsRequest)
Retrieve metrics of the specified types that can be queried for a specified DB instance.
listAvailableResourceMetricsRequest - 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()
listAvailableResourceMetricsRequest - A Consumer that will call methods on ListAvailableResourceMetricsRequest.Builder to create
a request.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.
listAvailableResourceMetricsRequest - 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()
listAvailableResourceMetricsRequest - A Consumer that will call methods on ListAvailableResourceMetricsRequest.Builder to create
a request.static PiAsyncClient create()
PiAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static PiAsyncClientBuilder builder()
PiAsyncClient.Copyright © 2023. All rights reserved.