StreamConfiguration (NATS.IO Java API)

java.lang.Object
- io.nats.client.api.StreamConfiguration

All Implemented Interfaces:

io.nats.client.support.JsonSerializable
```
public class StreamConfiguration
extends java.lang.Object
implements io.nats.client.support.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.

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
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.
`boolean`	`getAllowAtomicPublish()` Whether Allow Atomic Publish is set
`boolean`	`getAllowDirect()` Get the flag indicating if the stream allows direct message access.
`boolean`	`getAllowMessageCounter()` Whether Allow Message Counter is set
`boolean`	`getAllowMessageTtl()` Whether Allow Message TTL is set
`boolean`	`getAllowMsgSchedules()` Whether Allow Message Schedules is set
`boolean`	`getAllowRollup()` Get the flag indicating if the stream allows rollup.
`@Nullable CompressionOption`	`getCompressionOption()` Gets the compression option for this stream configuration.
`@Nullable ConsumerLimits`	`getConsumerLimits()` Get the consumerLimits configuration.
`boolean`	`getDenyDelete()` Get the flag indicating if deny delete is set for the stream
`boolean`	`getDenyPurge()` Get the flag indicating if deny purge is set for the stream
`@Nullable java.lang.String`	`getDescription()` Gets the description of this stream configuration.
`@Nullable DiscardPolicy`	`getDiscardPolicy()` Gets the discard policy for this stream configuration.
`@Nullable java.time.Duration`	`getDuplicateWindow()` Gets the duplicate checking window stream configuration.
`long`	`getFirstSequence()` The first sequence used in the stream.
`@NonNull 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.
`int`	`getMaximumMessageSize()` Gets the maximum message size for this stream configuration.
`long`	`getMaxMsgs()` Gets the maximum messages for this stream configuration.
`long`	`getMaxMsgSize()` Deprecated. the server value is a 32-bit signed value. Use `getMaximumMessageSize()` instead.
`long`	`getMaxMsgsPerSubject()` Gets the maximum messages for this stream configuration.
`@Nullable java.util.Map<java.lang.String,java.lang.String>`	`getMetadata()` Metadata for the stream
`@Nullable Mirror`	`getMirror()` The mirror definition for this stream
`boolean`	`getMirrorDirect()` Get the flag indicating if the stream allows higher performance and unified direct access for mirrors as well.
`@NonNull java.lang.String`	`getName()` Gets the name of this stream configuration.
`boolean`	`getNoAck()` Gets whether acknowledgements are required in this stream configuration.
`@Nullable PersistMode`	`getPersistMode()` Gets the persist mode or null if it was not explicitly set when creating or the server did not send it with stream info
`@Nullable Placement`	`getPlacement()` Get the 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.
`@Nullable Republish`	`getRepublish()` Get the republish configuration.
`@NonNull RetentionPolicy`	`getRetentionPolicy()` Gets the retention policy for this stream configuration.
`boolean`	`getSealed()` Get the flag indicating if the stream is sealed.
`@Nullable java.util.List<Source>`	`getSources()` The sources for this stream
`@NonNull StorageType`	`getStorageType()` Gets the storage type for this stream configuration.
`@Nullable java.time.Duration`	`getSubjectDeleteMarkerTtl()` Get the Subject Delete Marker TTL duration.
`@NonNull java.util.List<java.lang.String>`	`getSubjects()` Gets the subjects for this stream configuration.
`@Nullable SubjectTransform`	`getSubjectTransform()` Get the subjectTransform configuration.
`@Nullable java.lang.String`	`getTemplateOwner()` Gets the template json for this stream configuration.
`static StreamConfiguration`	`instance(java.lang.String json)` Returns a StreamConfiguration deserialized from its JSON form.
`boolean`	`isAllowMessageTtl()` Deprecated. Prefer getAllowMessageTtl Whether Allow Message TTL is set
`boolean`	`isDiscardNewPerSubject()` Whether discard policy with max message per subject is applied per subject.
`@NonNull java.lang.String`	`toJson()` Returns a JSON representation of this consumer configuration.
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.nats.client.support.JsonSerializable
serialize, toJsonValue

