io.nats.client

Class BaseConsumeOptions

java.lang.Object

io.nats.client.BaseConsumeOptions

All Implemented Interfaces:

io.nats.client.support.JsonSerializable

Direct Known Subclasses:

ConsumeOptions, FetchConsumeOptions

public class BaseConsumeOptions
extends java.lang.Object
implements io.nats.client.support.JsonSerializable

Base Consume Options are provided to customize the way the consume and fetch operate. It is the base class for ConsumeOptions and FetchConsumeOptions.

Field Summary

Fields

Modifier and Type	Field and Description
static long	DEFAULT_EXPIRES_IN_MILLIS constant for default expires in millis
static int	DEFAULT_MESSAGE_COUNT constant for default message count
static int	DEFAULT_MESSAGE_COUNT_WHEN_BYTES constant for default message count when bytes
static int	DEFAULT_THRESHOLD_PERCENT constant for default threshold percent
static long	MAX_HEARTBEAT_MILLIS constant for max heartbeat millis
static int	MAX_IDLE_HEARTBEAT_PERCENT constant for max idle heartbeat percent
static long	MIN_EXPIRES_MILLS constant for min expires mills

Method Summary

Modifier and Type	Method and Description
long	getExpiresInMillis() Get the expires setting
java.lang.String	getGroup() Get the priority group setting A group must be set if a PriorityPolicy has been specified.
long	getIdleHeartbeat() Get the idle heartbeat value
long	getMinAckPending() Get the min ack pending setting as per the overflow priority group.
long	getMinPending() Get the min pending setting as per the overflow priority group.
int	getPriority() Get the priority setting
int	getThresholdPercent() Get the threshold percent setting
boolean	raiseStatusWarnings() Whether to raise status warnings to the error listener
@NonNull java.lang.String	toJson()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

serialize, toJsonValue

Field Detail

DEFAULT_MESSAGE_COUNT

public static final int DEFAULT_MESSAGE_COUNT

constant for default message count

See Also:

Constant Field Values

DEFAULT_MESSAGE_COUNT_WHEN_BYTES

public static final int DEFAULT_MESSAGE_COUNT_WHEN_BYTES

constant for default message count when bytes

See Also:

Constant Field Values

DEFAULT_THRESHOLD_PERCENT

public static final int DEFAULT_THRESHOLD_PERCENT

constant for default threshold percent

See Also:

Constant Field Values

DEFAULT_EXPIRES_IN_MILLIS

public static final long DEFAULT_EXPIRES_IN_MILLIS

constant for default expires in millis

See Also:

Constant Field Values

MIN_EXPIRES_MILLS

public static final long MIN_EXPIRES_MILLS

constant for min expires mills

See Also:

Constant Field Values

MAX_HEARTBEAT_MILLIS

public static final long MAX_HEARTBEAT_MILLIS

constant for max heartbeat millis

See Also:

Constant Field Values

MAX_IDLE_HEARTBEAT_PERCENT

public static final int MAX_IDLE_HEARTBEAT_PERCENT

constant for max idle heartbeat percent

See Also:

Constant Field Values

Method Detail

toJson

public @NonNull java.lang.String toJson()

Specified by:

toJson in interface io.nats.client.support.JsonSerializable

getExpiresInMillis

public long getExpiresInMillis()

Get the expires setting

Returns:

the expires, in milliseconds

getIdleHeartbeat

public long getIdleHeartbeat()

Get the idle heartbeat value

Returns:

the idle heartbeat in milliseconds

getThresholdPercent

public int getThresholdPercent()

Get the threshold percent setting

Returns:

the threshold percent

raiseStatusWarnings

public boolean raiseStatusWarnings()

Whether to raise status warnings to the error listener

Returns:

true if should raise status warnings

getGroup

public java.lang.String getGroup()

Get the priority group setting A group must be set if a PriorityPolicy has been specified. The group must be consistent with the groups specified in the ConsumerConfiguration.

Returns:

the priority group

getPriority

public int getPriority()

Get the priority setting

Returns:

the priority

getMinPending

public long getMinPending()

Get the min pending setting as per the overflow priority group. See PriorityPolicy.

Returns:

the min pending

getMinAckPending

public long getMinAckPending()

Get the min ack pending setting as per the overflow priority group. See PriorityPolicy.

Returns:

the min ack pending