AbstractAmazonKeyspaces (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.keyspaces.AbstractAmazonKeyspaces

All Implemented Interfaces:

AmazonKeyspaces

Direct Known Subclasses:

AbstractAmazonKeyspacesAsync
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AbstractAmazonKeyspaces
extends Object
implements AmazonKeyspaces
```
Abstract implementation of AmazonKeyspaces. Convenient method forms pass through to the corresponding overload that takes a request object, which throws an UnsupportedOperationException.

Field Summary
- Fields inherited from interface com.amazonaws.services.keyspaces.AmazonKeyspaces
  ENDPOINT_PREFIX

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CreateKeyspaceResult`	`createKeyspace(CreateKeyspaceRequest request)` The `CreateKeyspace` operation adds a new keyspace to your account.
`CreateTableResult`	`createTable(CreateTableRequest request)` The `CreateTable` operation adds a new table to the specified keyspace.
`DeleteKeyspaceResult`	`deleteKeyspace(DeleteKeyspaceRequest request)` The `DeleteKeyspace` operation deletes a keyspace and all of its tables.
`DeleteTableResult`	`deleteTable(DeleteTableRequest request)` The `DeleteTable` operation deletes a table and all of its data.
`ResponseMetadata`	`getCachedResponseMetadata(AmazonWebServiceRequest request)` Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
`GetKeyspaceResult`	`getKeyspace(GetKeyspaceRequest request)` Returns the name and the Amazon Resource Name (ARN) of the specified table.
`GetTableResult`	`getTable(GetTableRequest request)` Returns information about the table, including the table's name and current status, the keyspace name, configuration settings, and metadata.
`ListKeyspacesResult`	`listKeyspaces(ListKeyspacesRequest request)` Returns a list of keyspaces.
`ListTablesResult`	`listTables(ListTablesRequest request)` Returns a list of tables for a specified keyspace.
`ListTagsForResourceResult`	`listTagsForResource(ListTagsForResourceRequest request)` Returns a list of all tags associated with the specified Amazon Keyspaces resource.
`RestoreTableResult`	`restoreTable(RestoreTableRequest request)` Restores the specified table to the specified point in time within the `earliest_restorable_timestamp` and the current time.
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`TagResourceResult`	`tagResource(TagResourceRequest request)` Associates a set of tags with a Amazon Keyspaces resource.
`UntagResourceResult`	`untagResource(UntagResourceRequest request)` Removes the association of tags from a Amazon Keyspaces resource.
`UpdateTableResult`	`updateTable(UpdateTableRequest request)` 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.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - createKeyspace
```
public CreateKeyspaceResult createKeyspace(CreateKeyspaceRequest request)
```
    Description copied from interface: AmazonKeyspaces
    
    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.
    
    Specified by:
    
    createKeyspace in interface AmazonKeyspaces
    
    Returns:
    
    Result of the CreateKeyspace operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createTable
```
public CreateTableResult createTable(CreateTableRequest request)
```
    Description copied from interface: AmazonKeyspaces
    
    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.
    
    Specified by:
    
    createTable in interface AmazonKeyspaces
    
    Returns:
    
    Result of the CreateTable operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteKeyspace
```
public DeleteKeyspaceResult deleteKeyspace(DeleteKeyspaceRequest request)
```
    Description copied from interface: AmazonKeyspaces
    
    The DeleteKeyspace operation deletes a keyspace and all of its tables.
    
    Specified by:
    
    deleteKeyspace in interface AmazonKeyspaces
    
    Returns:
    
    Result of the DeleteKeyspace operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteTable
```
public DeleteTableResult deleteTable(DeleteTableRequest request)
```
    Description copied from interface: AmazonKeyspaces
    
    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.
    
    Specified by:
    
    deleteTable in interface AmazonKeyspaces
    
    Returns:
    
    Result of the DeleteTable operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getKeyspace
```
public GetKeyspaceResult getKeyspace(GetKeyspaceRequest request)
```
    Description copied from interface: AmazonKeyspaces
    
    Returns the name and the Amazon Resource Name (ARN) of the specified table.
    
    Specified by:
    
    getKeyspace in interface AmazonKeyspaces
    
    Returns:
    
    Result of the GetKeyspace operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getTable
```
public GetTableResult getTable(GetTableRequest request)
```
    Description copied from interface: AmazonKeyspaces
    
    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.
    
    Specified by:
    
    getTable in interface AmazonKeyspaces
    
    Returns:
    
    Result of the GetTable operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listKeyspaces
```
public ListKeyspacesResult listKeyspaces(ListKeyspacesRequest request)
```
    Description copied from interface: AmazonKeyspaces
    
    Returns a list of keyspaces.
    
    Specified by:
    
    listKeyspaces in interface AmazonKeyspaces
    
    Returns:
    
    Result of the ListKeyspaces operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listTables
```
public ListTablesResult listTables(ListTablesRequest request)
```
    Description copied from interface: AmazonKeyspaces
    
    Returns a list of tables for a specified keyspace.
    
    Specified by:
    
    listTables in interface AmazonKeyspaces
    
    Returns:
    
    Result of the ListTables operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listTagsForResource
```
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
```
    Description copied from interface: AmazonKeyspaces
    
    Returns a list of all tags associated with the specified Amazon Keyspaces resource.
    
    Specified by:
    
    listTagsForResource in interface AmazonKeyspaces
    
    Returns:
    
    Result of the ListTagsForResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - restoreTable
```
public RestoreTableResult restoreTable(RestoreTableRequest request)
```
    Description copied from interface: AmazonKeyspaces
    
    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
    
    Specified by:
    
    restoreTable in interface AmazonKeyspaces
    
    Returns:
    
    Result of the RestoreTable operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - tagResource
```
public TagResourceResult tagResource(TagResourceRequest request)
```
    Description copied from interface: AmazonKeyspaces
    
    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.
    
    Specified by:
    
    tagResource in interface AmazonKeyspaces
    
    Returns:
    
    Result of the TagResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - untagResource
```
public UntagResourceResult untagResource(UntagResourceRequest request)
```
    Description copied from interface: AmazonKeyspaces
    
    Removes the association of tags from a Amazon Keyspaces resource.
    
    Specified by:
    
    untagResource in interface AmazonKeyspaces
    
    Returns:
    
    Result of the UntagResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateTable
```
public UpdateTableResult updateTable(UpdateTableRequest request)
```
    Description copied from interface: AmazonKeyspaces
    
    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.
    
    Specified by:
    
    updateTable in interface AmazonKeyspaces
    
    Returns:
    
    Result of the UpdateTable operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - shutdown
```
public void shutdown()
```
    Description copied from interface: AmazonKeyspaces
    
    Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.
    
    Specified by:
    
    shutdown in interface AmazonKeyspaces
  - getCachedResponseMetadata
```
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Description copied from interface: AmazonKeyspaces
    
    Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.
    Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
    
    Specified by:
    
    getCachedResponseMetadata in interface AmazonKeyspaces
    
    Parameters:
    
    request - The originally executed request.
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.

Did this page help you?

Class AbstractAmazonKeyspaces

Field Summary

Fields inherited from interface com.amazonaws.services.keyspaces.AmazonKeyspaces

Method Summary

Methods inherited from class java.lang.Object

Method Detail

createKeyspace

createTable

deleteKeyspace

deleteTable

getKeyspace

getTable

listKeyspaces

listTables

listTagsForResource

restoreTable

tagResource

untagResource

updateTable

shutdown

getCachedResponseMetadata