All Implemented Interfaces:


public final class ConsumerConfig

DSL for configuring JetStream consumers

Example usage:

val consumerCtx = js.consumer("MY_STREAM", "MY_CONSUMER") {
    durable = "MY_CONSUMER"
    deliverPolicy = DeliverPolicy.ALL
    ackPolicy = AckPolicy.EXPLICIT
    ackWait = 30.seconds
    maxDeliver = 5
    filterSubject = "orders.>"
}

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description
`private final String`	`durable`
`private final String`	`name`
`private final DeliverPolicy`	`deliverPolicy`
`private final AckPolicy`	`ackPolicy`
`private final Duration`	`ackWait`
`private final Integer`	`maxDeliver`
`private final String`	`filterSubject`
`private final List<String>`	`filterSubjects`
`private final ReplayPolicy`	`replayPolicy`
`private final Integer`	`sampleFrequency`
`private final Long`	`rateLimit`
`private final Integer`	`maxAckPending`
`private final Integer`	`maxPullWaiting`
`private final Integer`	`maxBatch`
`private final Duration`	`maxExpires`
`private final Duration`	`inactiveThreshold`
`private final String`	`description`
`private final String`	`deliverGroup`
`private final Boolean`	`flowControl`
`private final Duration`	`idleHeartbeat`
`private final Boolean`	`headersOnly`
`private final Long`	`startSequence`
`private final ZonedDateTime`	`startTime`
`private final String`	`deliverSubject`
`private final Integer`	`replicas`
`private final Boolean`	`memoryStorage`
`private final List<Duration>`	`backoff`
`private final Map<String, String>`	`metadata`

Constructor Summary

Constructors
Constructor	Description

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final String`	`getDurable()`	Durable name for the consumer If null, the consumer will be ephemeral
`final String`	`getName()`	Name for the consumer, without making it durable - see ConsumerConfigBuilder.name
`final DeliverPolicy`	`getDeliverPolicy()`	Deliver policy determines where to start consuming messages
`final AckPolicy`	`getAckPolicy()`	Acknowledgment policy for message processing
`final Duration`	`getAckWait()`	How long to wait for acknowledgment before redelivering
`final Integer`	`getMaxDeliver()`	Maximum number of delivery attempts (-1 for unlimited)
`final String`	`getFilterSubject()`	Filter messages by subject; mutually exclusive with filterSubjects
`final List<String>`	`getFilterSubjects()`	Filter messages by several subjects; mutually exclusive with filterSubject
`final ReplayPolicy`	`getReplayPolicy()`	Replay policy for message delivery
`final Integer`	`getSampleFrequency()`	Sample frequency for metrics (0-100, 0 = disabled)
`final Long`	`getRateLimit()`	Rate limit in bits per second (-1 for unlimited)
`final Integer`	`getMaxAckPending()`	Maximum number of outstanding unacknowledged messages
`final Integer`	`getMaxPullWaiting()`	Maximum number of pull requests that may wait on the consumer at once (null = server default)
`final Integer`	`getMaxBatch()`	Largest batch a single pull request may ask this consumer for (null = uncapped)
`final Duration`	`getMaxExpires()`	Maximum expiration duration for pull requests
`final Duration`	`getInactiveThreshold()`	Inactivity threshold before consumer is considered inactive
`final String`	`getDescription()`	Description of the consumer
`final String`	`getDeliverGroup()`	Deliver group for queue semantics (push consumers only)
`final Boolean`	`getFlowControl()`	Enable flow control for push consumersFlow control prevents the server from overwhelming slow consumers.
`final Duration`	`getIdleHeartbeat()`	Idle heartbeat interval for push consumersThe server will send heartbeat messages if no data messages are sent within this interval.
`final Boolean`	`getHeadersOnly()`	Deliver only headers, not payloads
`final Long`	`getStartSequence()`	Start sequence for BY_START_SEQUENCE deliver policy
`final ZonedDateTime`	`getStartTime()`	Start time for BY_START_TIME deliver policy
`final String`	`getDeliverSubject()`	Deliver subject for push consumers
`final Integer`	`getReplicas()`	Number of replicas for the consumer (-1 for stream default)
`final Boolean`	`getMemoryStorage()`	Enable memory storage for the consumer state
`final List<Duration>`	`getBackoff()`	Per-attempt redelivery delays, overriding ackWait - see ConsumerConfigBuilder.backoff
`final Map<String, String>`	`getMetadata()`	Free-form key-value pairs stored on the consumer

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

- Constructor Detail
- Method Detail
  - getDurable
```
 final String getDurable()
