io.nats.client.api

Class KeyValueConfiguration.Builder

java.lang.Object

io.nats.client.api.KeyValueConfiguration.Builder

Enclosing class:

KeyValueConfiguration

public static class KeyValueConfiguration.Builder
extends java.lang.Object

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

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

Constructor Summary

Constructors

Constructor and Description
Builder() Default Builder
Builder(KeyValueConfiguration kvc) Construct the builder by copying another configuration

Method Summary

Modifier and Type	Method and Description
KeyValueConfiguration	build() Builds the KeyValueConfiguration
KeyValueConfiguration.Builder	description(java.lang.String description) Sets the description of the store.
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	maxValueSize(long maxValueSize) Sets the maximum size for an individual value in the KeyValueConfiguration.
KeyValueConfiguration.Builder	name(java.lang.String name) Sets the name of the store.
KeyValueConfiguration.Builder	replicas(int replicas) Sets the number of replicas a message must be stored on 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(KeyValueConfiguration kvc)

Construct the builder by copying another configuration

Parameters:

kvc - the configuration to copy

Method Detail

name

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

Sets the name of the store.

Parameters:

name - name of the store.

Returns:

the builder

description

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

Sets the description of the store.

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.

Parameters:

maxBucketSize - the maximum number of bytes

Returns:

Builder

maxValueSize

public KeyValueConfiguration.Builder maxValueSize(long 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.

Parameters:

ttl - the maximum age

Returns:

Builder

storageType

public KeyValueConfiguration.Builder storageType(StorageType storageType)

Sets the storage type in the 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.

Parameters:

replicas - the number of replicas

Returns:

Builder

build

public KeyValueConfiguration build()

Builds the KeyValueConfiguration

Returns:

the KeyValueConfiguration.