io.nats.client

Class ConsumeOptions

java.lang.Object

io.nats.client.BaseConsumeOptions

io.nats.client.ConsumeOptions

All Implemented Interfaces:

io.nats.client.support.JsonSerializable

public class ConsumeOptions
extends BaseConsumeOptions

Consume Options are provided to customize the consume operation.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ConsumeOptions.Builder The Consume Options Builder

Field Summary

Fields

Modifier and Type	Field and Description
static ConsumeOptions	DEFAULT_CONSUME_OPTIONS An instance of ConsumeOptions representing the default consume options

Fields inherited from class io.nats.client.BaseConsumeOptions

DEFAULT_EXPIRES_IN_MILLIS, DEFAULT_MESSAGE_COUNT, DEFAULT_MESSAGE_COUNT_WHEN_BYTES, DEFAULT_THRESHOLD_PERCENT, MAX_HEARTBEAT_MILLIS, MAX_IDLE_HEARTBEAT_PERCENT, MIN_EXPIRES_MILLS

Method Summary

Modifier and Type	Method and Description
static ConsumeOptions.Builder	builder() Get an instance of the Builder
long	getBatchBytes() The initial batch size in bytes.
int	getBatchSize() The initial batch size in messages.

Methods inherited from class io.nats.client.BaseConsumeOptions

getExpiresInMillis, getGroup, getIdleHeartbeat, getMinAckPending, getMinPending, getPriority, getThresholdPercent, raiseStatusWarnings, 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_CONSUME_OPTIONS

public static final ConsumeOptions DEFAULT_CONSUME_OPTIONS

An instance of ConsumeOptions representing the default consume options

Method Detail

getBatchSize

public int getBatchSize()

The initial batch size in messages.

Returns:

the initial batch size in messages

getBatchBytes

public long getBatchBytes()

The initial batch size in bytes.

Returns:

the initial batch size in bytes

builder

public static ConsumeOptions.Builder builder()

Get an instance of the Builder

Returns:

a builder