io.nats.client.api

Class BucketConfiguration.Builder

java.lang.Object

io.nats.client.api.BucketConfiguration.Builder

Enclosing class:

BucketConfiguration

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

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

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

Constructor Summary

Constructors

Constructor and Description
Builder() Default Builder
Builder(BucketConfiguration bc) Update Builder, useful if you need to update a configuration

Method Summary

Modifier and Type	Method and Description
BucketConfiguration	build() Builds the BucketConfiguration
BucketConfiguration.Builder	duplicateWindow(java.time.Duration window) Sets the duplicate checking window in the the BucketConfiguration.
BucketConfiguration.Builder	duplicateWindow(long windowMillis) Sets the duplicate checking window in the the BucketConfiguration.
BucketConfiguration.Builder	maxBucketSize(long maxBucketSize) Sets the maximum number of bytes in the BucketConfiguration.
BucketConfiguration.Builder	maxHistory(long maxHistory) Sets the maximum number of history for any one key.
BucketConfiguration.Builder	maxValues(long maxValues) Sets the maximum number of values across all keys, including history values in the BucketConfiguration.
BucketConfiguration.Builder	maxValueSize(long maxValueSize) Sets the maximum number of bytes for an individual value in the BucketConfiguration.
BucketConfiguration.Builder	name(java.lang.String name) Sets the name of the stream.
BucketConfiguration.Builder	replicas(int replicas) Sets the number of replicas a message must be stored on in the BucketConfiguration.
BucketConfiguration.Builder	storageType(StorageType storageType) Sets the storage type in the BucketConfiguration.
BucketConfiguration.Builder	ttl(java.time.Duration ttl) Sets the maximum for a value in this BucketConfiguration.

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(BucketConfiguration bc)

Update Builder, useful if you need to update a configuration

Parameters:

bc - the configuration to copy

Method Detail

name

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

Sets the name of the stream.

Parameters:

name - name of the stream.

Returns:

the builder

maxValues

public BucketConfiguration.Builder maxValues(long maxValues)

Sets the maximum number of values across all keys, including history values in the BucketConfiguration.

Parameters:

maxValues - the maximum number of values

Returns:

Builder

maxHistory

public BucketConfiguration.Builder maxHistory(long maxHistory)

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

Parameters:

maxHistory - the maximum number of messages

Returns:

Builder

maxBucketSize

public BucketConfiguration.Builder maxBucketSize(long maxBucketSize)

Sets the maximum number of bytes in the BucketConfiguration.

Parameters:

maxBucketSize - the maximum number of bytes

Returns:

Builder

maxValueSize

public BucketConfiguration.Builder maxValueSize(long maxValueSize)

Sets the maximum number of bytes for an individual value in the BucketConfiguration.

Parameters:

maxValueSize - the maximum number of bytes for a value

Returns:

Builder

ttl

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

Sets the maximum for a value in this BucketConfiguration.

Parameters:

ttl - the maximum age

Returns:

Builder

storageType

public BucketConfiguration.Builder storageType(StorageType storageType)

Sets the storage type in the BucketConfiguration.

Parameters:

storageType - the storage type

Returns:

Builder

replicas

public BucketConfiguration.Builder replicas(int replicas)

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

Parameters:

replicas - the number of replicas to store this message on

Returns:

Builder

duplicateWindow

public BucketConfiguration.Builder duplicateWindow(java.time.Duration window)

Sets the duplicate checking window in the the BucketConfiguration. A Duration.Zero disables duplicate checking. Duplicate checking is disabled by default.

Parameters:

window - duration to hold message ids for duplicate checking.

Returns:

Builder

duplicateWindow

public BucketConfiguration.Builder duplicateWindow(long windowMillis)

Sets the duplicate checking window in the the BucketConfiguration. A Duration.Zero disables duplicate checking. Duplicate checking is disabled by default.

Parameters:

windowMillis - duration to hold message ids for duplicate checking.

Returns:

Builder

build

public BucketConfiguration build()

Builds the BucketConfiguration

Returns:

a bucket configuration.