Allow higher performance, direct access to get individual messages via the $JS.DS.GET API
Allows the use of the RollupHdr header to replace all contents of a stream, or subject in a stream, with a single new message
Optional compressionSets the compression level of the stream. This feature is only supported in servers 2.10.x and better.
Optional consumer_The consumer limits applied to consumers that don't specify limits
for inactive_threshold or max_ack_pending. Note that these limits
become an upper bound for all clients.
Restricts the ability to delete messages from a stream via the API. Cannot be changed once set to true
Restricts the ability to purge messages from a stream via the API. Cannot be change once set to true
Optional descriptionA short description of the purpose of this stream
When a Stream reach its limits either old messages are deleted or new ones are denied
The time window to track duplicate messages for, expressed in nanoseconds. 0 for default Set msgID to enable duplicate detection.
Sets the first sequence number used by the stream. This property can only be specified when creating the stream, and likely is not valid on mirrors etc., as it may disrupt the synchronization logic.
Maximum age of any message in the stream, expressed in nanoseconds. 0 for unlimited.
How big the Stream may be, when the combined stream size exceeds this old messages are removed. -1 for unlimited.
How many Consumers can be defined for a given Stream. -1 for unlimited.
The largest message that will be accepted by the Stream. -1 for unlimited.
How many messages may be in a Stream, oldest messages will be removed if the Stream exceeds this size. -1 for unlimited.
For wildcard streams ensure that for every unique subject this many messages are kept - a per subject retention limit
Optional metadataMetadata field to store additional information about the stream. Note that
keys starting with _nats are reserved. This feature only supported on servers
2.10.x and better.
Optional mirrorMaintains a 1:1 mirror of another stream with name matching this property. When a mirror is configured subjects and sources must be empty.
Allow higher performance, direct access to get individual messages via the $JS.DS.GET API
A unique name for the Stream
Optional no_Disables acknowledging messages that are received by the Stream.
How many replicas to keep for each message. Min 1, Max 5. Default 1.
Optional placementPlacement directives to consider when placing replicas of this stream, random placement when unset
Optional republishRules for republishing messages from a stream with subject mapping onto new subjects for partitioning and more
How messages are retained in the Stream, once this is exceeded old messages are removed.
Sealed streams do not allow messages to be deleted via limits or API, sealed streams can not be unsealed via configuration update. Can only be set on already created streams via the Update API
Optional sourcesList of Stream names to replicate into this Stream
The storage backend to use for the Stream.
Optional subject_Apply a subject transform to incoming messages before doing anything else. This feature only supported on 2.10.x and better.
A list of subjects to consume, supports wildcards. Must be empty when a mirror is configured. May be empty when sources are configured.
Generated using TypeDoc
Stream options that can be updated