io.nats.client.api

Class KeyValueConfiguration

java.lang.Object

io.nats.client.api.FeatureConfiguration

io.nats.client.api.KeyValueConfiguration

public class KeyValueConfiguration
extends FeatureConfiguration

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.

Field Summary

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

bucketName, sc

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.
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.
Republish	getRepublish() Get the republish configuration.
java.lang.String	toString()

Methods inherited from class io.nats.client.api.FeatureConfiguration

getBackingConfig, getBucketName, getDescription, getPlacement, getReplicas, getStorageType, getTtl

Methods inherited from class java.lang.Object

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

Method Detail

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.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getRepublish

public Republish getRepublish()

Get the republish configuration. Might be null.

Returns:

the republish 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 KeyValueConfiguration builder