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.CcNumeric`

Field Summary

Fields
Modifier and Type	Field and Description
`static java.time.Duration`	`DEFAULT_ACK_WAIT`
`static java.time.Duration`	`DEFAULT_IDLE_HEARTBEAT`
`static java.time.Duration`	`MIN_ACK_WAIT`
`static java.time.Duration`	`MIN_IDLE_HEARTBEAT`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static ConsumerConfiguration.Builder`	`builder()` Creates a builder for the publish options.
`static ConsumerConfiguration.Builder`	`builder(ConsumerConfiguration cc)` Creates a builder for the publish options.
`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.
`boolean`	`getHeadersOnly()` Get the header only flag indicating whether it's on or off
`java.time.Duration`	`getIdleHeartbeat()` Gets the idle heart beat wait time
`long`	`getMaxAckPending()` Gets the maximum ack pending configuration.
`long`	`getMaxDeliver()` Gets the max delivery amount of this consumer configuration.
`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`	`isFlowControl()` Get the flow control flag indicating whether it's on or off
`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
```
  - DEFAULT_ACK_WAIT
```
public static final java.time.Duration DEFAULT_ACK_WAIT
```
  - DEFAULT_IDLE_HEARTBEAT
```
public static final java.time.Duration DEFAULT_IDLE_HEARTBEAT
```
- 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
  - getHeadersOnly
```
public boolean getHeadersOnly()
```
    Get the header only flag indicating whether it's on or off
    
    Returns:
    
    the flow control mode
  - 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

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

DEFAULT_ACK_WAIT

DEFAULT_IDLE_HEARTBEAT

Method Detail

toJson

getDescription

getDurable

getDeliverSubject

getDeliverGroup

getDeliverPolicy

getStartSequence

getStartTime

getAckPolicy

getAckWait

getMaxDeliver

getFilterSubject

getReplayPolicy

getRateLimit

getMaxAckPending

getSampleFrequency

getIdleHeartbeat

isFlowControl

getMaxPullWaiting

getHeadersOnly

builder

builder

toString