Skip to content
Orleans logoMicrosoft Orleans

NatsOptions Properties

Configuration options for the NATS JetStream stream provider

BatchSize

getset
View source
public int BatchSize
The maximum number of messages to fetch in a single batch. Defaults to 100.

NatsClientOptions

getset
View source
public NatsOpts? NatsClientOptions
Configuration options for the NATS client. If not provided, a default client will be created with the name Orleans-{providerName} and will connect to the NATS server at localhost:4222

NumReplicas

getset
View source
public int NumReplicas
The number of stream replicas in the NATS JetStream cluster. Higher values improve availability during node restarts (R3 survives single-node failures in a 3-node cluster). The NATS server enforces that the value is odd and does not exceed the cluster size. Defaults to 1. Set to 3 for production clusters with ≥ 3 nodes.

PartitionCount

getset
View source
public int PartitionCount
The number of partitions in the stream. This determines the number of pooling agents that will be created on this Orleans Cluster. This is mapped to a deterministic partitioning scheme of the NATS JetStream stream. The partitions are mapped from "[Provider-Name].*.*" to "[Provider-Name].{{partition([PartitionCount],1,2)}}.{{wildcard(1)}}.{{wildcard(2)}}". For details on how partitioning works in NATS JetStream, see Defaults to 8. Increase it if you need more parallelism. Deterministic partition scheme is a NATS server construct. This provider when started at the first time will create the stream with the partition scheme. If you need to change the partition count, you need to modify the value of this property and, you need to manually modify it on NATS Server first since the provider will not make updates to the JetStream stream definition.

ProducerCount

getset
View source
public int ProducerCount
The number of connections used to send stream messages to NATS JetStream.

StorageType

getset
View source
public StreamConfigStorage StorageType
The storage backend used by the NATS JetStream stream. Use NATS.Client.JetStream.Models.StreamConfigStorage.File for durability across NATS server restarts, or NATS.Client.JetStream.Models.StreamConfigStorage.Memory for lower latency when durability is not required and the NATS server is configured with a memory store. The NATS server must have the corresponding storage type enabled; requesting a storage type the server has not provisioned results in an "insufficient storage resources available" error at stream creation. Defaults to NATS.Client.JetStream.Models.StreamConfigStorage.File.