io.nats.client.api

Class KeyValueStatus

java.lang.Object

io.nats.client.api.KeyValueStatus

public class KeyValueStatus
extends java.lang.Object

The KeyValueStatus class contains information about a Key Value Bucket.

Constructor Summary

Constructors

Constructor and Description
KeyValueStatus(StreamInfo si)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getBackingStore() Gets the name of the type of backing store, currently only "JetStream"
StreamInfo	getBackingStreamInfo() Gets the info for the stream which backs the bucket.
java.lang.String	getBucketName() Get the name of the bucket
long	getByteCount() Get the size of the bucket in bytes
KeyValueConfiguration	getConfiguration() Gets the configuration object directly
java.lang.String	getDescription() Gets the description of this bucket.
long	getEntryCount() Get the number of total entries in the bucket, including historical entries
long	getMaxBucketSize() Gets the maximum number of bytes for this bucket.
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.
java.util.Map<java.lang.String,java.lang.String>	getMetadata() Get the metadata for the store
Placement	getPlacement() Gets the placement directive for the store.
int	getReplicas() Gets the number of replicas for this bucket.
Republish	getRepublish() Gets the republish configuration
StorageType	getStorageType() Gets the storage type for this bucket.
java.time.Duration	getTtl() Gets the maximum age for a value in this bucket.
boolean	isCompressed() Gets the state of compression
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

KeyValueStatus

public KeyValueStatus(StreamInfo si)

Method Detail

getBucketName

public java.lang.String getBucketName()

Get the name of the bucket

Returns:

the name

getDescription

public java.lang.String getDescription()

Gets the description of this bucket.

Returns:

the description of the bucket.

getBackingStreamInfo

public StreamInfo getBackingStreamInfo()

Gets the info for the stream which backs the bucket. Valid for BackingStore "JetStream"

Returns:

the stream info

getConfiguration

public KeyValueConfiguration getConfiguration()

Gets the configuration object directly

Returns:

the configuration.

getEntryCount

public long getEntryCount()

Get the number of total entries in the bucket, including historical entries

Returns:

the count of entries

getByteCount

public long getByteCount()

Get the size of the bucket in bytes

Returns:

the number of bytes

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

@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 a value.

getMaximumValueSize

public int getMaximumValueSize()

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

Returns:

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

getPlacement

public Placement getPlacement()

Gets the placement directive for the store.

Returns:

the placement

getRepublish

public Republish getRepublish()

Gets the republish configuration

Returns:

the republish object

isCompressed

public boolean isCompressed()

Gets the state of compression

Returns:

true if compression is used

getMetadata

public java.util.Map<java.lang.String,java.lang.String> getMetadata()

Get the metadata for the store

Returns:

the metadata map. Might be null.

getBackingStore

public java.lang.String getBackingStore()

Gets the name of the type of backing store, currently only "JetStream"

Returns:

the name of the store, currently only "JetStream"

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object