io.nats.client.api

Class StreamConfiguration

java.lang.Object

io.nats.client.api.StreamConfiguration

All Implemented Interfaces:

JsonSerializable

public class StreamConfiguration
extends java.lang.Object
implements JsonSerializable

The StreamConfiguration class specifies the configuration for creating a JetStream stream on the server. Options are created using a Builder.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static StreamConfiguration.Builder	builder() Creates a builder for the stream configuration.
static StreamConfiguration.Builder	builder(StreamConfiguration sc) Creates a builder to copy the stream configuration.
DiscardPolicy	getDiscardPolicy() Gets the discard policy for this stream configuration.
java.time.Duration	getDuplicateWindow() Gets the duplicate checking window stream configuration.
java.time.Duration	getMaxAge() Gets the maximum message age for this stream configuration.
long	getMaxBytes() Gets the maximum number of bytes for this stream configuration.
long	getMaxConsumers() Gets the maximum number of consumers for this stream configuration.
long	getMaxMsgs() Gets the maximum messages for this stream configuration.
long	getMaxMsgSize() Gets the maximum message size for this stream configuration.
Mirror	getMirror() The mirror definition for this stream
java.lang.String	getName() Gets the name of this stream configuration.
boolean	getNoAck() Gets whether or not acknowledgements are required in this stream configuration.
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 stream configuration.
RetentionPolicy	getRetentionPolicy() Gets the retention policy for this stream configuration.
java.util.List<Source>	getSources() The sources for this stream
StorageType	getStorageType() Gets the storate type for this stream configuration.
java.util.List<java.lang.String>	getSubjects() Gets the subjects for this stream configuration.
java.lang.String	getTemplateOwner() Gets the template json for this stream configuration.
java.lang.String	toJson() Returns a JSON representation of this consumer configuration.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

toJson

public java.lang.String toJson()

Returns a JSON representation of this consumer configuration.

Specified by:

toJson in interface JsonSerializable

Returns:

json consumer configuration to send to the server.

getName

public java.lang.String getName()

Gets the name of this stream configuration.

Returns:

the name of the stream.

getSubjects

public java.util.List<java.lang.String> getSubjects()

Gets the subjects for this stream configuration.

Returns:

the subject of the stream.

getDiscardPolicy

public DiscardPolicy getDiscardPolicy()

Gets the discard policy for this stream configuration.

Returns:

the discard policy of the stream.

getRetentionPolicy

public RetentionPolicy getRetentionPolicy()

Gets the retention policy for this stream configuration.

Returns:

the retention policy for this stream.

getMaxConsumers

public long getMaxConsumers()

Gets the maximum number of consumers for this stream configuration.

Returns:

the maximum number of consumers for this stream.

getMaxMsgs

public long getMaxMsgs()

Gets the maximum messages for this stream configuration.

Returns:

the maximum number of messages for this stream.

getMaxBytes

public long getMaxBytes()

Gets the maximum number of bytes for this stream configuration.

Returns:

the maximum number of bytes for this stream.

getMaxAge

public java.time.Duration getMaxAge()

Gets the maximum message age for this stream configuration.

Returns:

the maximum message age for this stream.

getMaxMsgSize

public long getMaxMsgSize()

Gets the maximum message size for this stream configuration.

Returns:

the maximum message size for this stream.

getStorageType

public StorageType getStorageType()

Gets the storate type for this stream configuration.

Returns:

the storage type for this stream.

getReplicas

public int getReplicas()

Gets the number of replicas for this stream configuration.

Returns:

the number of replicas

getNoAck

public boolean getNoAck()

Gets whether or not acknowledgements are required in this stream configuration.

Returns:

true if acknowedgments are not required.

getTemplateOwner

public java.lang.String getTemplateOwner()

Gets the template json for this stream configuration.

Returns:

the template for this stream.

getDuplicateWindow

public java.time.Duration getDuplicateWindow()

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

Returns:

the duration of the window.

getPlacement

public Placement getPlacement()

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

Returns:

the placement [directive object]

getMirror

public Mirror getMirror()

The mirror definition for this stream

Returns:

the mirror

getSources

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

The sources for this stream

Returns:

the sources

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

builder

public static StreamConfiguration.Builder builder()

Creates a builder for the stream configuration.

Returns:

a stream configuration builder

builder

public static StreamConfiguration.Builder builder(StreamConfiguration sc)

Creates a builder to copy the stream configuration.

Parameters:

sc - an existing StreamConfiguration

Returns:

a stream configuration builder