ConsumerConfiguration (NATS.IO Java API)

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

All Implemented Interfaces:

io.nats.client.support.JsonSerializable
```
public class ConsumerConfiguration
extends java.lang.Object
implements io.nats.client.support.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 ConsumerConfiguration.Builder.
ConsumerConfiguration is intended to be used with JetStreamManagement.createConsumer().
By default this will create a pull consumer unless ConsumerConfiguration.Builder.deliverSubject(String) is set.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ConsumerConfiguration.Builder
ConsumerConfiguration is created using a Builder.

Nested Classes
Modifier and Type	Class and Description
`static class`	`ConsumerConfiguration.Builder` ConsumerConfiguration is created using a Builder.

Field Summary

Fields
Modifier and Type	Field and Description
`static AckPolicy`	`DEFAULT_ACK_POLICY` The default ack policy for consumers
`static DeliverPolicy`	`DEFAULT_DELIVER_POLICY` The default deliver policy for consumers
`static PriorityPolicy`	`DEFAULT_PRIORITY_POLICY` The default priority policy for consumers
`static ReplayPolicy`	`DEFAULT_REPLAY_POLICY` The default replay policy for consumers
`static java.time.Duration`	`DURATION_MIN` Deprecated.
`static long`	`DURATION_MIN_LONG` Constant used to unset a Duration setting in the builder
`static java.time.Duration`	`DURATION_UNSET` Constant used to unset a Duration setting in the builder
`static long`	`DURATION_UNSET_LONG` Constant used to unset a long setting in the builder
`static int`	`INTEGER_UNSET` Constant used to unset a Duration setting in the builder
`static long`	`LONG_UNSET` Constant used to unset a long setting in the builder
`static int`	`MAX_DELIVER_MIN` Constant representing the minimum max deliver
`static java.time.Duration`	`MIN_IDLE_HEARTBEAT` The minimum allowed idle heartbeat setting
`static long`	`MIN_IDLE_HEARTBEAT_MILLIS` Constant representing the minimum idle heartbeat in milliseconds
`static long`	`MIN_IDLE_HEARTBEAT_NANOS` Constant representing the minimum idle heartbeat in nanos
`static int`	`STANDARD_MIN` Constant used to as a standard minimum value
`static long`	`ULONG_UNSET` Constant used to unset a long that represents an unsigned long setting in the builder

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
`boolean`	`backoffWasSet()` Gets whether backoff for this consumer configuration was set or left unset
`static ConsumerConfiguration.Builder`	`builder()` Creates a builder for the options.
`static ConsumerConfiguration.Builder`	`builder(ConsumerConfiguration cc)` Creates a builder for the 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
`@NonNull AckPolicy`	`getAckPolicy()` Gets the acknowledgment policy of this consumer configuration.
`@Nullable java.time.Duration`	`getAckWait()` Gets the acknowledgment wait of this consumer configuration.
`@NonNull java.util.List<java.time.Duration>`	`getBackoff()` Get the backoff list; may be empty, will never be null.
`@Nullable java.lang.String`	`getDeliverGroup()` Gets the deliver group of this consumer configuration.
`@NonNull DeliverPolicy`	`getDeliverPolicy()` Gets the deliver policy of this consumer configuration.
`@Nullable java.lang.String`	`getDeliverSubject()` Gets the deliver subject of this consumer configuration.
`@Nullable java.lang.String`	`getDescription()` Gets the name of the description of this consumer configuration.
`@Nullable java.lang.String`	`getDurable()` Gets the name of the durable name for this consumer configuration.
`@Nullable java.lang.String`	`getFilterSubject()` Gets the filter subject of this consumer configuration.
`@Nullable java.util.List<java.lang.String>`	`getFilterSubjects()` Gets the filter subjects as a list.
`@Nullable java.time.Duration`	`getIdleHeartbeat()` Gets the idle heart beat wait time
`@Nullable java.time.Duration`	`getInactiveThreshold()` Get the amount of time before the consumer is deemed inactive.
`long`	`getMaxAckPending()` Gets the maximum ack pending configuration.
`long`	`getMaxBatch()` Get the max batch size for the server to allow on pull requests.
`long`	`getMaxBytes()` Get the max bytes size for the server to allow on pull requests.
`long`	`getMaxDeliver()` Gets the max delivery amount of this consumer configuration.
`@Nullable 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
`@NonNull java.util.Map<java.lang.String,java.lang.String>`	`getMetadata()` Metadata for the consumer; may be empty, will never be null.
`@Nullable java.lang.String`	`getName()` Gets the name of the consumer name for this consumer configuration.
`int`	`getNumReplicas()` Get the number of consumer replicas.
`@Nullable java.time.ZonedDateTime`	`getPauseUntil()` Get the time until the consumer is paused.
`@Nullable java.util.List<java.lang.String>`	`getPriorityGroups()` Gets the priority groups as a list.
`@NonNull PriorityPolicy`	`getPriorityPolicy()` Gets the priority policy of this consumer configuration.
`@Nullable java.time.Duration`	`getPriorityTimeout()` For pinned_client priority policy how long before the client times out
`long`	`getRateLimit()` Gets the rate limit for this consumer configuration.
`@NonNull ReplayPolicy`	`getReplayPolicy()` Gets the replay policy of this consumer configuration.
`@Nullable java.lang.String`	`getSampleFrequency()` Gets the sample frequency.
`long`	`getStartSequence()` Gets the start sequence of this consumer configuration.
`@Nullable java.time.ZonedDateTime`	`getStartTime()` Gets the start time of this consumer configuration.
`boolean`	`hasMultipleFilterSubjects()` Whether there are multiple filter subjects for 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`	`isMemStorage()` Get the mem storage flag 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`	`maxBytesWasSet()` Gets whether max bytes 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`	`memStorageWasSet()` Gets whether mem storage for this consumer configuration was set or left unset
`boolean`	`metadataWasSet()` Gets whether metadata for this consumer configuration was set or left unset
`boolean`	`numReplicasWasSet()` Gets whether num replicas for this consumer configuration was set or left unset
`boolean`	`priorityPolicyWasSet()` Gets whether priority policy for this consumer configuration was set or left unset
`boolean`	`priorityTimeoutWasSet()` Gets whether priority timeout 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
`@NonNull java.lang.String`	`toJson()` Returns a JSON representation of this consumer configuration.
`java.lang.String`	`toString()`

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

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

- Field Detail
  - DEFAULT_DELIVER_POLICY
```
public static final DeliverPolicy DEFAULT_DELIVER_POLICY
```
    The default deliver policy for consumers
  - DEFAULT_ACK_POLICY
```
public static final AckPolicy DEFAULT_ACK_POLICY
```
    The default ack policy for consumers
  - DEFAULT_REPLAY_POLICY
```
public static final ReplayPolicy DEFAULT_REPLAY_POLICY
```
    The default replay policy for consumers
  - DEFAULT_PRIORITY_POLICY
```
public static final PriorityPolicy DEFAULT_PRIORITY_POLICY
```
    The default priority policy for consumers
  - MIN_IDLE_HEARTBEAT
```
public static final java.time.Duration MIN_IDLE_HEARTBEAT
```
    The minimum allowed idle heartbeat setting
  - DURATION_UNSET
```
public static final java.time.Duration DURATION_UNSET
```
    Constant used to unset a Duration setting in the builder
  - INTEGER_UNSET
```
public static final int INTEGER_UNSET
```
    Constant used to unset a Duration setting in the builder
    
    See Also:
    
    Constant Field Values
  - LONG_UNSET
```
public static final long LONG_UNSET
```
    Constant used to unset a long setting in the builder
    
    See Also:
    
    Constant Field Values
  - ULONG_UNSET
```
public static final long ULONG_UNSET
```
    Constant used to unset a long that represents an unsigned long setting in the builder
    
    See Also:
    
    Constant Field Values
  - DURATION_UNSET_LONG
```
public static final long DURATION_UNSET_LONG
```
    Constant used to unset a long setting in the builder
    
    See Also:
    
    Constant Field Values
  - DURATION_MIN_LONG
```
public static final long DURATION_MIN_LONG
```
    Constant used to unset a Duration setting in the builder
    
    See Also:
    
    Constant Field Values
  - STANDARD_MIN
```
public static final int STANDARD_MIN
```
    Constant used to as a standard minimum value
    
    See Also:
    
    Constant Field Values
  - MAX_DELIVER_MIN
```
public static final int MAX_DELIVER_MIN
```
    Constant representing the minimum max deliver
    
    See Also:
    
    Constant Field Values
  - MIN_IDLE_HEARTBEAT_NANOS
```
public static final long MIN_IDLE_HEARTBEAT_NANOS
```
    Constant representing the minimum idle heartbeat in nanos
  - MIN_IDLE_HEARTBEAT_MILLIS
```
public static final long MIN_IDLE_HEARTBEAT_MILLIS
```
    Constant representing the minimum idle heartbeat in milliseconds
  - DURATION_MIN
```
@Deprecated
public static final java.time.Duration DURATION_MIN
```
    Deprecated.
    
    Not used
- Method Detail
  - toJson
```
public @NonNull java.lang.String toJson()
```
    Returns a JSON representation of this consumer configuration.
    
    Specified by:
    
    toJson in interface io.nats.client.support.JsonSerializable
    
    Returns:
    
    json consumer configuration json string
  - getDescription
```
public @Nullable java.lang.String getDescription()
```
    Gets the name of the description of this consumer configuration.
    
    Returns:
    
    name of the description.
  - getDurable
```
public @Nullable java.lang.String getDurable()
```
    Gets the name of the durable name for this consumer configuration.
    
    Returns:
    
    name of the durable.
  - getName
```
public @Nullable java.lang.String getName()
```
    Gets the name of the consumer name for this consumer configuration.
    
    Returns:
    
    name of the consumer.
  - getDeliverSubject
```
public @Nullable java.lang.String getDeliverSubject()
```
    Gets the deliver subject of this consumer configuration.
    
    Returns:
    
    the deliver subject.
  - getDeliverGroup
```
public @Nullable java.lang.String getDeliverGroup()
```
    Gets the deliver group of this consumer configuration.
    
    Returns:
    
    the deliver group.
  - getDeliverPolicy
```
public @NonNull 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 @Nullable java.time.ZonedDateTime getStartTime()
```
    Gets the start time of this consumer configuration.
    
    Returns:
    
    the start time.
  - getAckPolicy
```
public @NonNull AckPolicy getAckPolicy()
```
    Gets the acknowledgment policy of this consumer configuration.
    
    Returns:
    
    the acknowledgment policy.
  - getAckWait
```
public @Nullable 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 @Nullable java.lang.String getFilterSubject()
```
    Gets the filter subject of this consumer configuration. With the introduction of multiple filter subjects, this method will return null if there are not exactly one filter subjects
    
    Returns:
    
    the first filter subject.
  - getFilterSubjects
```
public @Nullable java.util.List<java.lang.String> getFilterSubjects()
```
    Gets the filter subjects as a list. May be null, otherwise won't be empty
    
    Returns:
    
    the list
  - getPriorityGroups
```
public @Nullable java.util.List<java.lang.String> getPriorityGroups()
```
    Gets the priority groups as a list. May be null, otherwise won't be empty
    
    Returns:
    
    the list
  - hasMultipleFilterSubjects
```
public boolean hasMultipleFilterSubjects()
```
    Whether there are multiple filter subjects for this consumer configuration.
    
    Returns:
    
    true if there are multiple filter subjects
  - getReplayPolicy
```
public @NonNull 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 bits per second
  - getMaxAckPending
