io.nats.client.api

Class KeyValueConfiguration

java.lang.Object

io.nats.client.api.FeatureConfiguration

io.nats.client.api.KeyValueConfiguration

All Implemented Interfaces:

JsonSerializable

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, JS_COMPRESSION_NO, JS_COMPRESSION_YES, 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.
static KeyValueConfiguration.Builder	builder(java.lang.String name) Creates a builder for the Key Value Configuration.
@Nullable java.time.Duration	getLimitMarkerTtl() The limit marker ttl if set
long	getMaxHistoryPerKey() Gets the maximum number of history for any one key.
int	getMaximumValueSize() Gets the maximum size for an individual value in the bucket.
long	getMaxValueSize() Deprecated. the server value is a 32-bit signed value. Use getMaximumValueSize() instead.
@Nullable Mirror	getMirror() The mirror definition for this configuration
@Nullable Republish	getRepublish() Get the republish configuration.
@Nullable java.util.List<Source>	getSources() The sources for this configuration
@NonNull JsonValue	toJsonValue()
java.lang.String	toString()

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

getBackingConfig, getBucketName, getDescription, getMaxBucketSize, getMetadata, getPlacement, getReplicas, getStorageType, getTtl, isCompressed, toJson

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.nats.client.support.JsonSerializable

serialize

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.

getMaxValueSize

@Deprecated
public long getMaxValueSize()

Deprecated. the server value is a 32-bit signed value. Use getMaximumValueSize() instead.

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

Returns:

the maximum size for a value.

getMaximumValueSize

public int getMaximumValueSize()

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

Returns:

the maximum size for a value.

getRepublish

public @Nullable Republish getRepublish()

Get the republish configuration. Might be null.

Returns:

the republish object

getMirror

public @Nullable Mirror getMirror()

The mirror definition for this configuration

Returns:

the mirror

getSources

public @Nullable java.util.List<Source> getSources()

The sources for this configuration

Returns:

the sources

getLimitMarkerTtl

public @Nullable java.time.Duration getLimitMarkerTtl()

The limit marker ttl if set

Returns:

the duration

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

toJsonValue

public @NonNull JsonValue toJsonValue()

Specified by:

toJsonValue in interface JsonSerializable

Overrides:

toJsonValue in class FeatureConfiguration

builder

public static KeyValueConfiguration.Builder builder()

Creates a builder for the Key Value Configuration.

Returns:

a KeyValueConfiguration Builder

builder

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

Creates a builder for the Key Value Configuration.

Parameters:

name - the name of the key value bucket

Returns:

a KeyValueConfiguration 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