Package com.nimbusds.infinispan.persistence.dynamodb.config

Interface DynamoDBStoreConfigurationChildBuilder<S>

All Superinterfaces:

org.infinispan.configuration.cache.ConfigurationChildBuilder, org.infinispan.configuration.cache.StoreConfigurationChildBuilder<S>

All Known Implementing Classes:

DynamoDBStoreConfigurationBuilder

public interface DynamoDBStoreConfigurationChildBuilder<S>
extends org.infinispan.configuration.cache.StoreConfigurationChildBuilder<S>

DynamoDB store configuration child builder.

Method Summary

Modifier and Type	Method	Description
DynamoDBStoreConfigurationChildBuilder<S>	applyRangeKey(String rangeKeyName)	Sets the name of the optional range key to apply to all DynamoDB operations.
DynamoDBStoreConfigurationChildBuilder<S>	consistentReads(boolean enable)	Sets the consistent read flag.
DynamoDBStoreConfigurationChildBuilder<S>	enableContinuousBackups(boolean enable)	Sets the enable continuous backups / point in time recovery.
DynamoDBStoreConfigurationChildBuilder<S>	enableStream(boolean enable)	Sets the enable stream flag.
DynamoDBStoreConfigurationChildBuilder<S>	enableTTL(boolean enable)	Sets the enable DynamoDB item expiration.
DynamoDBStoreConfigurationChildBuilder<S>	endpoint(String endpoint)	Sets the DynamoDB endpoint.
DynamoDBStoreConfigurationChildBuilder<S>	hmacSHA256Key(String key)	Sets the HMAC SHA-256 key.
DynamoDBStoreConfigurationChildBuilder<S>	httpProxyHost(String host)	Sets the HTTP proxy host.
DynamoDBStoreConfigurationChildBuilder<S>	httpProxyPort(int port)	Sets the HTTP proxy port.
DynamoDBStoreConfigurationChildBuilder<S>	indexedAttributes(Set<String> indexAttributes)	Sets the optional indexed DynamoDB table attributes.
DynamoDBStoreConfigurationChildBuilder<S>	itemTransformerClass(Class itemTransformerClass)	Sets the class for transforming between Infinispan entries (key / value pair and optional metadata) and a corresponding DynamoDB item.
DynamoDBStoreConfigurationChildBuilder<S>	metricRegistry(com.codahale.metrics.MetricRegistry metricRegistry)	Sets an explicit metric registry to use (other than singleton MonitorRegistries).
DynamoDBStoreConfigurationChildBuilder<S>	purgeLimit(long purgeLimit)	Sets the limit of expired entries to purge during a run of the expired entry reaper task.
DynamoDBStoreConfigurationChildBuilder<S>	purgeMaxReadCapacity(Capacity purgeReadCapacity)	Sets the maximum read capacity to use when scanning a DynamoDB table for expired items.
DynamoDBStoreConfigurationChildBuilder<S>	queryExecutorClass(Class queryExecutorClass)	Sets the optional class for executing direct queries against DynamoDB.
DynamoDBStoreConfigurationChildBuilder<S>	rangeKeyValue(String rangeKeyValue)	Sets the value of the optional range key.
DynamoDBStoreConfigurationChildBuilder<S>	readCapacity(long readCapacity)	Sets the read capacity to provision when creating a new DynamoDB table.
DynamoDBStoreConfigurationChildBuilder<S>	region(com.amazonaws.regions.Regions region)	Sets the DynamoDB region.
DynamoDBStoreConfigurationChildBuilder<S>	tablePrefix(String tablePrefix)	Sets the DynamoDB table prefix.
DynamoDBStoreConfigurationChildBuilder<S>	tableWithEncryptionAtRest(boolean encryptionAtRest)	Sets the DynamoDB table encryption at rest.
DynamoDBStoreConfigurationChildBuilder<S>	writeCapacity(long writeCapacity)	Sets the write capacity to provision when creating a new DynamoDB table.

Methods inherited from interface org.infinispan.configuration.cache.ConfigurationChildBuilder

build, clustering, customInterceptors, encoding, expiration, indexing, invocationBatching, jmxStatistics, locking, memory, persistence, query, security, simpleCache, simpleCache, sites, statistics, template, transaction, unsafe, validate

Methods inherited from interface org.infinispan.configuration.cache.StoreConfigurationChildBuilder

addProperty, async, fetchPersistentState, ignoreModifications, maxBatchSize, preload, purgeOnStartup, segmented, shared, transactional, withProperties, writeOnly

Method Details

endpoint

DynamoDBStoreConfigurationChildBuilder<S> endpoint(String endpoint)

Sets the DynamoDB endpoint.

Parameters:

endpoint - The endpoint, null if not specified.

Returns:

The builder.

region

DynamoDBStoreConfigurationChildBuilder<S> region(com.amazonaws.regions.Regions region)

Sets the DynamoDB region.

Parameters:

region - The region, null if not specified.

Returns:

The builder.

itemTransformerClass

DynamoDBStoreConfigurationChildBuilder<S> itemTransformerClass(Class itemTransformerClass)