```
public long getMaxAckPending()
```
    Gets the maximum ack pending configuration.
    
    Returns:
    
    maximum ack pending.
  - getSampleFrequency
```
public @Nullable java.lang.String getSampleFrequency()
```
    Gets the sample frequency.
    
    Returns:
    
    sampleFrequency.
  - getIdleHeartbeat
```
public @Nullable 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
  - isMemStorage
```
public boolean isMemStorage()
```
    Get the mem storage flag whether it's on or off.
    
    Returns:
    
    the mem storage mode
  - getMaxBatch
```
public long getMaxBatch()
```
    Get the max batch size for the server to allow on pull requests.
    
    Returns:
    
    the max batch size
  - getMaxBytes
```
public long getMaxBytes()
```
    Get the max bytes size for the server to allow on pull requests.
    
    Returns:
    
    the max byte size
  - getMaxExpires
```
public @Nullable 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 @Nullable java.time.Duration getInactiveThreshold()
```
    Get the amount of time before the consumer is deemed inactive.
    
    Returns:
    
    the inactive threshold
  - getBackoff
```
public @NonNull java.util.List<java.time.Duration> getBackoff()
```
    Get the backoff list; may be empty, will never be null.
    
    Returns:
    
    the list
  - getMetadata
```
public @NonNull java.util.Map<java.lang.String,java.lang.String> getMetadata()
```
    Metadata for the consumer; may be empty, will never be null.
    
    Returns:
    
    the metadata map
  - getNumReplicas
```
public int getNumReplicas()
```
    Get the number of consumer replicas.
    
    Returns:
    
    the replicas count
  - getPauseUntil
```
public @Nullable java.time.ZonedDateTime getPauseUntil()
```
    Get the time until the consumer is paused.
    
    Returns:
    
    paused until time
  - getPriorityPolicy
```
public @NonNull PriorityPolicy getPriorityPolicy()
```
    Gets the priority policy of this consumer configuration. Defaults to PriorityPolicy.None
    
    Returns:
    
    the priority policy.
  - getPriorityTimeout
```
public @Nullable java.time.Duration getPriorityTimeout()
```
    For pinned_client priority policy how long before the client times out
    
    Returns:
    
    the duration
  - 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
  - maxBytesWasSet
```
public boolean maxBytesWasSet()
```
    Gets whether max bytes for this consumer configuration was set or left unset
    
    Returns:
    
    true if max bytes 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
  - memStorageWasSet
```
public boolean memStorageWasSet()
```
    Gets whether mem storage for this consumer configuration was set or left unset
    
    Returns:
    
    true if the policy was set, false if the policy was not set
  - numReplicasWasSet
```
public boolean numReplicasWasSet()
```
    Gets whether num replicas for this consumer configuration was set or left unset
    
    Returns:
    
    true if num replicas was set by the user
  - backoffWasSet
```
public boolean backoffWasSet()
```
    Gets whether backoff for this consumer configuration was set or left unset
    
    Returns:
    
    true if num backoff was set by the user
  - metadataWasSet
```
public boolean metadataWasSet()
```
    Gets whether metadata for this consumer configuration was set or left unset
    
    Returns:
    
    true if num metadata was set by the user
  - priorityPolicyWasSet
```
public boolean priorityPolicyWasSet()
```
    Gets whether priority policy for this consumer configuration was set or left unset
    
    Returns:
    
    true if the policy was set, false if the policy was not set
  - priorityTimeoutWasSet
```
public boolean priorityTimeoutWasSet()
```
    Gets whether priority timeout for this consumer configuration was set or left unset
    
    Returns:
    
    true if the timeout was set, false if the timeout was not set
  - builder
```
public static ConsumerConfiguration.Builder builder()
```
    Creates a builder for the options.
    
    Returns:
    
    a publish options builder
  - builder
```
public static ConsumerConfiguration.Builder builder(ConsumerConfiguration cc)
```
    Creates a builder for the 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

DEFAULT_DELIVER_POLICY

DEFAULT_ACK_POLICY

DEFAULT_REPLAY_POLICY

DEFAULT_PRIORITY_POLICY

MIN_IDLE_HEARTBEAT

DURATION_UNSET

INTEGER_UNSET

LONG_UNSET

ULONG_UNSET

DURATION_UNSET_LONG

DURATION_MIN_LONG

STANDARD_MIN

MAX_DELIVER_MIN

MIN_IDLE_HEARTBEAT_NANOS

MIN_IDLE_HEARTBEAT_MILLIS

DURATION_MIN

Method Detail

toJson

getDescription

getDurable

getName

getDeliverSubject

getDeliverGroup

getDeliverPolicy

getStartSequence

getStartTime

getAckPolicy

getAckWait

getMaxDeliver

getFilterSubject

getFilterSubjects

getPriorityGroups

hasMultipleFilterSubjects

getReplayPolicy

getRateLimit

getMaxAckPending

getSampleFrequency

getIdleHeartbeat

isFlowControl

getMaxPullWaiting

isHeadersOnly

isMemStorage

getMaxBatch

getMaxBytes

getMaxExpires

getInactiveThreshold

getBackoff

getMetadata

getNumReplicas

getPauseUntil

getPriorityPolicy

getPriorityTimeout

deliverPolicyWasSet

ackPolicyWasSet

replayPolicyWasSet

startSeqWasSet

maxDeliverWasSet

rateLimitWasSet

maxAckPendingWasSet

maxPullWaitingWasSet

maxBatchWasSet

maxBytesWasSet

flowControlWasSet

headersOnlyWasSet

memStorageWasSet

numReplicasWasSet

backoffWasSet

metadataWasSet

priorityPolicyWasSet

priorityTimeoutWasSet

builder

builder

toString