io.nats.client

Class FetchConsumeOptions

java.lang.Object

io.nats.client.BaseConsumeOptions

io.nats.client.FetchConsumeOptions

All Implemented Interfaces:

io.nats.client.support.JsonSerializable

public class FetchConsumeOptions
extends BaseConsumeOptions

Fetch Consume Options are provided to customize the fetch operation.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FetchConsumeOptions.Builder The builder for FetchConsumeOptions

Field Summary

Fields

Modifier and Type	Field and Description
static FetchConsumeOptions	DEFAULT_FETCH_OPTIONS An instance of FetchConsumeOptions representing the default fetch 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 FetchConsumeOptions.Builder	builder() Get an instance of the builder
long	getMaxBytes() The maximum number of bytes to fetch.
int	getMaxMessages() The maximum number of messages to fetch.
boolean	isNoWait() If the options specify no wait

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_FETCH_OPTIONS

public static final FetchConsumeOptions DEFAULT_FETCH_OPTIONS

An instance of FetchConsumeOptions representing the default fetch options

Method Detail

getMaxMessages

public int getMaxMessages()

The maximum number of messages to fetch.

Returns:

the maximum number of messages to fetch

getMaxBytes

public long getMaxBytes()

The maximum number of bytes to fetch.

Returns:

the maximum number of bytes to fetch

isNoWait

public boolean isNoWait()

If the options specify no wait

Returns:

the flag

builder

public static FetchConsumeOptions.Builder builder()

Get an instance of the builder

Returns:

a builder