ConsumerConfiguration (NATS.IO Java API)

java.lang.Object
- io.nats.client.api.ConsumerConfiguration

All Implemented Interfaces:

JsonSerializable
```
public class ConsumerConfiguration
extends java.lang.Object
implements JsonSerializable
```
The ConsumerConfiguration class specifies the configuration for creating a JetStream consumer on the client and if necessary the server. Options are created using a PublishOptions.Builder.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`ConsumerConfiguration.Builder` ConsumerConfiguration is created using a Builder.
`static class`	`ConsumerConfiguration.CcChangeHelper` INTERNAL CLASS ONLY, SUBJECT TO CHANGE Helper class to identify the initial or default value of a field and to make it easy to compare to other instances where the server provides a default value.

Field Summary

Fields
Modifier and Type	Field and Description
`protected AckPolicy`	`ackPolicy`
`protected java.time.Duration`	`ackWait`
`protected java.lang.String`	`deliverGroup`
`protected DeliverPolicy`	`deliverPolicy`
`protected java.lang.String`	`deliverSubject`
`protected java.lang.String`	`description`
`protected java.lang.String`	`durable`
`protected java.lang.String`	`filterSubject`
`protected java.lang.Boolean`	`flowControl`
`protected java.lang.Boolean`	`headersOnly`
`protected java.time.Duration`	`idleHeartbeat`
`protected java.time.Duration`	`inactiveThreshold`
`protected java.lang.Long`	`maxAckPending`
`protected java.lang.Long`	`maxBatch`
`protected java.lang.Long`	`maxDeliver`
`protected java.time.Duration`	`maxExpires`
`protected java.lang.Long`	`maxPullWaiting`
`static java.time.Duration`	`MIN_ACK_WAIT`
`static java.time.Duration`	`MIN_IDLE_HEARTBEAT`
`protected java.lang.Long`	`rateLimit`
`protected ReplayPolicy`	`replayPolicy`
`protected java.lang.String`	`sampleFrequency`
`protected java.lang.Long`	`startSeq`
`protected java.time.ZonedDateTime`	`startTime`

Constructor Summary

Constructors
Modifier Constructor and Description

protected ConsumerConfiguration(ConsumerConfiguration cc)

