com.distelli.persistence

Interface Index.Builder<T>

Enclosing interface:

Index<T>

public static interface Index.Builder<T>

Method Summary

Modifier and Type	Method and Description
Index<T>	build()
String	getHashKeyName()
String[]	getOtherKeyNames()
String	getRangeKeyName()
String	getTableName()
Index.Builder<T>	withConvertMarker(ConvertMarker convertMarker)
Index.Builder<T>	withConvertValue(ConvertValue convertValue)
Index.Builder<T>	withCredProvider(CredProvider credProvider)
Index.Builder<T>	withEndpoint(URI endpoint) URI format: DynamoDB (always connects over SSL): ddb://<region|endpoint>/ MySQL (always connects over SSL): mysql://<host>:<port>/
Index.Builder<T>	withHashKeyName(String name)
Index.Builder<T>	withIndexName(String tableName, String indexName)
Index.Builder<T>	withInfiniteRetry() Enable infinite retries, this is only useful if running in some sort of batch mode.
Index.Builder<T>	withKeyProvider(KeyProvider keyProvider)
Index.Builder<T>	withNoEncrypt(String... attrNames)
Index.Builder<T>	withOtherKeyNames(String... names) Only applicable to secondary indexes.
Index.Builder<T>	withProxy(URI proxyEndpoint)
Index.Builder<T>	withRangeKeyName(String name)
default Index.Builder<T>	withTableDescription(TableDescription tableDescription)
Index.Builder<T>	withTableDescription(TableDescription tableDescription, String indexName) Source the following fields from the TableDescription: - hashKeyName - rangeKeyName - otherKeyNames - convertMarker - tableName / indexName - noEncrypt all hashKey/rangeKeys in all IndexDescriptions.
Index.Builder<T>	withTableName(String tableName)
Index.Builder<T>	withTableNameFormat(String tableNameFormatStr)

Method Detail

withEndpoint

Index.Builder<T> withEndpoint(URI endpoint)

URI format: DynamoDB (always connects over SSL): ddb://<region|endpoint>/ MySQL (always connects over SSL): mysql://<host>:<port>/

Parameters:

endpoint - is the endpoint to use.

Returns:

this

withConvertMarker

Index.Builder<T> withConvertMarker(ConvertMarker convertMarker)

Parameters:

convertMarker - is used for generating the PageIterator marker when performing queryItems() call.

Returns:

this

withTableDescription

Index.Builder<T> withTableDescription(TableDescription tableDescription,
                                      String indexName)

Source the following fields from the TableDescription: - hashKeyName - rangeKeyName - otherKeyNames - convertMarker - tableName / indexName - noEncrypt all hashKey/rangeKeys in all IndexDescriptions.

Parameters:

tableDescription - is the description of the table.

indexName - is the name of the index to use (or null if main index is desired).

withTableDescription

default Index.Builder<T> withTableDescription(TableDescription tableDescription)

withHashKeyName

Index.Builder<T> withHashKeyName(String name)

Parameters:

name - is the required hash key name

Returns:

this

withRangeKeyName

Index.Builder<T> withRangeKeyName(String name)

Parameters:

name - is the optional range key name

Returns:

this

withOtherKeyNames

Index.Builder<T> withOtherKeyNames(String... names)

Only applicable to secondary indexes.

Parameters:

names - are the hash/range key of the main index.

Returns:

this

withConvertValue

Index.Builder<T> withConvertValue(ConvertValue convertValue)

Parameters:

convertValue - is used for converting between T and Map<String, Object> and back.

Returns:

this

withInfiniteRetry

Index.Builder<T> withInfiniteRetry()

Enable infinite retries, this is only useful if running in some sort of batch mode.

Returns:

this

withTableName

Index.Builder<T> withTableName(String tableName)

Parameters:

tableName - is the table name to use.

Returns:

this

withTableNameFormat

Index.Builder<T> withTableNameFormat(String tableNameFormatStr)

Parameters:

tableNameFormatStr - is use to add a table name prefix or suffix. This string is passed as the first argument to String.format().

Returns:

this

withIndexName

Index.Builder<T> withIndexName(String tableName,
                               String indexName)

Parameters:

tableName - is the name of the table to use.

indexName - is the name of the alternative index to use.

Returns:

this

withCredProvider

Index.Builder<T> withCredProvider(CredProvider credProvider)

Parameters:

credProvider - is used to obtain the DB username and password (or key id and secret key).

Returns:

this

withProxy

Index.Builder<T> withProxy(URI proxyEndpoint)

Parameters:

proxyEndpoint - is the DDB proxy to use, or null if no proxy is needed.

Returns:

this

withNoEncrypt

Index.Builder<T> withNoEncrypt(String... attrNames)

Parameters:

attrNames - are the attribute names that should NOT be encrypted.

Returns:

this

withKeyProvider

Index.Builder<T> withKeyProvider(KeyProvider keyProvider)

Parameters:

keyProvider - is the KeyProvider used for obtaining encryption keys.

Returns:

this

build

Index<T> build()

Returns:

the index object based on the builder parameters.

getHashKeyName

String getHashKeyName()

Returns:

the hash key name specified via withHashKeyName().

getRangeKeyName

String getRangeKeyName()

Returns:

the optional range key name specified via withRangeKeyName().

getOtherKeyNames

String[] getOtherKeyNames()

getTableName

String getTableName()

Returns:

the fully formatted table name. Specifically, if tableNameFormat is set, this is the result of running String.format(tableNameFormat, tableName), otherwise this is simply the tableName.