io.nats.client.api

Class FeatureConfiguration

java.lang.Object

io.nats.client.api.FeatureConfiguration

All Implemented Interfaces:

io.nats.client.support.JsonSerializable

Direct Known Subclasses:

KeyValueConfiguration, ObjectStoreConfiguration

public abstract class FeatureConfiguration
extends java.lang.Object
implements io.nats.client.support.JsonSerializable

base class for feature configurations

Constructor Summary

Constructors

Constructor and Description
FeatureConfiguration(StreamConfiguration sc, java.lang.String bucketName) Construct a FeatureConfiguration from a StreamConfiguration and a bucket name

Method Summary

Modifier and Type	Method and Description
@NonNull StreamConfiguration	getBackingConfig() Gets the stream configuration for the stream which backs the bucket
@NonNull java.lang.String	getBucketName() Gets the name of this bucket.
@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 feature
@Nullable Placement	getPlacement() Placement directives to consider when placing replicas of this stream, random placement when unset
int	getReplicas() Gets the number of replicas for this bucket.
@Nullable StorageType	getStorageType() Gets the storage type for this bucket.
@Nullable java.time.Duration	getTtl() Gets the maximum age for a value in this bucket.
boolean	isCompressed() Gets the state of compression
@NonNull java.lang.String	toJson()
@NonNull io.nats.client.support.JsonValue	toJsonValue()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

serialize

Constructor Detail

FeatureConfiguration

public FeatureConfiguration(StreamConfiguration sc,
                            java.lang.String bucketName)

Construct a FeatureConfiguration from a StreamConfiguration and a bucket name

Parameters:

sc - the StreamConfiguration

bucketName - the bucket name

Method Detail

toJson

public @NonNull java.lang.String toJson()

Specified by:

toJson in interface io.nats.client.support.JsonSerializable

toJsonValue

public @NonNull io.nats.client.support.JsonValue toJsonValue()

Specified by:

toJsonValue in interface io.nats.client.support.JsonSerializable

getBackingConfig

public @NonNull StreamConfiguration getBackingConfig()

Gets the stream configuration for the stream which backs the bucket

Returns:

the stream configuration

getBucketName

public @NonNull java.lang.String getBucketName()

Gets the name of this bucket.

Returns:

the name of the bucket.

getDescription

public @Nullable java.lang.String getDescription()

Gets the description of this bucket.

Returns:

the description of the bucket.

getMaxBucketSize

public long getMaxBucketSize()

Gets the maximum number of bytes for this bucket.

Returns:

the maximum number of bytes for this bucket.

getTtl

public @Nullable java.time.Duration getTtl()

Gets the maximum age for a value in this bucket.

Returns:

the maximum age.

getStorageType

public @Nullable 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 @Nullable Placement getPlacement()

Placement directives to consider when placing replicas of this stream, random placement when unset

Returns:

the placement [directive object]

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 feature

Returns:

the metadata map. Might be null.