Sets the class for transforming between Infinispan entries (key / value pair and optional metadata) and a corresponding DynamoDB item.

Parameters:

itemTransformerClass - The item transformer class. Must not be null.

Returns:

The builder.

queryExecutorClass

DynamoDBStoreConfigurationChildBuilder<S> queryExecutorClass(Class queryExecutorClass)

Sets the optional class for executing direct queries against DynamoDB. If set indexedAttributes(java.util.Set<java.lang.String>) must also be specified.

Parameters:

queryExecutorClass - The query executor class, null if not required.

Returns:

The builder.

indexedAttributes

DynamoDBStoreConfigurationChildBuilder<S> indexedAttributes(Set<String> indexAttributes)

Sets the optional indexed DynamoDB table attributes. If set queryExecutorClass(java.lang.Class) must also be specified.

Parameters:

indexAttributes - The indexed attributes, null if not required.

Returns:

The builder.

consistentReads

DynamoDBStoreConfigurationChildBuilder<S> consistentReads(boolean enable)

Sets the consistent read flag.

Parameters:

enable - true for consistent reads, false for eventually consistent.

Returns:

The builder.

readCapacity

DynamoDBStoreConfigurationChildBuilder<S> readCapacity(long readCapacity)

Sets the read capacity to provision when creating a new DynamoDB table.

Parameters:

readCapacity - The read capacity. Must be equal or larger than one.

Returns:

The builder.

writeCapacity

DynamoDBStoreConfigurationChildBuilder<S> writeCapacity(long writeCapacity)

Sets the write capacity to provision when creating a new DynamoDB table.

Parameters:

writeCapacity - The write capacity. Must be equal or larger than one.

Returns:

The builder.

purgeMaxReadCapacity

DynamoDBStoreConfigurationChildBuilder<S> purgeMaxReadCapacity(Capacity purgeReadCapacity)

Sets the maximum read capacity to use when scanning a DynamoDB table for expired items.

Parameters:

purgeReadCapacity - The maximum read capacity to use when scanning a DynamoDB table for expired items.

Returns:

This builder.

tableWithEncryptionAtRest

DynamoDBStoreConfigurationChildBuilder<S> tableWithEncryptionAtRest(boolean encryptionAtRest)

Sets the DynamoDB table encryption at rest.

Parameters:

encryptionAtRest - true to create the DynamoDB table with encryption at rest, false with no encryption.

Returns:

The builder.

tablePrefix

DynamoDBStoreConfigurationChildBuilder<S> tablePrefix(String tablePrefix)

Sets the DynamoDB table prefix.

Parameters:

tablePrefix - The table prefix, null if not specified.

Returns:

The builder.

metricRegistry

DynamoDBStoreConfigurationChildBuilder<S> metricRegistry(com.codahale.metrics.MetricRegistry metricRegistry)

Sets an explicit metric registry to use (other than singleton MonitorRegistries).

Parameters:

metricRegistry - The metric registry to use.

Returns:

The builder.

applyRangeKey

DynamoDBStoreConfigurationChildBuilder<S> applyRangeKey(String rangeKeyName)

Sets the name of the optional range key to apply to all DynamoDB operations.

Parameters:

rangeKeyName - The range key name, null if not specified.

Returns:

The builder.

rangeKeyValue

DynamoDBStoreConfigurationChildBuilder<S> rangeKeyValue(String rangeKeyValue)

Sets the value of the optional range key.

Parameters:

rangeKeyValue - The range key value, null if not specified.

Returns:

The builder.

enableStream

DynamoDBStoreConfigurationChildBuilder<S> enableStream(boolean enable)

Sets the enable stream flag.

Parameters:

enable - true to enable a stream for a global table, false for a regular table.

Returns:

The builder.

enableContinuousBackups

DynamoDBStoreConfigurationChildBuilder<S> enableContinuousBackups(boolean enable)

Sets the enable continuous backups / point in time recovery.

Parameters:

enable - true to enable continuous backups, false without.

Returns:

The builder.

enableTTL

DynamoDBStoreConfigurationChildBuilder<S> enableTTL(boolean enable)

Sets the enable DynamoDB item expiration.

Parameters:

enable - true to enable item expiration, false without.

Returns:

The builder.

purgeLimit

DynamoDBStoreConfigurationChildBuilder<S> purgeLimit(long purgeLimit)

Sets the limit of expired entries to purge during a run of the expired entry reaper task.

Parameters:

purgeLimit - The purge limit, -1 for no limit.

Returns:

The builder.

httpProxyHost

DynamoDBStoreConfigurationChildBuilder<S> httpProxyHost(String host)

Sets the HTTP proxy host.

Parameters:

host - The host, null if none.

Returns:

The builder.

httpProxyPort

DynamoDBStoreConfigurationChildBuilder<S> httpProxyPort(int port)

Sets the HTTP proxy port.

Parameters:

port - The port, -1 if none.

Returns:

The builder.

hmacSHA256Key

DynamoDBStoreConfigurationChildBuilder<S> hmacSHA256Key(String key)

Sets the HMAC SHA-256 key.

Parameters:

key - The HMAC SHA-256 key, null if none.

Returns:

The builder.