io.nats.client.api

Class BucketConfiguration

java.lang.Object

io.nats.client.api.BucketConfiguration

public class BucketConfiguration
extends java.lang.Object

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static BucketConfiguration.Builder	builder() Creates a builder for the stream configuration.
static BucketConfiguration.Builder	builder(BucketConfiguration bc) Creates a builder to copy the stream configuration.
StreamConfiguration	getBackingConfig()
java.time.Duration	getDuplicateWindow() Gets the duplicate checking window bucket.
long	getMaxBucketSize() Gets the maximum number of bytes for this bucket.
long	getMaxHistory() Gets the maximum number of history for any one key.
long	getMaxValues() Gets the maximum number of values across all keys, including history values
long	getMaxValueSize() Gets the maximum number of bytes for an individual value in the bucket.
java.lang.String	getName() Gets the name of this 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()

getName

public java.lang.String getName()

Gets the name of this bucket.

Returns:

the name of the bucket.

getMaxValues

public long getMaxValues()

Gets the maximum number of values across all keys, including history values

Returns:

the maximum number of values for the bucket

getMaxHistory

public long getMaxHistory()

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 number of bytes for an individual value in the bucket.

Returns:

the maximum bytes 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

getDuplicateWindow

public java.time.Duration getDuplicateWindow()

Gets the duplicate checking window bucket. Duration.ZERO means duplicate checking is not enabled.

Returns:

the duration of the window.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

builder

public static BucketConfiguration.Builder builder()

Creates a builder for the stream configuration.

Returns:

a stream configuration builder

builder

public static BucketConfiguration.Builder builder(BucketConfiguration bc)

Creates a builder to copy the stream configuration.

Parameters:

bc - an existing StreamConfiguration

Returns:

a stream configuration builder