io.nats.client.api

Class ObjectStoreConfiguration.Builder

java.lang.Object

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

io.nats.client.api.ObjectStoreConfiguration.Builder

Enclosing class:

ObjectStoreConfiguration

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

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

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

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(ObjectStoreConfiguration osc) Construct the builder by copying another configuration
Builder(java.lang.String name) Builder accepting the object store bucket name.

Method Summary

Modifier and Type	Method and Description
ObjectStoreConfiguration	build() Builds the ObjectStoreConfiguration
ObjectStoreConfiguration.Builder	compression(boolean compression) Sets whether to use compression for the ObjectStoreConfiguration.
ObjectStoreConfiguration.Builder	description(java.lang.String description) Sets the description of the store.
protected ObjectStoreConfiguration.Builder	getThis()
ObjectStoreConfiguration.Builder	maxBucketSize(long maxBucketSize) Sets the maximum number of bytes in the ObjectStoreConfiguration.
ObjectStoreConfiguration.Builder	metadata(java.util.Map<java.lang.String,java.lang.String> metadata) Sets the metadata for the ObjectStoreConfiguration
ObjectStoreConfiguration.Builder	name(java.lang.String name) Sets the name of the store.
ObjectStoreConfiguration.Builder	placement(Placement placement) Sets the placement directive object
ObjectStoreConfiguration.Builder	replicas(int replicas) Sets the number of replicas a message must be stored on in the ObjectStoreConfiguration.
ObjectStoreConfiguration.Builder	storageType(StorageType storageType) Sets the storage type in the ObjectStoreConfiguration.
ObjectStoreConfiguration.Builder	ttl(java.time.Duration ttl) Sets the maximum age for a value in this ObjectStoreConfiguration.

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 object store bucket name.

Parameters:

name - name of the store.

Builder

public Builder(ObjectStoreConfiguration osc)

Construct the builder by copying another configuration

Parameters:

osc - the configuration to copy

Method Detail

getThis

protected ObjectStoreConfiguration.Builder getThis()

Specified by:

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

name

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

Sets the name of the store.

Overrides:

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

Parameters:

name - name of the store.

Returns:

the builder

description

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

Sets the description of the store.

Overrides:

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

Parameters:

description - description of the store.

Returns:

the builder

maxBucketSize

public ObjectStoreConfiguration.Builder maxBucketSize(long maxBucketSize)

Sets the maximum number of bytes in the ObjectStoreConfiguration.

Overrides:

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

Parameters:

maxBucketSize - the maximum number of bytes

Returns:

Builder

ttl

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

Sets the maximum age for a value in this ObjectStoreConfiguration.

Overrides:

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

Parameters:

ttl - the maximum age

Returns:

Builder

storageType

public ObjectStoreConfiguration.Builder storageType(StorageType storageType)

Sets the storage type in the ObjectStoreConfiguration.

Overrides:

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

Parameters:

storageType - the storage type

Returns:

Builder

replicas

public ObjectStoreConfiguration.Builder replicas(int replicas)

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

Overrides:

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

Parameters:

replicas - the number of replicas

Returns:

Builder

placement

public ObjectStoreConfiguration.Builder placement(Placement placement)

Sets the placement directive object

Overrides:

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

Parameters:

placement - the placement directive object

Returns:

Builder

compression

public ObjectStoreConfiguration.Builder compression(boolean compression)

Sets whether to use compression for the ObjectStoreConfiguration. If set, will use the default compression algorithm of the Object Store backing.

Overrides:

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

Parameters:

compression - whether to use compression in the ObjectStoreConfiguration

Returns:

Builder

metadata

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

Sets the metadata for the ObjectStoreConfiguration

Overrides:

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

Parameters:

metadata - the metadata map

Returns:

Builder

build

public ObjectStoreConfiguration build()

Builds the ObjectStoreConfiguration

Specified by:

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

Returns:

the ObjectStoreConfiguration.