io.nats.client.api

Class KeyValueConfiguration.Builder

java.lang.Object

io.nats.client.api.FeatureConfiguration.Builder<KeyValueConfiguration.Builder,KeyValueConfiguration>

io.nats.client.api.KeyValueConfiguration.Builder

Enclosing class:

KeyValueConfiguration

public static class KeyValueConfiguration.Builder
extends FeatureConfiguration.Builder<KeyValueConfiguration.Builder,KeyValueConfiguration>

KeyValueConfiguration is created using a Builder. The builder supports chaining and will create a default set of options if no methods are calls.

new Builder().build() will create a new KeyValueConfiguration.

Field Summary

Fields inherited from class io.nats.client.api.FeatureConfiguration.Builder

name, scBuilder, ttl

Constructor Summary

Constructors

Constructor and Description
Builder() Default Builder
Builder(KeyValueConfiguration kvc) Construct the builder by copying another configuration
Builder(java.lang.String name) Builder accepting the key value bucket name.

Method Summary

Modifier and Type	Method and Description
KeyValueConfiguration.Builder	addSource(Source source) Add a source into the KeyValueConfiguration.
KeyValueConfiguration.Builder	addSources(java.util.Collection<Source> sources) Adds the sources into the KeyValueConfiguration
KeyValueConfiguration.Builder	addSources(Source... sources) Adds the sources into the KeyValueConfiguration
KeyValueConfiguration	build() Builds the KeyValueConfiguration
KeyValueConfiguration.Builder	compression(boolean compression) Sets whether to use compression for the KeyValueConfiguration.
KeyValueConfiguration.Builder	description(java.lang.String description) Sets the description of the store.
protected KeyValueConfiguration.Builder	getThis()
KeyValueConfiguration.Builder	maxBucketSize(long maxBucketSize) Sets the maximum number of bytes in the KeyValueConfiguration.
KeyValueConfiguration.Builder	maxHistoryPerKey(int maxHistoryPerKey) Sets the maximum number of history for any one key.
KeyValueConfiguration.Builder	maximumValueSize(int maxValueSize) Sets the maximum size for an individual value in the KeyValueConfiguration.
KeyValueConfiguration.Builder	maxValueSize(long maxValueSize) Deprecated. the server value is a 32-bit signed value. Use maximumValueSize(int) instead.
KeyValueConfiguration.Builder	metadata(java.util.Map<java.lang.String,java.lang.String> metadata) Sets the metadata for the KeyValueConfiguration
KeyValueConfiguration.Builder	mirror(Mirror mirror) Sets the mirror in the KeyValueConfiguration.
KeyValueConfiguration.Builder	name(java.lang.String name) Sets the name of the key value bucket.
KeyValueConfiguration.Builder	placement(Placement placement) Sets the placement directive object
KeyValueConfiguration.Builder	replicas(int replicas) Sets the number of replicas a message must be stored on in the KeyValueConfiguration.
KeyValueConfiguration.Builder	republish(Republish republish) Sets the Republish options
KeyValueConfiguration.Builder	sources(java.util.Collection<Source> sources) Sets the sources in the KeyValueConfiguration
KeyValueConfiguration.Builder	sources(Source... sources) Sets the sources in the KeyValueConfiguration.
KeyValueConfiguration.Builder	storageType(StorageType storageType) Sets the storage type in the KeyValueConfiguration.
KeyValueConfiguration.Builder	ttl(java.time.Duration ttl) Sets the maximum age for a value in this KeyValueConfiguration.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Default Builder

Builder

public Builder(java.lang.String name)

Builder accepting the key value bucket name.

Parameters:

name - name of the key value bucket.

Builder

public Builder(KeyValueConfiguration kvc)

Construct the builder by copying another configuration

Parameters:

kvc - the configuration to copy

Method Detail

getThis

protected KeyValueConfiguration.Builder getThis()

Specified by:

getThis in class FeatureConfiguration.Builder<KeyValueConfiguration.Builder,KeyValueConfiguration>

name

public KeyValueConfiguration.Builder name(java.lang.String name)

Sets the name of the key value bucket.

Overrides:

name in class FeatureConfiguration.Builder<KeyValueConfiguration.Builder,KeyValueConfiguration>

Parameters:

name - name of the key value bucket.

Returns:

the builder

description

public KeyValueConfiguration.Builder description(java.lang.String description)

Sets the description of the store.

Overrides:

description in class FeatureConfiguration.Builder<KeyValueConfiguration.Builder,KeyValueConfiguration>

Parameters:

description - description of the store.

Returns:

the builder

maxHistoryPerKey

public KeyValueConfiguration.Builder maxHistoryPerKey(int maxHistoryPerKey)

Sets the maximum number of history for any one key. Includes the current value.

