io.nats.client.api

Class StreamConfiguration.Builder

java.lang.Object

io.nats.client.api.StreamConfiguration.Builder

Enclosing class:

StreamConfiguration

public static class StreamConfiguration.Builder
extends java.lang.Object

StreamConfiguration is created using a Builder. The builder supports chaining and will create a default set of options if no methods are calls.

new StreamConfiguration.Builder().build() will create a new StreamConfiguration.

Constructor Summary

Constructors

Constructor and Description
Builder() Default Builder
Builder(StreamConfiguration sc) Update Builder, useful if you need to update a configuration

Method Summary

Modifier and Type	Method and Description
StreamConfiguration.Builder	addSource(Source source) Add a source into the StreamConfiguration.
StreamConfiguration.Builder	addSources(java.util.Collection<Source> sources) Sets the sources in the StreamConfiguration.
StreamConfiguration.Builder	addSources(Source... sources) Add the sources into the StreamConfiguration.
StreamConfiguration.Builder	addSubjects(java.util.Collection<java.lang.String> subjects) Adds unique subjects into the StreamConfiguration.
StreamConfiguration.Builder	addSubjects(java.lang.String... subjects) Adds unique subjects into the StreamConfiguration.
StreamConfiguration.Builder	allowDirect(boolean allowDirect) Set whether to allow direct message access for a stream
StreamConfiguration.Builder	allowRollup(boolean allowRollup) Set whether to allow the rollup feature for a stream
StreamConfiguration	build() Builds the StreamConfiguration
StreamConfiguration.Builder	compressionOption(CompressionOption compressionOption) Sets the compression option in the StreamConfiguration.
StreamConfiguration.Builder	consumerLimits(ConsumerLimits consumerLimits) Sets the consumerLimits config object
StreamConfiguration.Builder	denyDelete(boolean denyDelete) Set whether to deny deleting messages from the stream
StreamConfiguration.Builder	denyPurge(boolean denyPurge) Set whether to deny purging messages from the stream
StreamConfiguration.Builder	description(java.lang.String description) Sets the description
StreamConfiguration.Builder	discardNewPerSubject(boolean discardNewPerSubject) Set whether discard policy new with max message per subject applies to existing subjects, not just new subjects.
StreamConfiguration.Builder	discardPolicy(DiscardPolicy policy) Sets the discard policy in the StreamConfiguration.
StreamConfiguration.Builder	duplicateWindow(java.time.Duration window) Sets the duplicate checking window in the StreamConfiguration.
StreamConfiguration.Builder	duplicateWindow(long windowMillis) Sets the duplicate checking window in the StreamConfiguration.
StreamConfiguration.Builder	firstSequence(long firstSeq) Sets the first sequence to be used.
StreamConfiguration.Builder	maxAge(java.time.Duration maxAge) Sets the maximum age in the StreamConfiguration.
StreamConfiguration.Builder	maxAge(long maxAgeMillis) Sets the maximum age in the StreamConfiguration.
StreamConfiguration.Builder	maxBytes(long maxBytes) Sets the maximum number of bytes in the StreamConfiguration.
StreamConfiguration.Builder	maxConsumers(long maxConsumers) Sets the maximum number of consumers in the StreamConfiguration.
StreamConfiguration.Builder	maxMessages(long maxMsgs) Sets the maximum number of messages in the StreamConfiguration.
StreamConfiguration.Builder	maxMessagesPerSubject(long maxMsgsPerSubject) Sets the maximum number of message per subject in the StreamConfiguration.
StreamConfiguration.Builder	maxMsgSize(long maxMsgSize) Sets the maximum message size in the StreamConfiguration.
StreamConfiguration.Builder	metadata(java.util.Map<java.lang.String,java.lang.String> metadata) Sets the metadata for the configuration
StreamConfiguration.Builder	mirror(Mirror mirror) Sets the mirror object
StreamConfiguration.Builder	mirrorDirect(boolean mirrorDirect) Set whether to allow unified direct access for mirrors
StreamConfiguration.Builder	name(java.lang.String name) Sets the name of the stream.
StreamConfiguration.Builder	noAck(boolean noAck) Sets the acknowledgement mode of the StreamConfiguration.
StreamConfiguration.Builder	placement(Placement placement) Sets the placement directive object
StreamConfiguration.Builder	replicas(int replicas) Sets the number of replicas a message must be stored on in the StreamConfiguration.
StreamConfiguration.Builder	republish(Republish republish) Sets the republish config object
StreamConfiguration.Builder	retentionPolicy(RetentionPolicy policy) Sets the retention policy in the StreamConfiguration.
StreamConfiguration.Builder	seal() Set this stream to be sealed.
protected StreamConfiguration.Builder	sealed(boolean sealed) Set whether to seal the stream.
StreamConfiguration.Builder	sources(java.util.Collection<Source> sources) Add the sources into the StreamConfiguration.
StreamConfiguration.Builder	sources(Source... sources) Sets the sources in the StreamConfiguration.
StreamConfiguration.Builder	storageType(StorageType storageType) Sets the storage type in the StreamConfiguration.
StreamConfiguration.Builder	subjects(java.util.Collection<java.lang.String> subjects) Sets the subjects in the StreamConfiguration.
StreamConfiguration.Builder	subjects(java.lang.String... subjects) Sets the subjects in the StreamConfiguration.
StreamConfiguration.Builder	subjectTransform(SubjectTransform subjectTransform) Sets the subjectTransform config object
StreamConfiguration.Builder	templateOwner(java.lang.String templateOwner) Sets the template a stream in the form of raw JSON.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Default Builder

