StreamConfiguration.Builder (NATS.IO Java API)

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

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`StreamConfiguration.Builder`	`addSources(java.util.Collection<Source> sources)` Sets the sources in the StreamConfiguration.
`StreamConfiguration.Builder`	`addSources(Source... sources)` Sets the sources in the StreamConfiguration.
`StreamConfiguration.Builder`	`addSubjects(java.util.Collection<java.lang.String> subjects)` Sets the subjects in the StreamConfiguration.
`StreamConfiguration.Builder`	`addSubjects(java.lang.String... subjects)` Sets the subjects in the StreamConfiguration.
`StreamConfiguration`	`build()` Builds the StreamConfiguration
`StreamConfiguration.Builder`	`description(java.lang.String description)` Sets the description
`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 the StreamConfiguration.
`StreamConfiguration.Builder`	`duplicateWindow(long windowMillis)` Sets the duplicate checking window in the the StreamConfiguration.
`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`	`mirror(Mirror mirror)` Sets the mirror object
`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`	`retentionPolicy(RetentionPolicy policy)` Sets the retention policy in the StreamConfiguration.
`StreamConfiguration.Builder`	`sources(java.util.Collection<Source> sources)` Sets the sources in 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`	`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)
```
    Sets the subjects in the StreamConfiguration.
    
    Parameters:
    
    subjects - the stream's subjects
    
    Returns:
    
    Builder
  - addSubjects
```
public StreamConfiguration.Builder addSubjects(java.util.Collection<java.lang.String> subjects)
```
    Sets the subjects in the StreamConfiguration.
    
    Parameters:
    
    subjects - the stream's subjects
    
    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
  - 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.
    
    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 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 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
  - 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)
```
    Sets the sources in the StreamConfiguration.
    
    Parameters:
    
    sources - the stream's sources
    
    Returns:
    
    Builder
  - addSources
```
public StreamConfiguration.Builder addSources(Source... sources)
```
    Sets the sources in 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
  - build
```
public StreamConfiguration build()
```
    Builds the StreamConfiguration
    
    Returns:
    
    a stream configuration.

Class StreamConfiguration.Builder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Builder

Builder

Method Detail

name

description

subjects

subjects

addSubjects

addSubjects

retentionPolicy

maxConsumers

maxMessages

maxMessagesPerSubject

maxBytes

maxAge

maxAge

maxMsgSize

storageType

replicas

noAck

templateOwner

discardPolicy

duplicateWindow

duplicateWindow

placement

mirror

sources

sources

addSources

addSources

build