- Method Detail
  - instance
```
public static StreamConfiguration instance(java.lang.String json)
                                    throws io.nats.client.support.JsonParseException
```
    Returns a StreamConfiguration deserialized from its JSON form.
    
    Parameters:
    
    json - the json representing the Stream Configuration
    
    Returns:
    
    StreamConfiguration for the given json
    
    Throws:
    
    io.nats.client.support.JsonParseException - if there is a problem parsing the json
    
    See Also:
    
    toJson()
  - toJson
```
public @NonNull java.lang.String toJson()
```
    Returns a JSON representation of this consumer configuration.
    
    Specified by:
    
    toJson in interface io.nats.client.support.JsonSerializable
    
    Returns:
    
    json consumer configuration to send to the server.
  - getName
```
public @NonNull java.lang.String getName()
```
    Gets the name of this stream configuration.
    
    Returns:
    
    the name of the stream.
  - getDescription
```
public @Nullable java.lang.String getDescription()
```
    Gets the description of this stream configuration.
    
    Returns:
    
    the description of the stream.
  - getSubjects
```
public @NonNull java.util.List<java.lang.String> getSubjects()
```
    Gets the subjects for this stream configuration.
    
    Returns:
    
    the subject of the stream.
  - getDiscardPolicy
```
public @Nullable DiscardPolicy getDiscardPolicy()
```
    Gets the discard policy for this stream configuration.
    
    Returns:
    
    the discard policy of the stream.
  - getRetentionPolicy
```
public @NonNull RetentionPolicy getRetentionPolicy()
```
    Gets the retention policy for this stream configuration.
    
    Returns:
    
    the retention policy for this stream.
  - getCompressionOption
```
public @Nullable CompressionOption getCompressionOption()
```
    Gets the compression option for this stream configuration.
    
    Returns:
    
    the compression option 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.
  - getMaxMsgsPerSubject
```
public long getMaxMsgsPerSubject()
```
    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 @NonNull java.time.Duration getMaxAge()