Builder

public Builder(StreamConfiguration sc)

Update Builder, useful if you need to update a configuration

Parameters:

sc - the configuration to copy

Method Detail

name

public StreamConfiguration.Builder name(java.lang.String name)

Sets the name of the stream.

Parameters:

name - name of the stream.

Returns:

the builder

description

public StreamConfiguration.Builder description(java.lang.String description)

Sets the description

Parameters:

description - the description

Returns:

the builder

subjects

public StreamConfiguration.Builder subjects(java.lang.String... subjects)

Sets the subjects in the StreamConfiguration.

Parameters:

subjects - the stream's subjects

Returns:

Builder

subjects

public StreamConfiguration.Builder subjects(java.util.Collection<java.lang.String> subjects)

Sets the subjects in the StreamConfiguration.

Parameters:

subjects - the stream's subjects

Returns:

Builder

addSubjects

public StreamConfiguration.Builder addSubjects(java.lang.String... subjects)

Adds unique subjects into the StreamConfiguration.

Parameters:

subjects - the stream's subjects to add

Returns:

Builder

addSubjects

public StreamConfiguration.Builder addSubjects(java.util.Collection<java.lang.String> subjects)

Adds unique subjects into the StreamConfiguration.

Parameters:

subjects - the stream's subjects to add

Returns:

Builder

retentionPolicy

public StreamConfiguration.Builder retentionPolicy(RetentionPolicy policy)

Sets the retention policy in the StreamConfiguration.

Parameters:

policy - the retention policy of the StreamConfiguration

Returns:

Builder

compressionOption

public StreamConfiguration.Builder compressionOption(CompressionOption compressionOption)

Sets the compression option in the StreamConfiguration.

Parameters:

compressionOption - the compression option of the StreamConfiguration

Returns:

Builder

maxConsumers

public StreamConfiguration.Builder maxConsumers(long maxConsumers)

Sets the maximum number of consumers in the StreamConfiguration.

Parameters:

maxConsumers - the maximum number of consumers

Returns:

Builder

maxMessages

public StreamConfiguration.Builder maxMessages(long maxMsgs)

Sets the maximum number of messages in the StreamConfiguration.

Parameters:

maxMsgs - the maximum number of messages

Returns:

Builder

maxMessagesPerSubject

public StreamConfiguration.Builder maxMessagesPerSubject(long maxMsgsPerSubject)

Sets the maximum number of message per subject in the StreamConfiguration.

Parameters:

maxMsgsPerSubject - the maximum number of messages

Returns:

Builder

maxBytes

public StreamConfiguration.Builder maxBytes(long maxBytes)

Sets the maximum number of bytes in the StreamConfiguration.

Parameters:

maxBytes - the maximum number of bytes

Returns:

Builder

maxAge

public StreamConfiguration.Builder maxAge(java.time.Duration maxAge)

Sets the maximum age in the StreamConfiguration.

Parameters:

maxAge - the maximum message age

Returns:

Builder

maxAge

public StreamConfiguration.Builder maxAge(long maxAgeMillis)

Sets the maximum age in the StreamConfiguration.

Parameters:

maxAgeMillis - the maximum message age

Returns:

Builder

maxMsgSize

public StreamConfiguration.Builder maxMsgSize(long maxMsgSize)

Sets the maximum message size in the StreamConfiguration.

Parameters:

maxMsgSize - the maximum message size

Returns:

Builder

storageType

public StreamConfiguration.Builder storageType(StorageType storageType)

Sets the storage type in the StreamConfiguration.

Parameters:

storageType - the storage type

Returns:

Builder

replicas

public StreamConfiguration.Builder replicas(int replicas)

Sets the number of replicas a message must be stored on in the StreamConfiguration. Must be 1 to 5 inclusive

Parameters:

replicas - the number of replicas to store this message on

Returns:

Builder

noAck

public StreamConfiguration.Builder noAck(boolean noAck)

Sets the acknowledgement mode of the StreamConfiguration. if no acknowledgements are set, then acknowledgements are not sent back to the client. The default is false.

Parameters:

noAck - true to disable acknowledgements.

Returns:

Builder

templateOwner

public StreamConfiguration.Builder templateOwner(java.lang.String templateOwner)

Sets the template a stream in the form of raw JSON.

Parameters:

templateOwner - the stream template of the stream.

