@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface KeyspacesAsyncClient extends SdkClient
builder()
method.
Amazon Keyspaces (for Apache Cassandra) is a scalable, highly available, and managed Apache Cassandra-compatible database service. Amazon Keyspaces makes it easy to migrate, run, and scale Cassandra workloads in the Amazon Web Services Cloud. With just a few clicks on the Amazon Web Services Management Console or a few lines of code, you can create keyspaces and tables in Amazon Keyspaces, without deploying any infrastructure or installing software.
In addition to supporting Cassandra Query Language (CQL) requests via open-source Cassandra drivers, Amazon Keyspaces supports data definition language (DDL) operations to manage keyspaces and tables using the Amazon Web Services SDK and CLI. This API reference describes the supported DDL operations in detail.
For the list of all supported CQL APIs, see Supported Cassandra APIs, operations, and data types in Amazon Keyspaces in the Amazon Keyspaces Developer Guide.
To learn how Amazon Keyspaces API actions are recorded with CloudTrail, see Amazon Keyspaces information in CloudTrail in the Amazon Keyspaces Developer Guide.
For more information about Amazon Web Services APIs, for example how to implement retry logic or how to sign Amazon Web Services API requests, see Amazon Web Services APIs in the General Reference.
| 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 KeyspacesAsyncClientBuilder |
builder()
Create a builder that can be used to configure and create a
KeyspacesAsyncClient. |
static KeyspacesAsyncClient |
create()
Create a
KeyspacesAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default CompletableFuture<CreateKeyspaceResponse> |
createKeyspace(Consumer<CreateKeyspaceRequest.Builder> createKeyspaceRequest)
The
CreateKeyspace operation adds a new keyspace to your account. |
default CompletableFuture<CreateKeyspaceResponse> |
createKeyspace(CreateKeyspaceRequest createKeyspaceRequest)
The
CreateKeyspace operation adds a new keyspace to your account. |
default CompletableFuture<CreateTableResponse> |
createTable(Consumer<CreateTableRequest.Builder> createTableRequest)
The
CreateTable operation adds a new table to the specified keyspace. |
default CompletableFuture<CreateTableResponse> |
createTable(CreateTableRequest createTableRequest)
The
CreateTable operation adds a new table to the specified keyspace. |
default CompletableFuture<DeleteKeyspaceResponse> |
deleteKeyspace(Consumer<DeleteKeyspaceRequest.Builder> deleteKeyspaceRequest)
The
DeleteKeyspace operation deletes a keyspace and all of its tables. |
default CompletableFuture<DeleteKeyspaceResponse> |
deleteKeyspace(DeleteKeyspaceRequest deleteKeyspaceRequest)
The
DeleteKeyspace operation deletes a keyspace and all of its tables. |
default CompletableFuture<DeleteTableResponse> |
deleteTable(Consumer<DeleteTableRequest.Builder> deleteTableRequest)
The
DeleteTable operation deletes a table and all of its data. |
default CompletableFuture<DeleteTableResponse> |
deleteTable(DeleteTableRequest deleteTableRequest)
The
DeleteTable operation deletes a table and all of its data. |
default CompletableFuture<GetKeyspaceResponse> |
getKeyspace(Consumer<GetKeyspaceRequest.Builder> getKeyspaceRequest)
Returns the name and the Amazon Resource Name (ARN) of the specified table.
|
default CompletableFuture<GetKeyspaceResponse> |
getKeyspace(GetKeyspaceRequest getKeyspaceRequest)
Returns the name and the Amazon Resource Name (ARN) of the specified table.
|
default CompletableFuture<GetTableResponse> |
getTable(Consumer<GetTableRequest.Builder> getTableRequest)
Returns information about the table, including the table's name and current status, the keyspace name,
configuration settings, and metadata.
|
default CompletableFuture<GetTableResponse> |
getTable(GetTableRequest getTableRequest)
Returns information about the table, including the table's name and current status, the keyspace name,
configuration settings, and metadata.
|
default CompletableFuture<ListKeyspacesResponse> |
listKeyspaces(Consumer<ListKeyspacesRequest.Builder> listKeyspacesRequest)
Returns a list of keyspaces.
|
default CompletableFuture<ListKeyspacesResponse> |
listKeyspaces(ListKeyspacesRequest listKeyspacesRequest)
Returns a list of keyspaces.
|
default ListKeyspacesPublisher |
listKeyspacesPaginator(Consumer<ListKeyspacesRequest.Builder> listKeyspacesRequest)
Returns a list of keyspaces.
|
default ListKeyspacesPublisher |
listKeyspacesPaginator(ListKeyspacesRequest listKeyspacesRequest)
Returns a list of keyspaces.
|
default CompletableFuture<ListTablesResponse> |
listTables(Consumer<ListTablesRequest.Builder> listTablesRequest)
Returns a list of tables for a specified keyspace.
|
default CompletableFuture<ListTablesResponse> |
listTables(ListTablesRequest listTablesRequest)
Returns a list of tables for a specified keyspace.
|
default ListTablesPublisher |
listTablesPaginator(Consumer<ListTablesRequest.Builder> listTablesRequest)
Returns a list of tables for a specified keyspace.
|
default ListTablesPublisher |
listTablesPaginator(ListTablesRequest listTablesRequest)
Returns a list of tables for a specified keyspace.
|
default CompletableFuture<ListTagsForResourceResponse> |
listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Returns a list of all tags associated with the specified Amazon Keyspaces resource.
|
default CompletableFuture<ListTagsForResourceResponse> |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Returns a list of all tags associated with the specified Amazon Keyspaces resource.
|
default ListTagsForResourcePublisher |
listTagsForResourcePaginator(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Returns a list of all tags associated with the specified Amazon Keyspaces resource.
|
default ListTagsForResourcePublisher |
listTagsForResourcePaginator(ListTagsForResourceRequest listTagsForResourceRequest)
Returns a list of all tags associated with the specified Amazon Keyspaces resource.
|
default CompletableFuture<RestoreTableResponse> |
restoreTable(Consumer<RestoreTableRequest.Builder> restoreTableRequest)
Restores the specified table to the specified point in time within the
earliest_restorable_timestamp
and the current time. |
default CompletableFuture<RestoreTableResponse> |
restoreTable(RestoreTableRequest restoreTableRequest)
Restores the specified table to the specified point in time within the
earliest_restorable_timestamp
and the current time. |
default CompletableFuture<TagResourceResponse> |
tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Associates a set of tags with a Amazon Keyspaces resource.
|
default CompletableFuture<TagResourceResponse> |
tagResource(TagResourceRequest tagResourceRequest)
Associates a set of tags with a Amazon Keyspaces resource.
|
default CompletableFuture<UntagResourceResponse> |
untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Removes the association of tags from a Amazon Keyspaces resource.
|
default CompletableFuture<UntagResourceResponse> |
untagResource(UntagResourceRequest untagResourceRequest)
Removes the association of tags from a Amazon Keyspaces resource.
|
default CompletableFuture<UpdateTableResponse> |
updateTable(Consumer<UpdateTableRequest.Builder> updateTableRequest)
Adds new columns to the table or updates one of the table's settings, for example capacity mode, encryption,
point-in-time recovery, or ttl settings.
|
default CompletableFuture<UpdateTableResponse> |
updateTable(UpdateTableRequest updateTableRequest)
Adds new columns to the table or updates one of the table's settings, for example capacity mode, encryption,
point-in-time recovery, or ttl settings.
|
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.static KeyspacesAsyncClient create()
KeyspacesAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static KeyspacesAsyncClientBuilder builder()
KeyspacesAsyncClient.default CompletableFuture<CreateKeyspaceResponse> createKeyspace(CreateKeyspaceRequest createKeyspaceRequest)
The CreateKeyspace operation adds a new keyspace to your account. In an Amazon Web Services account,
keyspace names must be unique within each Region.
CreateKeyspace is an asynchronous operation. You can monitor the creation status of the new keyspace
by using the GetKeyspace operation.
For more information, see Creating keyspaces in the Amazon Keyspaces Developer Guide.
createKeyspaceRequest - default CompletableFuture<CreateKeyspaceResponse> createKeyspace(Consumer<CreateKeyspaceRequest.Builder> createKeyspaceRequest)
The CreateKeyspace operation adds a new keyspace to your account. In an Amazon Web Services account,
keyspace names must be unique within each Region.
CreateKeyspace is an asynchronous operation. You can monitor the creation status of the new keyspace
by using the GetKeyspace operation.
For more information, see Creating keyspaces in the Amazon Keyspaces Developer Guide.
This is a convenience which creates an instance of the CreateKeyspaceRequest.Builder avoiding the need to
create one manually via CreateKeyspaceRequest.builder()
createKeyspaceRequest - A Consumer that will call methods on CreateKeyspaceRequest.Builder to create a request.default CompletableFuture<CreateTableResponse> createTable(CreateTableRequest createTableRequest)
The CreateTable operation adds a new table to the specified keyspace. Within a keyspace, table names
must be unique.
CreateTable is an asynchronous operation. When the request is received, the status of the table is
set to CREATING. You can monitor the creation status of the new table by using the
GetTable operation, which returns the current status of the table. You can start using
a table when the status is ACTIVE.
For more information, see Creating tables in the Amazon Keyspaces Developer Guide.
createTableRequest - ACTIVE.default CompletableFuture<CreateTableResponse> createTable(Consumer<CreateTableRequest.Builder> createTableRequest)
The CreateTable operation adds a new table to the specified keyspace. Within a keyspace, table names
must be unique.
CreateTable is an asynchronous operation. When the request is received, the status of the table is
set to CREATING. You can monitor the creation status of the new table by using the
GetTable operation, which returns the current status of the table. You can start using
a table when the status is ACTIVE.
For more information, see Creating tables in the Amazon Keyspaces Developer Guide.
This is a convenience which creates an instance of the CreateTableRequest.Builder avoiding the need to
create one manually via CreateTableRequest.builder()
createTableRequest - A Consumer that will call methods on CreateTableRequest.Builder to create a request.ACTIVE.default CompletableFuture<DeleteKeyspaceResponse> deleteKeyspace(DeleteKeyspaceRequest deleteKeyspaceRequest)
The DeleteKeyspace operation deletes a keyspace and all of its tables.
deleteKeyspaceRequest - ACTIVE.default CompletableFuture<DeleteKeyspaceResponse> deleteKeyspace(Consumer<DeleteKeyspaceRequest.Builder> deleteKeyspaceRequest)
The DeleteKeyspace operation deletes a keyspace and all of its tables.
This is a convenience which creates an instance of the DeleteKeyspaceRequest.Builder avoiding the need to
create one manually via DeleteKeyspaceRequest.builder()
deleteKeyspaceRequest - A Consumer that will call methods on DeleteKeyspaceRequest.Builder to create a request.ACTIVE.default CompletableFuture<DeleteTableResponse> deleteTable(DeleteTableRequest deleteTableRequest)
The DeleteTable operation deletes a table and all of its data. After a DeleteTable
request is received, the specified table is in the DELETING state until Amazon Keyspaces completes
the deletion. If the table is in the ACTIVE state, you can delete it. If a table is either in the
CREATING or UPDATING states, then Amazon Keyspaces returns a
ResourceInUseException. If the specified table does not exist, Amazon Keyspaces returns a
ResourceNotFoundException. If the table is already in the DELETING state, no error is
returned.
deleteTableRequest - ACTIVE.default CompletableFuture<DeleteTableResponse> deleteTable(Consumer<DeleteTableRequest.Builder> deleteTableRequest)
The DeleteTable operation deletes a table and all of its data. After a DeleteTable
request is received, the specified table is in the DELETING state until Amazon Keyspaces completes
the deletion. If the table is in the ACTIVE state, you can delete it. If a table is either in the
CREATING or UPDATING states, then Amazon Keyspaces returns a
ResourceInUseException. If the specified table does not exist, Amazon Keyspaces returns a
ResourceNotFoundException. If the table is already in the DELETING state, no error is
returned.
This is a convenience which creates an instance of the DeleteTableRequest.Builder avoiding the need to
create one manually via DeleteTableRequest.builder()
deleteTableRequest - A Consumer that will call methods on DeleteTableRequest.Builder to create a request.ACTIVE.default CompletableFuture<GetKeyspaceResponse> getKeyspace(GetKeyspaceRequest getKeyspaceRequest)
Returns the name and the Amazon Resource Name (ARN) of the specified table.
getKeyspaceRequest - ACTIVE.default CompletableFuture<GetKeyspaceResponse> getKeyspace(Consumer<GetKeyspaceRequest.Builder> getKeyspaceRequest)
Returns the name and the Amazon Resource Name (ARN) of the specified table.
This is a convenience which creates an instance of the GetKeyspaceRequest.Builder avoiding the need to
create one manually via GetKeyspaceRequest.builder()
getKeyspaceRequest - A Consumer that will call methods on GetKeyspaceRequest.Builder to create a request.ACTIVE.default CompletableFuture<GetTableResponse> getTable(GetTableRequest getTableRequest)
Returns information about the table, including the table's name and current status, the keyspace name, configuration settings, and metadata.
To read table metadata using GetTable, Select action permissions for the table and
system tables are required to complete the operation.
getTableRequest - ACTIVE.default CompletableFuture<GetTableResponse> getTable(Consumer<GetTableRequest.Builder> getTableRequest)
Returns information about the table, including the table's name and current status, the keyspace name, configuration settings, and metadata.
To read table metadata using GetTable, Select action permissions for the table and
system tables are required to complete the operation.
This is a convenience which creates an instance of the GetTableRequest.Builder avoiding the need to
create one manually via GetTableRequest.builder()
getTableRequest - A Consumer that will call methods on GetTableRequest.Builder to create a request.ACTIVE.default CompletableFuture<ListKeyspacesResponse> listKeyspaces(ListKeyspacesRequest listKeyspacesRequest)
Returns a list of keyspaces.
listKeyspacesRequest - ACTIVE.default CompletableFuture<ListKeyspacesResponse> listKeyspaces(Consumer<ListKeyspacesRequest.Builder> listKeyspacesRequest)
Returns a list of keyspaces.
This is a convenience which creates an instance of the ListKeyspacesRequest.Builder avoiding the need to
create one manually via ListKeyspacesRequest.builder()
listKeyspacesRequest - A Consumer that will call methods on ListKeyspacesRequest.Builder to create a request.ACTIVE.default ListKeyspacesPublisher listKeyspacesPaginator(ListKeyspacesRequest listKeyspacesRequest)
Returns a list of keyspaces.
This is a variant of listKeyspaces(software.amazon.awssdk.services.keyspaces.model.ListKeyspacesRequest)
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.keyspaces.paginators.ListKeyspacesPublisher publisher = client.listKeyspacesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.keyspaces.paginators.ListKeyspacesPublisher publisher = client.listKeyspacesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.keyspaces.model.ListKeyspacesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.keyspaces.model.ListKeyspacesResponse 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
listKeyspaces(software.amazon.awssdk.services.keyspaces.model.ListKeyspacesRequest) operation.
listKeyspacesRequest - ACTIVE.default ListKeyspacesPublisher listKeyspacesPaginator(Consumer<ListKeyspacesRequest.Builder> listKeyspacesRequest)
Returns a list of keyspaces.
This is a variant of listKeyspaces(software.amazon.awssdk.services.keyspaces.model.ListKeyspacesRequest)
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.keyspaces.paginators.ListKeyspacesPublisher publisher = client.listKeyspacesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.keyspaces.paginators.ListKeyspacesPublisher publisher = client.listKeyspacesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.keyspaces.model.ListKeyspacesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.keyspaces.model.ListKeyspacesResponse 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
listKeyspaces(software.amazon.awssdk.services.keyspaces.model.ListKeyspacesRequest) operation.
This is a convenience which creates an instance of the ListKeyspacesRequest.Builder avoiding the need to
create one manually via ListKeyspacesRequest.builder()
listKeyspacesRequest - A Consumer that will call methods on ListKeyspacesRequest.Builder to create a request.ACTIVE.default CompletableFuture<ListTablesResponse> listTables(ListTablesRequest listTablesRequest)
Returns a list of tables for a specified keyspace.
listTablesRequest - ACTIVE.default CompletableFuture<ListTablesResponse> listTables(Consumer<ListTablesRequest.Builder> listTablesRequest)
Returns a list of tables for a specified keyspace.
This is a convenience which creates an instance of the ListTablesRequest.Builder avoiding the need to
create one manually via ListTablesRequest.builder()
listTablesRequest - A Consumer that will call methods on ListTablesRequest.Builder to create a request.ACTIVE.default ListTablesPublisher listTablesPaginator(ListTablesRequest listTablesRequest)
Returns a list of tables for a specified keyspace.
This is a variant of listTables(software.amazon.awssdk.services.keyspaces.model.ListTablesRequest)
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.keyspaces.paginators.ListTablesPublisher publisher = client.listTablesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.keyspaces.paginators.ListTablesPublisher publisher = client.listTablesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.keyspaces.model.ListTablesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.keyspaces.model.ListTablesResponse 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
listTables(software.amazon.awssdk.services.keyspaces.model.ListTablesRequest) operation.
listTablesRequest - ACTIVE.default ListTablesPublisher listTablesPaginator(Consumer<ListTablesRequest.Builder> listTablesRequest)
Returns a list of tables for a specified keyspace.
This is a variant of listTables(software.amazon.awssdk.services.keyspaces.model.ListTablesRequest)
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.keyspaces.paginators.ListTablesPublisher publisher = client.listTablesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.keyspaces.paginators.ListTablesPublisher publisher = client.listTablesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.keyspaces.model.ListTablesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.keyspaces.model.ListTablesResponse 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
listTables(software.amazon.awssdk.services.keyspaces.model.ListTablesRequest) operation.
This is a convenience which creates an instance of the ListTablesRequest.Builder avoiding the need to
create one manually via ListTablesRequest.builder()
listTablesRequest - A Consumer that will call methods on ListTablesRequest.Builder to create a request.ACTIVE.default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Returns a list of all tags associated with the specified Amazon Keyspaces resource.
listTagsForResourceRequest - ACTIVE.default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Returns a list of all tags associated with the specified Amazon Keyspaces resource.
This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the
need to create one manually via ListTagsForResourceRequest.builder()
listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a
request.ACTIVE.default ListTagsForResourcePublisher listTagsForResourcePaginator(ListTagsForResourceRequest listTagsForResourceRequest)
Returns a list of all tags associated with the specified Amazon Keyspaces resource.
This is a variant of
listTagsForResource(software.amazon.awssdk.services.keyspaces.model.ListTagsForResourceRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.keyspaces.paginators.ListTagsForResourcePublisher publisher = client.listTagsForResourcePaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.keyspaces.paginators.ListTagsForResourcePublisher publisher = client.listTagsForResourcePaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.keyspaces.model.ListTagsForResourceResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.keyspaces.model.ListTagsForResourceResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of 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
listTagsForResource(software.amazon.awssdk.services.keyspaces.model.ListTagsForResourceRequest)
operation.
listTagsForResourceRequest - ACTIVE.default ListTagsForResourcePublisher listTagsForResourcePaginator(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Returns a list of all tags associated with the specified Amazon Keyspaces resource.
This is a variant of
listTagsForResource(software.amazon.awssdk.services.keyspaces.model.ListTagsForResourceRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.keyspaces.paginators.ListTagsForResourcePublisher publisher = client.listTagsForResourcePaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.keyspaces.paginators.ListTagsForResourcePublisher publisher = client.listTagsForResourcePaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.keyspaces.model.ListTagsForResourceResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.keyspaces.model.ListTagsForResourceResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of 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
listTagsForResource(software.amazon.awssdk.services.keyspaces.model.ListTagsForResourceRequest)
operation.
This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the
need to create one manually via ListTagsForResourceRequest.builder()
listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a
request.ACTIVE.default CompletableFuture<RestoreTableResponse> restoreTable(RestoreTableRequest restoreTableRequest)
Restores the specified table to the specified point in time within the earliest_restorable_timestamp
and the current time. For more information about restore points, see Time window for PITR continuous backups in the Amazon Keyspaces Developer Guide.
Any number of users can execute up to 4 concurrent restores (any type of restore) in a given account.
When you restore using point in time recovery, Amazon Keyspaces restores your source table's schema and data to
the state based on the selected timestamp (day:hour:minute:second) to a new table. The Time to Live
(TTL) settings are also restored to the state based on the selected timestamp.
In addition to the table's schema, data, and TTL settings, RestoreTable restores the capacity mode,
encryption, and point-in-time recovery settings from the source table. Unlike the table's schema data and TTL
settings, which are restored based on the selected timestamp, these settings are always restored based on the
table's settings as of the current time or when the table was deleted.
You can also overwrite these settings during restore:
• Read/write capacity mode
• Provisioned throughput capacity settings
• Point-in-time (PITR) settings
• Tags
For more information, see PITR restore settings in the Amazon Keyspaces Developer Guide.
Note that the following settings are not restored, and you must configure them manually for the new table:
• Automatic scaling policies (for tables that use provisioned capacity mode)
• Identity and Access Management (IAM) policies
• Amazon CloudWatch metrics and alarms
restoreTableRequest - ACTIVE.default CompletableFuture<RestoreTableResponse> restoreTable(Consumer<RestoreTableRequest.Builder> restoreTableRequest)
Restores the specified table to the specified point in time within the earliest_restorable_timestamp
and the current time. For more information about restore points, see Time window for PITR continuous backups in the Amazon Keyspaces Developer Guide.
Any number of users can execute up to 4 concurrent restores (any type of restore) in a given account.
When you restore using point in time recovery, Amazon Keyspaces restores your source table's schema and data to
the state based on the selected timestamp (day:hour:minute:second) to a new table. The Time to Live
(TTL) settings are also restored to the state based on the selected timestamp.
In addition to the table's schema, data, and TTL settings, RestoreTable restores the capacity mode,
encryption, and point-in-time recovery settings from the source table. Unlike the table's schema data and TTL
settings, which are restored based on the selected timestamp, these settings are always restored based on the
table's settings as of the current time or when the table was deleted.
You can also overwrite these settings during restore:
• Read/write capacity mode
• Provisioned throughput capacity settings
• Point-in-time (PITR) settings
• Tags
For more information, see PITR restore settings in the Amazon Keyspaces Developer Guide.
Note that the following settings are not restored, and you must configure them manually for the new table:
• Automatic scaling policies (for tables that use provisioned capacity mode)
• Identity and Access Management (IAM) policies
• Amazon CloudWatch metrics and alarms
This is a convenience which creates an instance of the RestoreTableRequest.Builder avoiding the need to
create one manually via RestoreTableRequest.builder()
restoreTableRequest - A Consumer that will call methods on RestoreTableRequest.Builder to create a request.ACTIVE.default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest)
Associates a set of tags with a Amazon Keyspaces resource. You can then activate these user-defined tags so that they appear on the Cost Management Console for cost allocation tracking. For more information, see Adding tags and labels to Amazon Keyspaces resources in the Amazon Keyspaces Developer Guide.
For IAM policy examples that show how to control access to Amazon Keyspaces resources based on tags, see Amazon Keyspaces resource access based on tags in the Amazon Keyspaces Developer Guide.
tagResourceRequest - ACTIVE.default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Associates a set of tags with a Amazon Keyspaces resource. You can then activate these user-defined tags so that they appear on the Cost Management Console for cost allocation tracking. For more information, see Adding tags and labels to Amazon Keyspaces resources in the Amazon Keyspaces Developer Guide.
For IAM policy examples that show how to control access to Amazon Keyspaces resources based on tags, see Amazon Keyspaces resource access based on tags in the Amazon Keyspaces Developer Guide.
This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to
create one manually via TagResourceRequest.builder()
tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.ACTIVE.default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest)
Removes the association of tags from a Amazon Keyspaces resource.
untagResourceRequest - ACTIVE.default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Removes the association of tags from a Amazon Keyspaces resource.
This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to
create one manually via UntagResourceRequest.builder()
untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.ACTIVE.default CompletableFuture<UpdateTableResponse> updateTable(UpdateTableRequest updateTableRequest)
Adds new columns to the table or updates one of the table's settings, for example capacity mode, encryption, point-in-time recovery, or ttl settings. Note that you can only update one specific table setting per update operation.
updateTableRequest - ACTIVE.default CompletableFuture<UpdateTableResponse> updateTable(Consumer<UpdateTableRequest.Builder> updateTableRequest)
Adds new columns to the table or updates one of the table's settings, for example capacity mode, encryption, point-in-time recovery, or ttl settings. Note that you can only update one specific table setting per update operation.
This is a convenience which creates an instance of the UpdateTableRequest.Builder avoiding the need to
create one manually via UpdateTableRequest.builder()
updateTableRequest - A Consumer that will call methods on UpdateTableRequest.Builder to create a request.ACTIVE.Copyright © 2022. All rights reserved.