Configuration Reference

Version:4.9.1-SNAPSHOT

Micronaut Nats Config Properties

🔗
Table 1. Configuration Properties for NatsConnectionFactoryConfig
Property Type Description Default value

nats.*.addresses

java.util.List

An optional list of addresses

nats.*.username

java.lang.String

the username for the connection

nats.*.password

java.lang.String

the password for the connection

nats.*.token

java.lang.String

the token for the connection

nats.*.max-reconnect

int

the max reconnection tries

nats.*.reconnect-wait

java.time.Duration

time to wait between reconnect attempts

nats.*.connection-timeout

java.time.Duration

maximum time for initial connection

nats.*.ping-interval

java.time.Duration

time between ping intervals

nats.*.reconnect-buffer-size

long

size of the buffer, in bytes, used to store publish messages during reconnect

nats.*.inbox-prefix

java.lang.String

prefix to use for request/reply inboxes

nats.*.no-echo

boolean

whether or not to block echo messages, messages that were sent by this connection

nats.*.utf8-support

boolean

whether or not the client should support for UTF8 subject names

nats.*.credentials

java.lang.String

path to the credentials file to use for authentication with an account enabled server

🔗
Table 2. Configuration Properties for NatsConnectionFactoryConfig$JetStreamConfiguration
Property Type Description Default value

nats.*.jetstream.streams

java.util.List

set the stream configurations for the jetstream.

nats.*.jetstream.keyvalue

java.util.List

set the keyvalue configurations.

nats.*.jetstream.objectstore

java.util.List

set the object store configurations.

🔗
Table 3. Configuration Properties for JetStreamOptions$Builder
Property Type Description Default value

nats.*.jetstream.request-timeout

java.time.Duration

nats.*.jetstream.prefix

java.lang.String

nats.*.jetstream.domain

java.lang.String

nats.*.jetstream.publish-no-ack

boolean

nats.*.jetstream.opt-out290-consumer-create

boolean

🔗
Table 4. Configuration Properties for NatsConnectionFactoryConfig$JetStreamConfiguration$KeyValueConfiguration
Property Type Description Default value

nats.*.jetstream.keyvalue.*.create-or-update

boolean

create or update key/value store during startup.

🔗
Table 5. Configuration Properties for KeyValueConfiguration$Builder
Property Type Description Default value

nats.*.jetstream.keyvalue.*.description

java.lang.String

nats.*.jetstream.keyvalue.*.max-history-per-key

int

nats.*.jetstream.keyvalue.*.max-bucket-size

long

nats.*.jetstream.keyvalue.*.maximum-value-size

int

nats.*.jetstream.keyvalue.*.ttl

java.time.Duration

nats.*.jetstream.keyvalue.*.storage-type

io.nats.client.api.StorageType

nats.*.jetstream.keyvalue.*.replicas

int

nats.*.jetstream.keyvalue.*.placement

io.nats.client.api.Placement

nats.*.jetstream.keyvalue.*.compression

boolean

nats.*.jetstream.keyvalue.*.metadata

java.util.Map

nats.*.jetstream.keyvalue.*.republish

io.nats.client.api.Republish

nats.*.jetstream.keyvalue.*.mirror

io.nats.client.api.Mirror

nats.*.jetstream.keyvalue.*.limit-marker

java.time.Duration

🔗
Table 6. Configuration Properties for NatsConnectionFactoryConfig$JetStreamConfiguration$ObjectStoreConfiguration
Property Type Description Default value

nats.*.jetstream.objectstore.*.create

boolean

create store during startup.

🔗
Table 7. Configuration Properties for ObjectStoreConfiguration$Builder
Property Type Description Default value

nats.*.jetstream.objectstore.*.description

java.lang.String

nats.*.jetstream.objectstore.*.max-bucket-size

long

nats.*.jetstream.objectstore.*.ttl

java.time.Duration

nats.*.jetstream.objectstore.*.storage-type

io.nats.client.api.StorageType

nats.*.jetstream.objectstore.*.replicas

int

nats.*.jetstream.objectstore.*.placement

io.nats.client.api.Placement

nats.*.jetstream.objectstore.*.compression

boolean

nats.*.jetstream.objectstore.*.metadata

java.util.Map

🔗
Table 8. Configuration Properties for NatsConnectionFactoryConfig$JetStreamConfiguration$StreamConfiguration
Property Type Description Default value

nats.*.jetstream.streams.*.subjects

java.util.List

set the subjects.

nats.*.jetstream.streams.*.create-or-update

boolean

create or update stream during startup.

🔗
Table 9. Configuration Properties for StreamConfiguration$Builder
Property Type Description Default value

nats.*.jetstream.streams.*.description

java.lang.String

nats.*.jetstream.streams.*.retention-policy

io.nats.client.api.RetentionPolicy

nats.*.jetstream.streams.*.compression-option

io.nats.client.api.CompressionOption

nats.*.jetstream.streams.*.max-consumers

long

nats.*.jetstream.streams.*.max-messages

long

nats.*.jetstream.streams.*.max-messages-per-subject

long

nats.*.jetstream.streams.*.max-bytes

long

nats.*.jetstream.streams.*.max-age

java.time.Duration

nats.*.jetstream.streams.*.maximum-message-size

int

nats.*.jetstream.streams.*.storage-type

io.nats.client.api.StorageType

nats.*.jetstream.streams.*.replicas

int

nats.*.jetstream.streams.*.no-ack

boolean

nats.*.jetstream.streams.*.template-owner

java.lang.String

nats.*.jetstream.streams.*.discard-policy

io.nats.client.api.DiscardPolicy

nats.*.jetstream.streams.*.duplicate-window

java.time.Duration

nats.*.jetstream.streams.*.placement

io.nats.client.api.Placement

nats.*.jetstream.streams.*.republish

io.nats.client.api.Republish

nats.*.jetstream.streams.*.subject-transform

io.nats.client.api.SubjectTransform

nats.*.jetstream.streams.*.consumer-limits

io.nats.client.api.ConsumerLimits

nats.*.jetstream.streams.*.mirror

io.nats.client.api.Mirror

nats.*.jetstream.streams.*.sources

io.nats.client.api.Source

nats.*.jetstream.streams.*.allow-rollup

boolean

nats.*.jetstream.streams.*.allow-direct

boolean

nats.*.jetstream.streams.*.mirror-direct

boolean

nats.*.jetstream.streams.*.deny-delete

boolean

nats.*.jetstream.streams.*.deny-purge

boolean

nats.*.jetstream.streams.*.discard-new-per-subject

boolean

nats.*.jetstream.streams.*.metadata

java.util.Map

nats.*.jetstream.streams.*.first-sequence

long

nats.*.jetstream.streams.*.subject-delete-marker-ttl

java.time.Duration

nats.*.jetstream.streams.*.allow-message-ttl

boolean

nats.*.jetstream.streams.*.allow-message-schedules

boolean

nats.*.jetstream.streams.*.allow-message-counter

boolean

nats.*.jetstream.streams.*.allow-atomic-publish

boolean

🔗
Table 10. Configuration Properties for NatsConnectionFactoryConfig$TLS
Property Type Description Default value

nats.*.tls.trust-store-path

java.lang.String

file path for the trust store

nats.*.tls.trust-store-password

java.lang.String

password used to unlock the trust store

nats.*.tls.trust-store-type

java.lang.String

type of keystore to use for connections

nats.*.tls.certificate-path

java.lang.String

the certificate path