Returns:

the builder

discardPolicy

public StreamConfiguration.Builder discardPolicy(DiscardPolicy policy)

Sets the discard policy in the StreamConfiguration.

Parameters:

policy - the discard policy of the StreamConfiguration

Returns:

Builder

duplicateWindow

public StreamConfiguration.Builder duplicateWindow(java.time.Duration window)

Sets the duplicate checking window in the StreamConfiguration. A Duration.Zero disables duplicate checking. Duplicate checking is disabled by default.

Parameters:

window - duration to hold message ids for duplicate checking.

Returns:

Builder

duplicateWindow

public StreamConfiguration.Builder duplicateWindow(long windowMillis)

Sets the duplicate checking window in the StreamConfiguration. A Duration.Zero disables duplicate checking. Duplicate checking is disabled by default.

Parameters:

windowMillis - duration to hold message ids for duplicate checking.

Returns:

Builder

placement

public StreamConfiguration.Builder placement(Placement placement)

Sets the placement directive object

Parameters:

placement - the placement directive object

Returns:

Builder

republish

public StreamConfiguration.Builder republish(Republish republish)

Sets the republish config object

Parameters:

republish - the republish config object

Returns:

Builder

subjectTransform

public StreamConfiguration.Builder subjectTransform(SubjectTransform subjectTransform)

Sets the subjectTransform config object

Parameters:

subjectTransform - the subjectTransform config object

Returns:

Builder

consumerLimits

public StreamConfiguration.Builder consumerLimits(ConsumerLimits consumerLimits)

Sets the consumerLimits config object

Parameters:

consumerLimits - the consumerLimits config object

Returns:

Builder

mirror

public StreamConfiguration.Builder mirror(Mirror mirror)

Sets the mirror object

Parameters:

mirror - the mirror object

Returns:

Builder

sources

public StreamConfiguration.Builder sources(Source... sources)

Sets the sources in the StreamConfiguration.

Parameters:

sources - the stream's sources

Returns:

Builder

sources

public StreamConfiguration.Builder sources(java.util.Collection<Source> sources)

Add the sources into the StreamConfiguration.

Parameters:

sources - the stream's sources

Returns:

Builder

addSources

public StreamConfiguration.Builder addSources(Source... sources)

Add the sources into the StreamConfiguration.

Parameters:

sources - the stream's sources

Returns:

Builder

addSources

public StreamConfiguration.Builder addSources(java.util.Collection<Source> sources)

Sets the sources in the StreamConfiguration.

Parameters:

sources - the stream's sources

Returns:

Builder

addSource

public StreamConfiguration.Builder addSource(Source source)

Add a source into the StreamConfiguration.

Parameters:

source - a stream source

Returns:

Builder

sealed

protected StreamConfiguration.Builder sealed(boolean sealed)

Set whether to seal the stream. INTERNAL USE ONLY. Scoped protected for test purposes.

Parameters:

sealed - the sealed setting

Returns:

Builder

allowRollup

public StreamConfiguration.Builder allowRollup(boolean allowRollup)

Set whether to allow the rollup feature for a stream

Parameters:

allowRollup - the allow rollup setting

Returns:

Builder

allowDirect

public StreamConfiguration.Builder allowDirect(boolean allowDirect)

Set whether to allow direct message access for a stream

Parameters:

allowDirect - the allow direct setting

Returns:

Builder

mirrorDirect

public StreamConfiguration.Builder mirrorDirect(boolean mirrorDirect)

Set whether to allow unified direct access for mirrors

Parameters:

mirrorDirect - the allow direct setting

Returns:

Builder

denyDelete

public StreamConfiguration.Builder denyDelete(boolean denyDelete)

Set whether to deny deleting messages from the stream

Parameters:

denyDelete - the deny delete setting

Returns:

Builder

denyPurge

public StreamConfiguration.Builder denyPurge(boolean denyPurge)

Set whether to deny purging messages from the stream

Parameters:

denyPurge - the deny purge setting

Returns:

Builder

discardNewPerSubject

public StreamConfiguration.Builder discardNewPerSubject(boolean discardNewPerSubject)

Set whether discard policy new with max message per subject applies to existing subjects, not just new subjects.

Parameters:

discardNewPerSubject - the setting

Returns:

Builder

seal

public StreamConfiguration.Builder seal()

Set this stream to be sealed. This is irreversible.

Returns:

Builder

metadata

public StreamConfiguration.Builder metadata(java.util.Map<java.lang.String,java.lang.String> metadata)

Sets the metadata for the configuration

Parameters:

metadata - the metadata map

Returns:

Builder

firstSequence

public StreamConfiguration.Builder firstSequence(long firstSeq)

Sets the first sequence to be used. 1 is the default. All values less than 2 are treated as 1.

Parameters:

firstSeq - specify the first_seq in the stream config when creating the stream.

Returns:

Builder

build

public StreamConfiguration build()

Builds the StreamConfiguration

Returns:

a stream configuration.