io.nats.client.api

Class KeyValueConfiguration

java.lang.Object

io.nats.client.api.KeyValueConfiguration

public class KeyValueConfiguration
extends java.lang.Object

The KeyValueConfiguration class contains the configuration for of a Key Value bucket.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	KeyValueConfiguration.Builder KeyValueConfiguration is created using a Builder.

Method Summary

Modifier and Type	Method and Description
static KeyValueConfiguration.Builder	builder() Creates a builder for the Key Value Configuration.
static KeyValueConfiguration.Builder	builder(KeyValueConfiguration kvc) Creates a builder to copy the key value configuration.
StreamConfiguration	getBackingConfig() Gets the stream configuration for the stream which backs the bucket
java.lang.String	getBucketName() Gets the name of this bucket.
java.lang.String	getDescription() Gets the description of this bucket.
long	getMaxBucketSize() Gets the maximum number of bytes for this bucket.
long	getMaxHistoryPerKey() Gets the maximum number of history for any one key.
long	getMaxValueSize() Gets the maximum size for an individual value in the bucket.
int	getReplicas() Gets the number of replicas for this bucket.
StorageType	getStorageType() Gets the storage type for this bucket.
java.time.Duration	getTtl() Gets the maximum age for a value in this bucket.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

getBackingConfig

public StreamConfiguration getBackingConfig()

Gets the stream configuration for the stream which backs the bucket

Returns:

the stream configuration

getBucketName

public java.lang.String getBucketName()

Gets the name of this bucket.

Returns:

the name of the bucket.

getDescription

public java.lang.String getDescription()

Gets the description of this bucket.

Returns:

the description of the bucket.

getMaxHistoryPerKey

public long getMaxHistoryPerKey()

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

Returns:

the maximum number of values for any one key.

getMaxBucketSize

public long getMaxBucketSize()

Gets the maximum number of bytes for this bucket.

Returns:

the maximum number of bytes for this bucket.

getMaxValueSize

public long getMaxValueSize()

Gets the maximum size for an individual value in the bucket.

Returns:

the maximum size for a value.

getTtl

public java.time.Duration getTtl()

Gets the maximum age for a value in this bucket.

Returns:

the maximum age.

getStorageType

public StorageType getStorageType()

Gets the storage type for this bucket.

Returns:

the storage type for this stream.

getReplicas

public int getReplicas()

Gets the number of replicas for this bucket.

Returns:

the number of replicas

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

builder

public static KeyValueConfiguration.Builder builder()

Creates a builder for the Key Value Configuration.

Returns:

a key value configuration builder

builder

public static KeyValueConfiguration.Builder builder(KeyValueConfiguration kvc)

Creates a builder to copy the key value configuration.

Parameters:

kvc - an existing KeyValueConfiguration

Returns:

a stream configuration builder