Constructors
Modifier	Constructor and Description
`protected`	`ConsumerConfiguration(ConsumerConfiguration cc)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`ackPolicyWasSet()` Gets whether ack policy for this consumer configuration was set or left unset
`static ConsumerConfiguration.Builder`	`builder()` Creates a builder for the publish options.
`static ConsumerConfiguration.Builder`	`builder(ConsumerConfiguration cc)` Creates a builder for the publish options.
`boolean`	`deliverPolicyWasSet()` Gets whether deliver policy of this consumer configuration was set or left unset
`boolean`	`flowControlWasSet()` Gets whether flow control for this consumer configuration was set or left unset
`AckPolicy`	`getAckPolicy()` Gets the acknowledgment policy of this consumer configuration.
`java.time.Duration`	`getAckWait()` Gets the acknowledgment wait of this consumer configuration.
`java.lang.String`	`getDeliverGroup()` Gets the deliver group of this consumer configuration.
`DeliverPolicy`	`getDeliverPolicy()` Gets the deliver policy of this consumer configuration.
`java.lang.String`	`getDeliverSubject()` Gets the deliver subject of this consumer configuration.
`java.lang.String`	`getDescription()` Gets the name of the description of this consumer configuration.
`java.lang.String`	`getDurable()` Gets the name of the durable subscription for this consumer configuration.
`java.lang.String`	`getFilterSubject()` Gets the max filter subject of this consumer configuration.
`java.time.Duration`	`getIdleHeartbeat()` Gets the idle heart beat wait time
`java.time.Duration`	`getInactiveThreshold()` Get the amount of time before the ephemeral consumer is deemed inactive.
`long`	`getMaxAckPending()` Gets the maximum ack pending configuration.
`java.lang.Long`	`getMaxBatch()` Get the max batch size for the server to allow on pull requests.
`long`	`getMaxDeliver()` Gets the max delivery amount of this consumer configuration.
`java.time.Duration`	`getMaxExpires()` Get the max amount of expire time for the server to allow on pull requests.
`long`	`getMaxPullWaiting()` Get the number of pulls that can be outstanding on a pull consumer
`long`	`getRateLimit()` Gets the rate limit for this consumer configuration.
`ReplayPolicy`	`getReplayPolicy()` Gets the replay policy of this consumer configuration.
`java.lang.String`	`getSampleFrequency()` Gets the sample frequency.
`long`	`getStartSequence()` Gets the start sequence of this consumer configuration.
`java.time.ZonedDateTime`	`getStartTime()` Gets the start time of this consumer configuration.
`boolean`	`headersOnlyWasSet()` Gets whether headers only for this consumer configuration was set or left unset
`boolean`	`isFlowControl()` Get the flow control flag indicating whether it's on or off
`boolean`	`isHeadersOnly()` Get the header only flag indicating whether it's on or off
`boolean`	`maxAckPendingWasSet()` Gets whether max ack pending for this consumer configuration was set or left unset
`boolean`	`maxBatchWasSet()` Gets whether max batch for this consumer configuration was set or left unset
`boolean`	`maxDeliverWasSet()` Gets whether max deliver for this consumer configuration was set or left unset
`boolean`	`maxPullWaitingWasSet()` Gets whether max pull waiting for this consumer configuration was set or left unset
`boolean`	`rateLimitWasSet()` Gets whether rate limit for this consumer configuration was set or left unset
`boolean`	`replayPolicyWasSet()` Gets whether replay policy for this consumer configuration was set or left unset
`boolean`	`startSeqWasSet()` Gets whether start sequence for this consumer configuration was set or left unset
`java.lang.String`	`toJson()` Returns a JSON representation of this consumer configuration.
`java.lang.String`	`toString()`

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

Methods inherited from interface io.nats.client.support.JsonSerializable
serialize

- Field Detail
  - MIN_ACK_WAIT
```
public static final java.time.Duration MIN_ACK_WAIT
```
  - MIN_IDLE_HEARTBEAT
```
public static final java.time.Duration MIN_IDLE_HEARTBEAT
```
  - deliverPolicy
```
protected final DeliverPolicy deliverPolicy
```
  - ackPolicy
```
protected final AckPolicy ackPolicy
```
  - replayPolicy
```
protected final ReplayPolicy replayPolicy
```
  - description
```
protected final java.lang.String description
```
  - durable
```
protected final java.lang.String durable
```
  - deliverSubject
```
protected final java.lang.String deliverSubject
```
  - deliverGroup
```
protected final java.lang.String deliverGroup
```
  - filterSubject
```
protected final java.lang.String filterSubject
```
  - sampleFrequency
```
protected final java.lang.String sampleFrequency
```
  - startTime
```
protected final java.time.ZonedDateTime startTime
```
  - ackWait
```
protected final java.time.Duration ackWait
```
  - idleHeartbeat
```
protected final java.time.Duration idleHeartbeat
```
  - maxExpires
```
protected final java.time.Duration maxExpires
```
  - inactiveThreshold
```
protected final java.time.Duration inactiveThreshold
```
  - startSeq
```
protected final java.lang.Long startSeq
```
  - maxDeliver
```
protected final java.lang.Long maxDeliver
```
  - rateLimit
```
protected final java.lang.Long rateLimit
```
  - maxAckPending
```
protected final java.lang.Long maxAckPending
```
  - maxPullWaiting
```
protected final java.lang.Long maxPullWaiting
```
  - maxBatch
```
protected final java.lang.Long maxBatch
```
  - flowControl
```
protected final java.lang.Boolean flowControl
```
  - headersOnly
```
protected final java.lang.Boolean headersOnly
```
- Constructor Detail
  - ConsumerConfiguration
```
protected ConsumerConfiguration(ConsumerConfiguration cc)
```
- Method Detail
  - toJson
```
public java.lang.String toJson()
```
    Returns a JSON representation of this consumer configuration.
    
    Specified by:
    
    toJson in interface JsonSerializable
    
    Returns:
    
    json consumer configuration json string
  - getDescription
```
public java.lang.String getDescription()
```
    Gets the name of the description of this consumer configuration.
    
    Returns:
    
    name of the description.
  - getDurable
```
public java.lang.String getDurable()
```
    Gets the name of the durable subscription for this consumer configuration.
    
    Returns:
    
    name of the durable.
  - getDeliverSubject
```
public java.lang.String getDeliverSubject()
```
    Gets the deliver subject of this consumer configuration.
    
    Returns:
    
    the deliver subject.
  - getDeliverGroup
```
public java.lang.String getDeliverGroup()
```
    Gets the deliver group of this consumer configuration.
    
    Returns:
    
    the deliver group.
  - getDeliverPolicy
```
public DeliverPolicy getDeliverPolicy()
```
    Gets the deliver policy of this consumer configuration.
    
    Returns:
    
    the deliver policy.
  - getStartSequence
```
public long getStartSequence()
```
    Gets the start sequence of this consumer configuration.
    
    Returns:
    
    the start sequence.
  - getStartTime
```
public java.time.ZonedDateTime getStartTime()
```
    Gets the start time of this consumer configuration.
    
    Returns:
    
    the start time.
  - getAckPolicy
```
public AckPolicy getAckPolicy()
```
    Gets the acknowledgment policy of this consumer configuration.
    
    Returns:
    
    the acknowledgment policy.
  - getAckWait
```
public java.time.Duration getAckWait()
```
    Gets the acknowledgment wait of this consumer configuration.
    
    Returns:
    
    the acknowledgment wait duration.
  - getMaxDeliver
```
public long getMaxDeliver()
```
    Gets the max delivery amount of this consumer configuration.
    
    Returns:
    
    the max delivery amount.
  - getFilterSubject
```
public java.lang.String getFilterSubject()
```
    Gets the max filter subject of this consumer configuration.
    
    Returns:
    
    the filter subject.
  - getReplayPolicy
```
public ReplayPolicy getReplayPolicy()
```
    Gets the replay policy of this consumer configuration.
    
    Returns:
    
    the replay policy.
  - getRateLimit
```
public long getRateLimit()
```
    Gets the rate limit for this consumer configuration.
    
    Returns:
    
    the rate limit in msgs per second.
  - getMaxAckPending
```
public long getMaxAckPending()
```
    Gets the maximum ack pending configuration.
    
    Returns:
    
    maximum ack pending.
  - getSampleFrequency
```
public java.lang.String getSampleFrequency()
```
    Gets the sample frequency.
    
    Returns:
    
    sampleFrequency.
  - getIdleHeartbeat
```
public java.time.Duration getIdleHeartbeat()
```
    Gets the idle heart beat wait time
    
    Returns:
    
    the idle heart beat wait duration.
  - isFlowControl
```
public boolean isFlowControl()
```
    Get the flow control flag indicating whether it's on or off
    
    Returns:
    
    the flow control mode
  - getMaxPullWaiting
```
public long getMaxPullWaiting()
```
    Get the number of pulls that can be outstanding on a pull consumer
    
    Returns:
    
    the max pull waiting
  - isHeadersOnly
```
public boolean isHeadersOnly()
```
    Get the header only flag indicating whether it's on or off
    
    Returns:
    
    the flow control mode
  - getMaxBatch
```
public java.lang.Long getMaxBatch()
```
    Get the max batch size for the server to allow on pull requests.
    
    Returns:
    
    the max batch size
  - getMaxExpires
```
public java.time.Duration getMaxExpires()
```
    Get the max amount of expire time for the server to allow on pull requests.
    
    Returns:
    
    the max expire
  - getInactiveThreshold
```
public java.time.Duration getInactiveThreshold()
```
    Get the amount of time before the ephemeral consumer is deemed inactive.
    
    Returns:
    
    the inactive threshold
  - deliverPolicyWasSet
```
public boolean deliverPolicyWasSet()
```
    Gets whether deliver policy of this consumer configuration was set or left unset
    
    Returns:
    
    true if the policy was set, false if the policy was not set
  - ackPolicyWasSet
```
public boolean ackPolicyWasSet()
```
    Gets whether ack policy for this consumer configuration was set or left unset
    
    Returns:
    
    true if the policy was set, false if the policy was not set
  - replayPolicyWasSet
```
public boolean replayPolicyWasSet()
```
    Gets whether replay policy for this consumer configuration was set or left unset
    
    Returns:
    
    true if the policy was set, false if the policy was not set
  - startSeqWasSet
```
public boolean startSeqWasSet()
```
    Gets whether start sequence for this consumer configuration was set or left unset
    
    Returns:
    
    true if the start sequence was set by the user
  - maxDeliverWasSet
```
public boolean maxDeliverWasSet()
```
    Gets whether max deliver for this consumer configuration was set or left unset
    
    Returns:
    
    true if max deliver was set by the user
  - rateLimitWasSet
```
public boolean rateLimitWasSet()
```
    Gets whether rate limit for this consumer configuration was set or left unset
    
    Returns:
    
    true if rate limit was set by the user
  - maxAckPendingWasSet
```
public boolean maxAckPendingWasSet()
```
    Gets whether max ack pending for this consumer configuration was set or left unset
    
    Returns:
    
    true if mac ack pending was set by the user
  - maxPullWaitingWasSet
```
public boolean maxPullWaitingWasSet()
```
    Gets whether max pull waiting for this consumer configuration was set or left unset
    
    Returns:
    
    true if max pull waiting was set by the user
  - maxBatchWasSet
```
public boolean maxBatchWasSet()
```
    Gets whether max batch for this consumer configuration was set or left unset
    
    Returns:
    
    true if max batch was set by the user
  - flowControlWasSet
```
public boolean flowControlWasSet()
```
    Gets whether flow control for this consumer configuration was set or left unset
    
    Returns:
    
    true if the policy was set, false if the policy was not set
  - headersOnlyWasSet
```
public boolean headersOnlyWasSet()
```
    Gets whether headers only for this consumer configuration was set or left unset
    
    Returns:
    
    true if the policy was set, false if the policy was not set
  - builder
```
public static ConsumerConfiguration.Builder builder()
```
    Creates a builder for the publish options.
    
    Returns:
    
    a publish options builder
  - builder
```
public static ConsumerConfiguration.Builder builder(ConsumerConfiguration cc)
```
    Creates a builder for the publish options.
    
    Parameters:
    
    cc - the consumer configuration
    
    Returns:
    
    a publish options builder
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class ConsumerConfiguration

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface io.nats.client.support.JsonSerializable

Field Detail

MIN_ACK_WAIT

MIN_IDLE_HEARTBEAT

deliverPolicy

ackPolicy

replayPolicy

description

durable

deliverSubject

deliverGroup

filterSubject

sampleFrequency

startTime

ackWait

idleHeartbeat

maxExpires

inactiveThreshold

startSeq

maxDeliver

rateLimit

maxAckPending

maxPullWaiting

maxBatch

flowControl

headersOnly

Constructor Detail

ConsumerConfiguration

Method Detail

toJson

getDescription

getDurable

getDeliverSubject

getDeliverGroup

getDeliverPolicy

getStartSequence

getStartTime

getAckPolicy

getAckWait

getMaxDeliver

getFilterSubject

getReplayPolicy

getRateLimit

getMaxAckPending

getSampleFrequency

getIdleHeartbeat

isFlowControl

getMaxPullWaiting

isHeadersOnly

getMaxBatch

getMaxExpires

getInactiveThreshold

deliverPolicyWasSet

ackPolicyWasSet

replayPolicyWasSet

startSeqWasSet

maxDeliverWasSet

rateLimitWasSet

maxAckPendingWasSet

maxPullWaitingWasSet

maxBatchWasSet

flowControlWasSet

headersOnlyWasSet

builder

builder

toString