```
    Gets the maximum message age for this stream configuration.
    
    Returns:
    
    the maximum message age for this stream.
  - getMaxMsgSize
```
@Deprecated
public long getMaxMsgSize()
```
    Deprecated. the server value is a 32-bit signed value. Use getMaximumMessageSize() instead.
    
    Gets the maximum message size for this stream configuration.
    
    Returns:
    
    the maximum message size for this stream.
  - getMaximumMessageSize
```
public int getMaximumMessageSize()
```
    Gets the maximum message size for this stream configuration.
    
    Returns:
    
    the maximum message size for this stream.
  - getStorageType
```
public @NonNull StorageType getStorageType()
```
    Gets the storage 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 acknowledgements are required in this stream configuration.
    
    Returns:
    
    true if acknowedgments are not required.
  - getTemplateOwner
```
public @Nullable java.lang.String getTemplateOwner()
```
    Gets the template json for this stream configuration.
    
    Returns:
    
    the template for this stream.
  - getDuplicateWindow
```
public @Nullable 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 @Nullable Placement getPlacement()
```
    Get the placement directives to consider when placing replicas of this stream, random placement when unset. May be null.
    
    Returns:
    
    the placement object
  - getRepublish
```
public @Nullable Republish getRepublish()
```
    Get the republish configuration. May be null.
    
    Returns:
    
    the republish object
  - getSubjectTransform
```
public @Nullable SubjectTransform getSubjectTransform()
```
    Get the subjectTransform configuration. May be null.
    
    Returns:
    
    the subjectTransform object
  - getConsumerLimits
```
public @Nullable ConsumerLimits getConsumerLimits()
```
    Get the consumerLimits configuration. May be null.
    
    Returns:
    
    the consumerLimits object
  - getMirror
```
public @Nullable Mirror getMirror()
```
    The mirror definition for this stream
    
    Returns:
    
    the mirror
  - getSources
```
public @Nullable java.util.List<Source> getSources()
```
    The sources for this stream
    
    Returns:
    
    the sources
  - getSealed
```
public boolean getSealed()
```
    Get the flag indicating if the stream is sealed.
    
    Returns:
    
    the sealed flag
  - getAllowRollup
```
public boolean getAllowRollup()
```
    Get the flag indicating if the stream allows rollup.
    
    Returns:
    
    the allows rollup flag
  - getAllowDirect
```
public boolean getAllowDirect()
```
    Get the flag indicating if the stream allows direct message access.
    
    Returns:
    
    the allows direct flag
  - getMirrorDirect
```
public boolean getMirrorDirect()
```
    Get the flag indicating if the stream allows higher performance and unified direct access for mirrors as well.
    
    Returns:
    
    the allows direct flag
  - getDenyDelete
```
public boolean getDenyDelete()
```
    Get the flag indicating if deny delete is set for the stream
    
    Returns:
    
    the deny delete flag
  - getDenyPurge
```
public boolean getDenyPurge()
```
    Get the flag indicating if deny purge is set for the stream
    
    Returns:
    
    the deny purge flag
  - isDiscardNewPerSubject
```
public boolean isDiscardNewPerSubject()
```
    Whether discard policy with max message per subject is applied per subject.
    
    Returns:
    
    the discard new per subject flag
  - getMetadata
```
public @Nullable java.util.Map<java.lang.String,java.lang.String> getMetadata()
```
    Metadata for the stream
    
    Returns:
    
    the metadata map. Might be null.
  - getFirstSequence
```
public long getFirstSequence()
```
    The first sequence used in the stream.
    
    Returns:
    
    the first sequence
  - isAllowMessageTtl
```
@Deprecated
public boolean isAllowMessageTtl()
```
    Deprecated. Prefer getAllowMessageTtl Whether Allow Message TTL is set
    
    Returns:
    
    the flag
  - getAllowMessageTtl
```
public boolean getAllowMessageTtl()
```
    Whether Allow Message TTL is set
    
    Returns:
    
    the flag
  - getAllowMsgSchedules
```
public boolean getAllowMsgSchedules()
```
    Whether Allow Message Schedules is set
    
    Returns:
    
    the flag
  - getAllowMessageCounter
```
public boolean getAllowMessageCounter()
```
    Whether Allow Message Counter is set
    
    Returns:
    
    the flag
  - getAllowAtomicPublish
```
public boolean getAllowAtomicPublish()
```
    Whether Allow Atomic Publish is set
    
    Returns:
    
    the flag
  - getSubjectDeleteMarkerTtl
```
public @Nullable java.time.Duration getSubjectDeleteMarkerTtl()
```
    Get the Subject Delete Marker TTL duration. May be null.
    
    Returns:
    
    The duration
  - getPersistMode
```
public @Nullable PersistMode getPersistMode()
```
    Gets the persist mode or null if it was not explicitly set when creating or the server did not send it with stream info
    
    Returns:
    
    the persist mode
  - 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

Class StreamConfiguration

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

instance

toJson

getName

getDescription

getSubjects

getDiscardPolicy

getRetentionPolicy

getCompressionOption

getMaxConsumers

getMaxMsgs

getMaxMsgsPerSubject

getMaxBytes

getMaxAge

getMaxMsgSize

getMaximumMessageSize

getStorageType

getReplicas

getNoAck

getTemplateOwner

getDuplicateWindow

getPlacement

getRepublish

getSubjectTransform

getConsumerLimits

getMirror

getSources

getSealed

getAllowRollup

getAllowDirect

getMirrorDirect

getDenyDelete

getDenyPurge

isDiscardNewPerSubject

getMetadata

getFirstSequence

isAllowMessageTtl

getAllowMessageTtl

getAllowMsgSchedules

getAllowMessageCounter

getAllowAtomicPublish

getSubjectDeleteMarkerTtl

getPersistMode

toString

builder

builder