```
    Durable name for the consumer If null, the consumer will be ephemeral
  - getName
```
 final String getName()
```
    Name for the consumer, without making it durable - see ConsumerConfigBuilder.name
  - getDeliverPolicy
```
 final DeliverPolicy getDeliverPolicy()
```
    Deliver policy determines where to start consuming messages
  - getAckPolicy
```
 final AckPolicy getAckPolicy()
```
    Acknowledgment policy for message processing
  - getAckWait
```
 final Duration getAckWait()
```
    How long to wait for acknowledgment before redelivering
  - getMaxDeliver
```
 final Integer getMaxDeliver()
```
    Maximum number of delivery attempts (-1 for unlimited)
  - getFilterSubject
```
 final String getFilterSubject()
```
    Filter messages by subject; mutually exclusive with filterSubjects
  - getFilterSubjects
```
 final List<String> getFilterSubjects()
```
    Filter messages by several subjects; mutually exclusive with filterSubject
  - getReplayPolicy
```
 final ReplayPolicy getReplayPolicy()
```
    Replay policy for message delivery
  - getSampleFrequency
```
 final Integer getSampleFrequency()
```
    Sample frequency for metrics (0-100, 0 = disabled)
  - getRateLimit
```
 final Long getRateLimit()
```
    Rate limit in bits per second (-1 for unlimited)
  - getMaxAckPending
```
 final Integer getMaxAckPending()
```
    Maximum number of outstanding unacknowledged messages
  - getMaxPullWaiting
```
 final Integer getMaxPullWaiting()
```
    Maximum number of pull requests that may wait on the consumer at once (null = server default)
  - getMaxBatch
```
 final Integer getMaxBatch()
```
    Largest batch a single pull request may ask this consumer for (null = uncapped)
  - getMaxExpires
```
 final Duration getMaxExpires()
```
    Maximum expiration duration for pull requests
  - getInactiveThreshold
```
 final Duration getInactiveThreshold()
```
    Inactivity threshold before consumer is considered inactive
  - getDescription
```
 final String getDescription()
```
    Description of the consumer
  - getDeliverGroup
```
 final String getDeliverGroup()
```
    Deliver group for queue semantics (push consumers only)
  - getFlowControl
```
 final Boolean getFlowControl()
```
    Enable flow control for push consumers
    Flow control prevents the server from overwhelming slow consumers. When enabled, the server sends flow control messages that the NATS client automatically handles. Requires idleHeartbeat to be set.
    Note: Only valid for push consumers (requires deliverSubject).
  - getIdleHeartbeat
```
 final Duration getIdleHeartbeat()
```
    Idle heartbeat interval for push consumers
    The server will send heartbeat messages if no data messages are sent within this interval. This allows the consumer to detect connectivity issues.
    When flowControl is enabled, this value determines both the flow control and heartbeat interval. Recommended minimum: 1 second (avoid values like 500ms which cause excessive server load).
  - getHeadersOnly
```
 final Boolean getHeadersOnly()
```
    Deliver only headers, not payloads
  - getStartSequence
```
 final Long getStartSequence()
```
    Start sequence for BY_START_SEQUENCE deliver policy
  - getStartTime
```
 final ZonedDateTime getStartTime()
```
    Start time for BY_START_TIME deliver policy
  - getDeliverSubject
```
 final String getDeliverSubject()
```
    Deliver subject for push consumers
  - getReplicas
```
 final Integer getReplicas()
```
    Number of replicas for the consumer (-1 for stream default)
  - getMemoryStorage
```
 final Boolean getMemoryStorage()
```
    Enable memory storage for the consumer state
  - getBackoff
```
 final List<Duration> getBackoff()
```
    Per-attempt redelivery delays, overriding ackWait - see ConsumerConfigBuilder.backoff
  - getMetadata
```
 final Map<String, String> getMetadata()
```
    Free-form key-value pairs stored on the consumer

Class ConsumerConfig

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

getDurable

getName

getDeliverPolicy

getAckPolicy

getAckWait

getMaxDeliver

getFilterSubject

getFilterSubjects

getReplayPolicy

getSampleFrequency

getRateLimit

getMaxAckPending

getMaxPullWaiting

getMaxBatch

getMaxExpires

getInactiveThreshold

getDescription

getDeliverGroup

getFlowControl

getIdleHeartbeat

getHeadersOnly

getStartSequence

getStartTime

getDeliverSubject

getReplicas

getMemoryStorage

getBackoff

getMetadata