All Implemented Interfaces:


public final class ConsumerConfigBuilder

Builder for JetStream consumer configuration

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

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

Constructor Summary

Constructors
Constructor	Description
`ConsumerConfigBuilder()`

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 Unit`	`setDurable(String <set-?>)`	Durable name for the consumer If null, the consumer will be ephemeral
`final DeliverPolicy`	`getDeliverPolicy()`	Deliver policy determines where to start consuming messages
`final Unit`	`setDeliverPolicy(DeliverPolicy <set-?>)`	Deliver policy determines where to start consuming messages
`final AckPolicy`	`getAckPolicy()`	Acknowledgment policy for message processing
`final Unit`	`setAckPolicy(AckPolicy <set-?>)`	Acknowledgment policy for message processing
`final Duration`	`getAckWait()`	How long to wait for acknowledgment before redelivering
`final Unit`	`setAckWait(Duration <set-?>)`	How long to wait for acknowledgment before redelivering
`final Integer`	`getMaxDeliver()`	Maximum number of delivery attempts (-1 for unlimited)
`final Unit`	`setMaxDeliver(Integer <set-?>)`	Maximum number of delivery attempts (-1 for unlimited)
`final String`	`getFilterSubject()`	Filter messages by subject
`final Unit`	`setFilterSubject(String <set-?>)`	Filter messages by subject
`final ReplayPolicy`	`getReplayPolicy()`	Replay policy for message delivery
`final Unit`	`setReplayPolicy(ReplayPolicy <set-?>)`	Replay policy for message delivery
`final Integer`	`getSampleFrequency()`	Sample frequency for metrics (0-100, 0 = disabled)
`final Unit`	`setSampleFrequency(Integer <set-?>)`	Sample frequency for metrics (0-100, 0 = disabled)
`final Long`	`getRateLimit()`	Rate limit in bits per second (-1 for unlimited)
`final Unit`	`setRateLimit(Long <set-?>)`	Rate limit in bits per second (-1 for unlimited)
`final Integer`	`getMaxAckPending()`	Maximum number of outstanding unacknowledged messages
`final Unit`	`setMaxAckPending(Integer <set-?>)`	Maximum number of outstanding unacknowledged messages
`final Integer`	`getMaxPullWaiting()`	Maximum number of pull requests that may wait on the consumer at once`null` - the default - leaves the limit to the server, which allows 512.
`final Unit`	`setMaxPullWaiting(Integer <set-?>)`	Maximum number of pull requests that may wait on the consumer at once`null` - the default - leaves the limit to the server, which allows 512.
`final Integer`	`getMaxBatch()`	Largest batch a single pull request may ask this consumer for`null` - the default - leaves the limit to the server, which does not cap batches.
`final Unit`	`setMaxBatch(Integer <set-?>)`	Largest batch a single pull request may ask this consumer for`null` - the default - leaves the limit to the server, which does not cap batches.
`final Duration`	`getMaxExpires()`	Maximum expiration duration for pull requests
`final Unit`	`setMaxExpires(Duration <set-?>)`	Maximum expiration duration for pull requests
`final Duration`	`getInactiveThreshold()`	Inactivity threshold before consumer is considered inactive
`final Unit`	`setInactiveThreshold(Duration <set-?>)`	Inactivity threshold before consumer is considered inactive
`final String`	`getDescription()`	Description of the consumer
`final Unit`	`setDescription(String <set-?>)`	Description of the consumer
`final String`	`getDeliverGroup()`	Deliver group for queue semantics (push consumers only)
`final Unit`	`setDeliverGroup(String <set-?>)`	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 Unit`	`setFlowControl(Boolean <set-?>)`	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 Unit`	`setIdleHeartbeat(Duration <set-?>)`	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 Unit`	`setHeadersOnly(Boolean <set-?>)`	Deliver only headers, not payloads
`final Long`	`getStartSequence()`	Start sequence for BY_START_SEQUENCE deliver policy
`final Unit`	`setStartSequence(Long <set-?>)`	Start sequence for BY_START_SEQUENCE deliver policy
`final ZonedDateTime`	`getStartTime()`	Start time for BY_START_TIME deliver policy
`final Unit`	`setStartTime(ZonedDateTime <set-?>)`	Start time for BY_START_TIME deliver policy
`final String`	`getDeliverSubject()`	Deliver subject for push consumers
`final Unit`	`setDeliverSubject(String <set-?>)`	Deliver subject for push consumers
`final Integer`	`getReplicas()`	Number of replicas for the consumer (-1 for stream default)
`final Unit`	`setReplicas(Integer <set-?>)`	Number of replicas for the consumer (-1 for stream default)
`final Boolean`	`getMemoryStorage()`	Enable memory storage for the consumer state
`final Unit`	`setMemoryStorage(Boolean <set-?>)`	Enable memory storage for the consumer state

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

