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) |
Index.Builder<T> withEndpoint(URI endpoint)
endpoint
- is the endpoint to use.Index.Builder<T> withConvertMarker(ConvertMarker convertMarker)
convertMarker
- is used for generating the PageIterator marker
when performing queryItems() call.Index.Builder<T> withTableDescription(TableDescription tableDescription, String indexName)
tableDescription
- is the description of the table.indexName
- is the name of the index to use (or null
if main index is desired).default Index.Builder<T> withTableDescription(TableDescription tableDescription)
Index.Builder<T> withHashKeyName(String name)
name
- is the required hash key nameIndex.Builder<T> withRangeKeyName(String name)
name
- is the optional range key nameIndex.Builder<T> withOtherKeyNames(String... names)
names
- are the hash/range key of the main index.Index.Builder<T> withConvertValue(ConvertValue convertValue)
convertValue
- is used for converting between T and
Map<String, Object> and back.Index.Builder<T> withInfiniteRetry()
Index.Builder<T> withTableName(String tableName)
tableName
- is the table name to use.Index.Builder<T> withTableNameFormat(String tableNameFormatStr)
tableNameFormatStr
- is use to add a table name prefix or suffix.
This string is passed as the first argument to String.format().Index.Builder<T> withIndexName(String tableName, String indexName)
tableName
- is the name of the table to use.indexName
- is the name of the alternative index to use.Index.Builder<T> withCredProvider(CredProvider credProvider)
credProvider
- is used to obtain the DB username and
password (or key id and secret key).Index.Builder<T> withProxy(URI proxyEndpoint)
proxyEndpoint
- is the DDB proxy to use, or null if no proxy is needed.Index.Builder<T> withNoEncrypt(String... attrNames)
attrNames
- are the attribute names that should NOT be encrypted.Index.Builder<T> withKeyProvider(KeyProvider keyProvider)
keyProvider
- is the KeyProvider used for obtaining encryption
keys.String getHashKeyName()
String getRangeKeyName()
String[] getOtherKeyNames()
String getTableName()
Copyright © 2018. All rights reserved.