com.amazon.dax.client.dynamodbv2

Interface AmazonDaxClient

All Known Subinterfaces:

AmazonDaxAsyncClient

All Known Implementing Classes:

ClusterDaxAsyncClient, ClusterDaxClient

public interface AmazonDaxClient

Interface for accessing the DynamoDB Accelerator (DAX).

With the exception of setRegion(java.lang.String), the methods on this interface are used internally by the DAX smart client when interacting with the DAX server. Application code should use the methods defined on AmazonDynamoDB.

Method Summary

Modifier and Type	Method and Description
List<String>	defineAttributeList(Long attributeListId) Returns the attribute names for the provided attribute list identifier
Long	defineAttributeListId(List<String> attributeNames) Returns the attribute list identifier for the provided attributes.
Long	defineAttributeListId(List<String> attributeNames, List<String> keyNames) Returns the attribute list identifier for the provided attributes.
List<AttributeDefinition>	defineKeySchema(String tableName) Returns definitions of the key attributes for a table.
List<ServiceEndpoint>	endpoints() Returns the endpoints of the nodes belonging to the DAX cluster.
List<Integer>	methods(int serviceId) Returns the DAX RPC method identifiers supported by the service.
List<Integer>	services() Returns the DAX RPC service identifiers supported by the server.
void	setRegion(String region) Set the AWS region where DAX cluster exists.

Method Detail

setRegion

void setRegion(String region)
        throws AmazonClientException

Set the AWS region where DAX cluster exists.

The region is needed for authentication.

Parameters:

region - the cluster's region

Throws:

AmazonClientException

defineKeySchema

List<AttributeDefinition> defineKeySchema(String tableName)
                                   throws AmazonClientException

Returns definitions of the key attributes for a table.

Parameters:

tableName - the name of the table

Returns:

definitions of the table's key attributes. The first element defines the partition key; the second (if present) defines the sort key).

Throws:

AmazonClientException

defineAttributeListId

Long defineAttributeListId(List<String> attributeNames,
                           List<String> keyNames)
                    throws AmazonClientException

Returns the attribute list identifier for the provided attributes.

Parameters:

attributeNames - the names of the non-key attributes

keyNames - the names of the key attributes

Returns:

the identifier for the provided attributes

Throws:

AmazonClientException

defineAttributeListId

Long defineAttributeListId(List<String> attributeNames)
                    throws AmazonClientException

Returns the attribute list identifier for the provided attributes.

Parameters:

attributeNames - the names of the attributes

Returns:

the identifier for the provided attributes

Throws:

AmazonClientException

defineAttributeList

List<String> defineAttributeList(Long attributeListId)
                          throws AmazonClientException

Returns the attribute names for the provided attribute list identifier

Parameters:

attributeListId - the attribute list identifier

Returns:

the attribute names

Throws:

AmazonClientException

endpoints

List<ServiceEndpoint> endpoints()
                         throws AmazonClientException

Returns the endpoints of the nodes belonging to the DAX cluster.

Returns:

the cluster's current endpoints

Throws:

AmazonClientException

services

List<Integer> services()
                throws AmazonClientException

Returns the DAX RPC service identifiers supported by the server.

Returns:

the service identifiers

Throws:

AmazonClientException

methods

List<Integer> methods(int serviceId)
               throws AmazonClientException

Returns the DAX RPC method identifiers supported by the service.

Parameters:

serviceId - the service who's methods are being requested

Returns:

the method identifiers

Throws:

AmazonClientException