- Constructor Detail
  - ConsumerConfigBuilder
```
ConsumerConfigBuilder()
```
- Method Detail
  - getDurable
```
 final String getDurable()
```
    Durable name for the consumer If null, the consumer will be ephemeral
  - setDurable
```
 final Unit setDurable(String <set-?>)
```
    Durable name for the consumer If null, the consumer will be ephemeral
  - getDeliverPolicy
```
 final DeliverPolicy getDeliverPolicy()
```
    Deliver policy determines where to start consuming messages
  - setDeliverPolicy
```
 final Unit setDeliverPolicy(DeliverPolicy <set-?>)
```
    Deliver policy determines where to start consuming messages
  - getAckPolicy
```
 final AckPolicy getAckPolicy()
```
    Acknowledgment policy for message processing
  - setAckPolicy
```
 final Unit setAckPolicy(AckPolicy <set-?>)
```
    Acknowledgment policy for message processing
  - getAckWait
```
 final Duration getAckWait()
```
    How long to wait for acknowledgment before redelivering
  - setAckWait
```
 final Unit setAckWait(Duration <set-?>)
```
    How long to wait for acknowledgment before redelivering
  - getMaxDeliver
```
 final Integer getMaxDeliver()
```
    Maximum number of delivery attempts (-1 for unlimited)
  - setMaxDeliver
```
 final Unit setMaxDeliver(Integer <set-?>)
```
    Maximum number of delivery attempts (-1 for unlimited)
  - getFilterSubject
```
 final String getFilterSubject()
```
    Filter messages by subject
  - setFilterSubject
```
 final Unit setFilterSubject(String <set-?>)
```
    Filter messages by subject
  - getReplayPolicy
```
 final ReplayPolicy getReplayPolicy()
```
    Replay policy for message delivery
  - setReplayPolicy
```
 final Unit setReplayPolicy(ReplayPolicy <set-?>)
```
    Replay policy for message delivery
  - getSampleFrequency
```
 final Integer getSampleFrequency()
```
    Sample frequency for metrics (0-100, 0 = disabled)
  - setSampleFrequency
```
 final Unit setSampleFrequency(Integer <set-?>)
```
    Sample frequency for metrics (0-100, 0 = disabled)
  - getRateLimit
```
 final Long getRateLimit()
```
    Rate limit in bits per second (-1 for unlimited)
  - setRateLimit
```
 final Unit setRateLimit(Long <set-?>)
```
    Rate limit in bits per second (-1 for unlimited)
  - getMaxAckPending
```
 final Integer getMaxAckPending()
```
    Maximum number of outstanding unacknowledged messages
  - setMaxAckPending
```
 final Unit setMaxAckPending(Integer <set-?>)
```
    Maximum number of outstanding unacknowledged messages
  - getMaxPullWaiting
```
 final Integer getMaxPullWaiting()
```
    Maximum number of pull requests that may wait on the consumer at once
    null - the default - leaves the limit to the server, which allows 512.
  - setMaxPullWaiting
```
 final Unit setMaxPullWaiting(Integer <set-?>)
```
    Maximum number of pull requests that may wait on the consumer at once
    null - the default - leaves the limit to the server, which allows 512.
  - getMaxBatch
