io.nats.client.api

Class ObjectStoreStatus

java.lang.Object

io.nats.client.api.ObjectStoreStatus

public class ObjectStoreStatus
extends java.lang.Object

The ObjectStoreStatus class contains information about an object store.

Constructor Summary

Constructors

Constructor and Description
ObjectStoreStatus(StreamInfo si)

Method Summary

Modifier and Type	Method and Description
@NonNull java.lang.String	getBackingStore() Gets the name of the type of backing store, currently only "JetStream"
@NonNull StreamInfo	getBackingStreamInfo() Gets the info for the stream which backs the bucket.
@NonNull java.lang.String	getBucketName() Get the name of the object store
@NonNull ObjectStoreConfiguration	getConfiguration() Gets the configuration object directly
@Nullable java.lang.String	getDescription() Gets the description of this bucket.
long	getMaxBucketSize() Gets the maximum number of bytes for this bucket.
@Nullable java.util.Map<java.lang.String,java.lang.String>	getMetadata() Get the metadata for the store
@Nullable Placement	getPlacement() Gets the placement directive for the store.
int	getReplicas() Gets the number of replicas for this store.
long	getSize() Get the combined size of all data in the bucket including metadata, in bytes
@NonNull StorageType	getStorageType() Gets the storage type for this bucket.
@Nullable java.time.Duration	getTtl() Gets the maximum age for a value in this store.
boolean	isCompressed() Gets the state of compression
boolean	isSealed() If true, indicates the store is sealed and cannot be modified in any way
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ObjectStoreStatus

public ObjectStoreStatus(StreamInfo si)

Method Detail

getBucketName

public @NonNull java.lang.String getBucketName()

Get the name of the object store

Returns:

the name

getDescription

public @Nullable java.lang.String getDescription()

Gets the description of this bucket.

Returns:

the description of the bucket.

getBackingStreamInfo

public @NonNull StreamInfo getBackingStreamInfo()

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

Returns:

the stream info

getConfiguration

public @NonNull ObjectStoreConfiguration getConfiguration()

Gets the configuration object directly

Returns:

the configuration.

getSize

public long getSize()

Get the combined size of all data in the bucket including metadata, in bytes

Returns:

the size

getMaxBucketSize

public long getMaxBucketSize()

Gets the maximum number of bytes for this bucket.

Returns:

the maximum number of bytes for this bucket.

isSealed

public boolean isSealed()

If true, indicates the store is sealed and cannot be modified in any way

Returns:

the sealed setting

getTtl

public @Nullable java.time.Duration getTtl()

Gets the maximum age for a value in this store.

Returns:

the maximum age.

getStorageType

public @NonNull 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 store.

Returns:

the number of replicas

getPlacement

public @Nullable Placement getPlacement()

Gets the placement directive for the store.

Returns:

the placement

isCompressed

public boolean isCompressed()

Gets the state of compression

Returns:

true if compression is used

getMetadata

public @Nullable 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 @NonNull 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