Interface TimestreamInfluxDbAsyncClient
-
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface TimestreamInfluxDbAsyncClient extends AwsClient
Service client for accessing Timestream InfluxDB asynchronously. This can be created using the staticbuilder()method.The asynchronous client performs non-blocking I/O when configured with anySdkAsyncHttpClientsupported in the SDK. However, full non-blocking is not guaranteed as the async client may perform blocking calls in some cases such as credentials retrieval and endpoint discovery as part of the async API call.Amazon Timestream for InfluxDB is a managed time-series database engine that makes it easy for application developers and DevOps teams to run InfluxDB databases on AWS for near real-time time-series applications using open-source APIs. With Amazon Timestream for InfluxDB, it is easy to set up, operate, and scale time-series workloads that can answer queries with single-digit millisecond query response time.
-
-
Field Summary
Fields Modifier and Type Field Description static StringSERVICE_METADATA_IDValue for looking up the service's metadata from theServiceMetadataProvider.static StringSERVICE_NAME
-
Method Summary
-
Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
-
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
-
-
-
Field Detail
-
SERVICE_NAME
static final String SERVICE_NAME
- See Also:
- Constant Field Values
-
SERVICE_METADATA_ID
static final String SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider.- See Also:
- Constant Field Values
-
-
Method Detail
-
createDbInstance
default CompletableFuture<CreateDbInstanceResponse> createDbInstance(CreateDbInstanceRequest createDbInstanceRequest)
Creates a new Timestream for InfluxDB DB instance.
- Parameters:
createDbInstanceRequest-- Returns:
- A Java Future containing the result of the CreateDbInstance operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ServiceQuotaExceededException The request exceeds the service quota.
- ValidationException The input fails to satisfy the constraints specified by Timestream for InfluxDB.
- AccessDeniedException You do not have sufficient access to perform this action.
- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ConflictException The request conflicts with an existing resource in Timestream for InfluxDB.
- ResourceNotFoundException The requested resource was not found or does not exist.
- ThrottlingException The request was denied due to request throttling.
- 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.
- TimestreamInfluxDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
createDbInstance
default CompletableFuture<CreateDbInstanceResponse> createDbInstance(Consumer<CreateDbInstanceRequest.Builder> createDbInstanceRequest)
Creates a new Timestream for InfluxDB DB instance.
This is a convenience which creates an instance of the
CreateDbInstanceRequest.Builderavoiding the need to create one manually viaCreateDbInstanceRequest.builder()- Parameters:
createDbInstanceRequest- AConsumerthat will call methods onCreateDbInstanceRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the CreateDbInstance operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ServiceQuotaExceededException The request exceeds the service quota.
- ValidationException The input fails to satisfy the constraints specified by Timestream for InfluxDB.
- AccessDeniedException You do not have sufficient access to perform this action.
- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ConflictException The request conflicts with an existing resource in Timestream for InfluxDB.
- ResourceNotFoundException The requested resource was not found or does not exist.
- ThrottlingException The request was denied due to request throttling.
- 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.
- TimestreamInfluxDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
createDbParameterGroup
default CompletableFuture<CreateDbParameterGroupResponse> createDbParameterGroup(CreateDbParameterGroupRequest createDbParameterGroupRequest)
Creates a new Timestream for InfluxDB DB parameter group to associate with DB instances.
- Parameters:
createDbParameterGroupRequest-- Returns:
- A Java Future containing the result of the CreateDbParameterGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ServiceQuotaExceededException The request exceeds the service quota.
- ValidationException The input fails to satisfy the constraints specified by Timestream for InfluxDB.
- AccessDeniedException You do not have sufficient access to perform this action.
- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ConflictException The request conflicts with an existing resource in Timestream for InfluxDB.
- ResourceNotFoundException The requested resource was not found or does not exist.
- ThrottlingException The request was denied due to request throttling.
- 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.
- TimestreamInfluxDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
createDbParameterGroup
default CompletableFuture<CreateDbParameterGroupResponse> createDbParameterGroup(Consumer<CreateDbParameterGroupRequest.Builder> createDbParameterGroupRequest)
Creates a new Timestream for InfluxDB DB parameter group to associate with DB instances.
This is a convenience which creates an instance of the
CreateDbParameterGroupRequest.Builderavoiding the need to create one manually viaCreateDbParameterGroupRequest.builder()- Parameters:
createDbParameterGroupRequest- AConsumerthat will call methods onCreateDbParameterGroupRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the CreateDbParameterGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ServiceQuotaExceededException The request exceeds the service quota.
- ValidationException The input fails to satisfy the constraints specified by Timestream for InfluxDB.
- AccessDeniedException You do not have sufficient access to perform this action.
- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ConflictException The request conflicts with an existing resource in Timestream for InfluxDB.
- ResourceNotFoundException The requested resource was not found or does not exist.
- ThrottlingException The request was denied due to request throttling.
- 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.
- TimestreamInfluxDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
deleteDbInstance
default CompletableFuture<DeleteDbInstanceResponse> deleteDbInstance(DeleteDbInstanceRequest deleteDbInstanceRequest)
Deletes a Timestream for InfluxDB DB instance.
- Parameters:
deleteDbInstanceRequest-- Returns:
- A Java Future containing the result of the DeleteDbInstance operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ValidationException The input fails to satisfy the constraints specified by Timestream for InfluxDB.
- AccessDeniedException You do not have sufficient access to perform this action.
- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ConflictException The request conflicts with an existing resource in Timestream for InfluxDB.
- ResourceNotFoundException The requested resource was not found or does not exist.
- ThrottlingException The request was denied due to request throttling.
- 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.
- TimestreamInfluxDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
deleteDbInstance
default CompletableFuture<DeleteDbInstanceResponse> deleteDbInstance(Consumer<DeleteDbInstanceRequest.Builder> deleteDbInstanceRequest)
Deletes a Timestream for InfluxDB DB instance.
This is a convenience which creates an instance of the
DeleteDbInstanceRequest.Builderavoiding the need to create one manually viaDeleteDbInstanceRequest.builder()- Parameters:
deleteDbInstanceRequest- AConsumerthat will call methods onDeleteDbInstanceRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeleteDbInstance operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ValidationException The input fails to satisfy the constraints specified by Timestream for InfluxDB.
- AccessDeniedException You do not have sufficient access to perform this action.
- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ConflictException The request conflicts with an existing resource in Timestream for InfluxDB.
- ResourceNotFoundException The requested resource was not found or does not exist.
- ThrottlingException The request was denied due to request throttling.
- 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.
- TimestreamInfluxDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
getDbInstance
default CompletableFuture<GetDbInstanceResponse> getDbInstance(GetDbInstanceRequest getDbInstanceRequest)
Returns a Timestream for InfluxDB DB instance.
- Parameters:
getDbInstanceRequest-- Returns:
- A Java Future containing the result of the GetDbInstance operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ValidationException The input fails to satisfy the constraints specified by Timestream for InfluxDB.
- AccessDeniedException You do not have sufficient access to perform this action.
- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ResourceNotFoundException The requested resource was not found or does not exist.
- ThrottlingException The request was denied due to request throttling.
- 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.
- TimestreamInfluxDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
getDbInstance
default CompletableFuture<GetDbInstanceResponse> getDbInstance(Consumer<GetDbInstanceRequest.Builder> getDbInstanceRequest)
Returns a Timestream for InfluxDB DB instance.
This is a convenience which creates an instance of the
GetDbInstanceRequest.Builderavoiding the need to create one manually viaGetDbInstanceRequest.builder()- Parameters:
getDbInstanceRequest- AConsumerthat will call methods onGetDbInstanceRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetDbInstance operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ValidationException The input fails to satisfy the constraints specified by Timestream for InfluxDB.
- AccessDeniedException You do not have sufficient access to perform this action.
- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ResourceNotFoundException The requested resource was not found or does not exist.
- ThrottlingException The request was denied due to request throttling.
- 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.
- TimestreamInfluxDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
getDbParameterGroup
default CompletableFuture<GetDbParameterGroupResponse> getDbParameterGroup(GetDbParameterGroupRequest getDbParameterGroupRequest)
Returns a Timestream for InfluxDB DB parameter group.
- Parameters:
getDbParameterGroupRequest-- Returns:
- A Java Future containing the result of the GetDbParameterGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ValidationException The input fails to satisfy the constraints specified by Timestream for InfluxDB.
- AccessDeniedException You do not have sufficient access to perform this action.
- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ResourceNotFoundException The requested resource was not found or does not exist.
- ThrottlingException The request was denied due to request throttling.
- 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.
- TimestreamInfluxDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
getDbParameterGroup
default CompletableFuture<GetDbParameterGroupResponse> getDbParameterGroup(Consumer<GetDbParameterGroupRequest.Builder> getDbParameterGroupRequest)
Returns a Timestream for InfluxDB DB parameter group.
This is a convenience which creates an instance of the
GetDbParameterGroupRequest.Builderavoiding the need to create one manually viaGetDbParameterGroupRequest.builder()- Parameters:
getDbParameterGroupRequest- AConsumerthat will call methods onGetDbParameterGroupRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetDbParameterGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ValidationException The input fails to satisfy the constraints specified by Timestream for InfluxDB.
- AccessDeniedException You do not have sufficient access to perform this action.
- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ResourceNotFoundException The requested resource was not found or does not exist.
- ThrottlingException The request was denied due to request throttling.
- 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.
- TimestreamInfluxDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listDbInstances
default CompletableFuture<ListDbInstancesResponse> listDbInstances(ListDbInstancesRequest listDbInstancesRequest)
Returns a list of Timestream for InfluxDB DB instances.
- Parameters:
listDbInstancesRequest-- Returns:
- A Java Future containing the result of the ListDbInstances operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ValidationException The input fails to satisfy the constraints specified by Timestream for InfluxDB.
- AccessDeniedException You do not have sufficient access to perform this action.
- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ResourceNotFoundException The requested resource was not found or does not exist.
- ThrottlingException The request was denied due to request throttling.
- 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.
- TimestreamInfluxDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listDbInstances
default CompletableFuture<ListDbInstancesResponse> listDbInstances(Consumer<ListDbInstancesRequest.Builder> listDbInstancesRequest)
Returns a list of Timestream for InfluxDB DB instances.
This is a convenience which creates an instance of the
ListDbInstancesRequest.Builderavoiding the need to create one manually viaListDbInstancesRequest.builder()- Parameters:
listDbInstancesRequest- AConsumerthat will call methods onListDbInstancesRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListDbInstances operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ValidationException The input fails to satisfy the constraints specified by Timestream for InfluxDB.
- AccessDeniedException You do not have sufficient access to perform this action.
- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ResourceNotFoundException The requested resource was not found or does not exist.
- ThrottlingException The request was denied due to request throttling.
- 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.
- TimestreamInfluxDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listDbInstancesPaginator
default ListDbInstancesPublisher listDbInstancesPaginator(ListDbInstancesRequest listDbInstancesRequest)
This is a variant of
listDbInstances(software.amazon.awssdk.services.timestreaminfluxdb.model.ListDbInstancesRequest)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 newSubscriptioni.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
2) Using a custom subscribersoftware.amazon.awssdk.services.timestreaminfluxdb.paginators.ListDbInstancesPublisher publisher = client.listDbInstancesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.timestreaminfluxdb.paginators.ListDbInstancesPublisher publisher = client.listDbInstancesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.timestreaminfluxdb.model.ListDbInstancesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.timestreaminfluxdb.model.ListDbInstancesResponse response) { //... }; });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
listDbInstances(software.amazon.awssdk.services.timestreaminfluxdb.model.ListDbInstancesRequest)operation.- Parameters:
listDbInstancesRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ValidationException The input fails to satisfy the constraints specified by Timestream for InfluxDB.
- AccessDeniedException You do not have sufficient access to perform this action.
- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ResourceNotFoundException The requested resource was not found or does not exist.
- ThrottlingException The request was denied due to request throttling.
- 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.
- TimestreamInfluxDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listDbInstancesPaginator
default ListDbInstancesPublisher listDbInstancesPaginator(Consumer<ListDbInstancesRequest.Builder> listDbInstancesRequest)
This is a variant of
listDbInstances(software.amazon.awssdk.services.timestreaminfluxdb.model.ListDbInstancesRequest)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 newSubscriptioni.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
2) Using a custom subscribersoftware.amazon.awssdk.services.timestreaminfluxdb.paginators.ListDbInstancesPublisher publisher = client.listDbInstancesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.timestreaminfluxdb.paginators.ListDbInstancesPublisher publisher = client.listDbInstancesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.timestreaminfluxdb.model.ListDbInstancesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.timestreaminfluxdb.model.ListDbInstancesResponse response) { //... }; });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
listDbInstances(software.amazon.awssdk.services.timestreaminfluxdb.model.ListDbInstancesRequest)operation.
This is a convenience which creates an instance of the
ListDbInstancesRequest.Builderavoiding the need to create one manually viaListDbInstancesRequest.builder()- Parameters:
listDbInstancesRequest- AConsumerthat will call methods onListDbInstancesRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ValidationException The input fails to satisfy the constraints specified by Timestream for InfluxDB.
- AccessDeniedException You do not have sufficient access to perform this action.
- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ResourceNotFoundException The requested resource was not found or does not exist.
- ThrottlingException The request was denied due to request throttling.
- 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.
- TimestreamInfluxDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listDbParameterGroups
default CompletableFuture<ListDbParameterGroupsResponse> listDbParameterGroups(ListDbParameterGroupsRequest listDbParameterGroupsRequest)
Returns a list of Timestream for InfluxDB DB parameter groups.
- Parameters:
listDbParameterGroupsRequest-- Returns:
- A Java Future containing the result of the ListDbParameterGroups operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ValidationException The input fails to satisfy the constraints specified by Timestream for InfluxDB.
- AccessDeniedException You do not have sufficient access to perform this action.
- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ResourceNotFoundException The requested resource was not found or does not exist.
- ThrottlingException The request was denied due to request throttling.
- 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.
- TimestreamInfluxDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listDbParameterGroups
default CompletableFuture<ListDbParameterGroupsResponse> listDbParameterGroups(Consumer<ListDbParameterGroupsRequest.Builder> listDbParameterGroupsRequest)
Returns a list of Timestream for InfluxDB DB parameter groups.
This is a convenience which creates an instance of the
ListDbParameterGroupsRequest.Builderavoiding the need to create one manually viaListDbParameterGroupsRequest.builder()- Parameters:
listDbParameterGroupsRequest- AConsumerthat will call methods onListDbParameterGroupsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListDbParameterGroups operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ValidationException The input fails to satisfy the constraints specified by Timestream for InfluxDB.
- AccessDeniedException You do not have sufficient access to perform this action.
- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ResourceNotFoundException The requested resource was not found or does not exist.
- ThrottlingException The request was denied due to request throttling.
- 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.
- TimestreamInfluxDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listDbParameterGroupsPaginator
default ListDbParameterGroupsPublisher listDbParameterGroupsPaginator(ListDbParameterGroupsRequest listDbParameterGroupsRequest)
This is a variant of
listDbParameterGroups(software.amazon.awssdk.services.timestreaminfluxdb.model.ListDbParameterGroupsRequest)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 newSubscriptioni.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
2) Using a custom subscribersoftware.amazon.awssdk.services.timestreaminfluxdb.paginators.ListDbParameterGroupsPublisher publisher = client.listDbParameterGroupsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.timestreaminfluxdb.paginators.ListDbParameterGroupsPublisher publisher = client.listDbParameterGroupsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.timestreaminfluxdb.model.ListDbParameterGroupsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.timestreaminfluxdb.model.ListDbParameterGroupsResponse response) { //... }; });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
listDbParameterGroups(software.amazon.awssdk.services.timestreaminfluxdb.model.ListDbParameterGroupsRequest)operation.- Parameters:
listDbParameterGroupsRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ValidationException The input fails to satisfy the constraints specified by Timestream for InfluxDB.
- AccessDeniedException You do not have sufficient access to perform this action.
- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ResourceNotFoundException The requested resource was not found or does not exist.
- ThrottlingException The request was denied due to request throttling.
- 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.
- TimestreamInfluxDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listDbParameterGroupsPaginator
default ListDbParameterGroupsPublisher listDbParameterGroupsPaginator(Consumer<ListDbParameterGroupsRequest.Builder> listDbParameterGroupsRequest)
This is a variant of
listDbParameterGroups(software.amazon.awssdk.services.timestreaminfluxdb.model.ListDbParameterGroupsRequest)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 newSubscriptioni.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
2) Using a custom subscribersoftware.amazon.awssdk.services.timestreaminfluxdb.paginators.ListDbParameterGroupsPublisher publisher = client.listDbParameterGroupsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.timestreaminfluxdb.paginators.ListDbParameterGroupsPublisher publisher = client.listDbParameterGroupsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.timestreaminfluxdb.model.ListDbParameterGroupsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.timestreaminfluxdb.model.ListDbParameterGroupsResponse response) { //... }; });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
listDbParameterGroups(software.amazon.awssdk.services.timestreaminfluxdb.model.ListDbParameterGroupsRequest)operation.
This is a convenience which creates an instance of the
ListDbParameterGroupsRequest.Builderavoiding the need to create one manually viaListDbParameterGroupsRequest.builder()- Parameters:
listDbParameterGroupsRequest- AConsumerthat will call methods onListDbParameterGroupsRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ValidationException The input fails to satisfy the constraints specified by Timestream for InfluxDB.
- AccessDeniedException You do not have sufficient access to perform this action.
- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ResourceNotFoundException The requested resource was not found or does not exist.
- ThrottlingException The request was denied due to request throttling.
- 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.
- TimestreamInfluxDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
A list of tags applied to the 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The requested resource was not found or does not exist.
- 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.
- TimestreamInfluxDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
A list of tags applied to the resource.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builderavoiding the need to create one manually viaListTagsForResourceRequest.builder()- Parameters:
listTagsForResourceRequest- AConsumerthat will call methods onListTagsForResourceRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The requested resource was not found or does not exist.
- 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.
- TimestreamInfluxDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
tagResource
default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest)
Tags are composed of a Key/Value pairs. You can use tags to categorize and track your Timestream for InfluxDB resources.
- Parameters:
tagResourceRequest-- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The requested resource was not found or does not exist.
- 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.
- TimestreamInfluxDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
tagResource
default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Tags are composed of a Key/Value pairs. You can use tags to categorize and track your Timestream for InfluxDB resources.
This is a convenience which creates an instance of the
TagResourceRequest.Builderavoiding the need to create one manually viaTagResourceRequest.builder()- Parameters:
tagResourceRequest- AConsumerthat will call methods onTagResourceRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The requested resource was not found or does not exist.
- 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.
- TimestreamInfluxDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest)
Removes the tag from the specified 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. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The requested resource was not found or does not exist.
- 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.
- TimestreamInfluxDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Removes the tag from the specified resource.
This is a convenience which creates an instance of the
UntagResourceRequest.Builderavoiding the need to create one manually viaUntagResourceRequest.builder()- Parameters:
untagResourceRequest- AConsumerthat will call methods onUntagResourceRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException The requested resource was not found or does not exist.
- 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.
- TimestreamInfluxDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
updateDbInstance
default CompletableFuture<UpdateDbInstanceResponse> updateDbInstance(UpdateDbInstanceRequest updateDbInstanceRequest)
Updates a Timestream for InfluxDB DB instance.
- Parameters:
updateDbInstanceRequest-- Returns:
- A Java Future containing the result of the UpdateDbInstance operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ValidationException The input fails to satisfy the constraints specified by Timestream for InfluxDB.
- AccessDeniedException You do not have sufficient access to perform this action.
- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ConflictException The request conflicts with an existing resource in Timestream for InfluxDB.
- ResourceNotFoundException The requested resource was not found or does not exist.
- ThrottlingException The request was denied due to request throttling.
- 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.
- TimestreamInfluxDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
updateDbInstance
default CompletableFuture<UpdateDbInstanceResponse> updateDbInstance(Consumer<UpdateDbInstanceRequest.Builder> updateDbInstanceRequest)
Updates a Timestream for InfluxDB DB instance.
This is a convenience which creates an instance of the
UpdateDbInstanceRequest.Builderavoiding the need to create one manually viaUpdateDbInstanceRequest.builder()- Parameters:
updateDbInstanceRequest- AConsumerthat will call methods onUpdateDbInstanceRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UpdateDbInstance operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ValidationException The input fails to satisfy the constraints specified by Timestream for InfluxDB.
- AccessDeniedException You do not have sufficient access to perform this action.
- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ConflictException The request conflicts with an existing resource in Timestream for InfluxDB.
- ResourceNotFoundException The requested resource was not found or does not exist.
- ThrottlingException The request was denied due to request throttling.
- 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.
- TimestreamInfluxDbException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
- AWS API Documentation
-
serviceClientConfiguration
default TimestreamInfluxDbServiceClientConfiguration serviceClientConfiguration()
- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient
-
create
static TimestreamInfluxDbAsyncClient create()
Create aTimestreamInfluxDbAsyncClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.
-
builder
static TimestreamInfluxDbAsyncClientBuilder builder()
Create a builder that can be used to configure and create aTimestreamInfluxDbAsyncClient.
-
-