```
 final Integer getMaxBatch()
```
    Largest batch a single pull request may ask this consumer for
    null - the default - leaves the limit to the server, which does not cap batches. Set it only to cap them deliberately: the server answers any larger fetch with a 409 that the client treats as a handled status, so an over-sized fetch quietly returns nothing.
  - setMaxBatch
```
 final Unit setMaxBatch(Integer <set-?>)
```
    Largest batch a single pull request may ask this consumer for
    null - the default - leaves the limit to the server, which does not cap batches. Set it only to cap them deliberately: the server answers any larger fetch with a 409 that the client treats as a handled status, so an over-sized fetch quietly returns nothing.
  - getMaxExpires
```
 final Duration getMaxExpires()
```
    Maximum expiration duration for pull requests
  - setMaxExpires
```
 final Unit setMaxExpires(Duration <set-?>)
```
    Maximum expiration duration for pull requests
  - getInactiveThreshold
```
 final Duration getInactiveThreshold()
```
    Inactivity threshold before consumer is considered inactive
  - setInactiveThreshold
```
 final Unit setInactiveThreshold(Duration <set-?>)
```
    Inactivity threshold before consumer is considered inactive
  - getDescription
```
 final String getDescription()
```
    Description of the consumer
  - setDescription
```
 final Unit setDescription(String <set-?>)
```
    Description of the consumer
  - getDeliverGroup
```
 final String getDeliverGroup()
```
    Deliver group for queue semantics (push consumers only)
  - setDeliverGroup
```
 final Unit setDeliverGroup(String <set-?>)
```
    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).
  - setFlowControl
```
 final Unit setFlowControl(Boolean <set-?>)
```
    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).
  - setIdleHeartbeat
```
 final Unit setIdleHeartbeat(Duration <set-?>)
```
    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
  - setHeadersOnly
```
 final Unit setHeadersOnly(Boolean <set-?>)
```
    Deliver only headers, not payloads
  - getStartSequence
```
 final Long getStartSequence()
```
    Start sequence for BY_START_SEQUENCE deliver policy
  - setStartSequence
```
 final Unit setStartSequence(Long <set-?>)
```
    Start sequence for BY_START_SEQUENCE deliver policy
  - getStartTime
```
 final ZonedDateTime getStartTime()
```
    Start time for BY_START_TIME deliver policy
  - setStartTime
```
 final Unit setStartTime(ZonedDateTime <set-?>)
```
    Start time for BY_START_TIME deliver policy
  - getDeliverSubject
```
 final String getDeliverSubject()
```
    Deliver subject for push consumers
  - setDeliverSubject
```
 final Unit setDeliverSubject(String <set-?>)
```
    Deliver subject for push consumers
  - getReplicas
```
 final Integer getReplicas()
```
    Number of replicas for the consumer (-1 for stream default)
  - setReplicas
```
 final Unit setReplicas(Integer <set-?>)
```
    Number of replicas for the consumer (-1 for stream default)
  - getMemoryStorage
```
 final Boolean getMemoryStorage()
```
    Enable memory storage for the consumer state
  - setMemoryStorage
```
 final Unit setMemoryStorage(Boolean <set-?>)
```
    Enable memory storage for the consumer state

Class ConsumerConfigBuilder

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ConsumerConfigBuilder

Method Detail

getDurable

setDurable

getDeliverPolicy

setDeliverPolicy

getAckPolicy

setAckPolicy

getAckWait

setAckWait

getMaxDeliver

setMaxDeliver

getFilterSubject

setFilterSubject

getReplayPolicy

setReplayPolicy

getSampleFrequency

setSampleFrequency

getRateLimit

setRateLimit

getMaxAckPending

setMaxAckPending

getMaxPullWaiting

setMaxPullWaiting

getMaxBatch

setMaxBatch

getMaxExpires

setMaxExpires

getInactiveThreshold

setInactiveThreshold

getDescription

setDescription

getDeliverGroup

setDeliverGroup

getFlowControl

setFlowControl

getIdleHeartbeat

setIdleHeartbeat

getHeadersOnly

setHeadersOnly

getStartSequence

setStartSequence

getStartTime

setStartTime

getDeliverSubject

setDeliverSubject

getReplicas

setReplicas

getMemoryStorage

setMemoryStorage