Parameters:

maxHistoryPerKey - the maximum history

Returns:

Builder

maxBucketSize

public KeyValueConfiguration.Builder maxBucketSize(long maxBucketSize)

Sets the maximum number of bytes in the KeyValueConfiguration.

Overrides:

maxBucketSize in class FeatureConfiguration.Builder<KeyValueConfiguration.Builder,KeyValueConfiguration>

Parameters:

maxBucketSize - the maximum number of bytes

Returns:

Builder

maxValueSize

@Deprecated
public KeyValueConfiguration.Builder maxValueSize(long maxValueSize)

Deprecated. the server value is a 32-bit signed value. Use maximumValueSize(int) instead.

Sets the maximum size for an individual value in the KeyValueConfiguration.

Parameters:

maxValueSize - the maximum size for a value

Returns:

Builder

maximumValueSize

public KeyValueConfiguration.Builder maximumValueSize(int maxValueSize)

Sets the maximum size for an individual value in the KeyValueConfiguration.

Parameters:

maxValueSize - the maximum size for a value

Returns:

Builder

ttl

public KeyValueConfiguration.Builder ttl(java.time.Duration ttl)

Sets the maximum age for a value in this KeyValueConfiguration.

Overrides:

ttl in class FeatureConfiguration.Builder<KeyValueConfiguration.Builder,KeyValueConfiguration>

Parameters:

ttl - the maximum age

Returns:

Builder

storageType

public KeyValueConfiguration.Builder storageType(StorageType storageType)

Sets the storage type in the KeyValueConfiguration.

Overrides:

storageType in class FeatureConfiguration.Builder<KeyValueConfiguration.Builder,KeyValueConfiguration>

Parameters:

storageType - the storage type

Returns:

Builder

replicas

public KeyValueConfiguration.Builder replicas(int replicas)

Sets the number of replicas a message must be stored on in the KeyValueConfiguration.

Overrides:

replicas in class FeatureConfiguration.Builder<KeyValueConfiguration.Builder,KeyValueConfiguration>

Parameters:

replicas - the number of replicas

Returns:

Builder

placement

public KeyValueConfiguration.Builder placement(Placement placement)

Sets the placement directive object

Overrides:

placement in class FeatureConfiguration.Builder<KeyValueConfiguration.Builder,KeyValueConfiguration>

Parameters:

placement - the placement directive object

Returns:

Builder

compression

public KeyValueConfiguration.Builder compression(boolean compression)

Sets whether to use compression for the KeyValueConfiguration. If set, will use the default compression algorithm of the KV backing store.

Overrides:

compression in class FeatureConfiguration.Builder<KeyValueConfiguration.Builder,KeyValueConfiguration>

Parameters:

compression - whether to use compression in the KeyValueConfiguration

Returns:

Builder

metadata

public KeyValueConfiguration.Builder metadata(java.util.Map<java.lang.String,java.lang.String> metadata)

Sets the metadata for the KeyValueConfiguration

Overrides:

metadata in class FeatureConfiguration.Builder<KeyValueConfiguration.Builder,KeyValueConfiguration>

Parameters:

metadata - the metadata map

Returns:

Builder

republish

public KeyValueConfiguration.Builder republish(Republish republish)

Sets the Republish options

Parameters:

republish - the Republish object

Returns:

Builder

mirror

public KeyValueConfiguration.Builder mirror(Mirror mirror)

Sets the mirror in the KeyValueConfiguration.

Parameters:

mirror - the KeyValue's mirror

Returns:

Builder

sources

public KeyValueConfiguration.Builder sources(Source... sources)

Sets the sources in the KeyValueConfiguration.

Parameters:

sources - the KeyValue's sources

Returns:

Builder

sources

public KeyValueConfiguration.Builder sources(java.util.Collection<Source> sources)

Sets the sources in the KeyValueConfiguration

Parameters:

sources - the KeyValue's sources

Returns:

Builder

addSource

public KeyValueConfiguration.Builder addSource(Source source)

Add a source into the KeyValueConfiguration.

Parameters:

source - a KeyValue source

Returns:

Builder

addSources

public KeyValueConfiguration.Builder addSources(Source... sources)

Adds the sources into the KeyValueConfiguration

Parameters:

sources - the KeyValue's sources to add

Returns:

Builder

addSources

public KeyValueConfiguration.Builder addSources(java.util.Collection<Source> sources)

Adds the sources into the KeyValueConfiguration

Parameters:

sources - the KeyValue's sources to add

Returns:

Builder

build

public KeyValueConfiguration build()

Builds the KeyValueConfiguration

Specified by:

build in class FeatureConfiguration.Builder<KeyValueConfiguration.Builder,KeyValueConfiguration>

Returns:

the KeyValueConfiguration.