io.nats.client

Class FetchConsumeOptions.Builder

java.lang.Object

io.nats.client.BaseConsumeOptions.Builder<FetchConsumeOptions.Builder,FetchConsumeOptions>

io.nats.client.FetchConsumeOptions.Builder

Enclosing class:

FetchConsumeOptions

public static class FetchConsumeOptions.Builder
extends BaseConsumeOptions.Builder<FetchConsumeOptions.Builder,FetchConsumeOptions>

Field Summary

Fields inherited from class io.nats.client.BaseConsumeOptions.Builder

bytes, expiresIn, messages, noWait, thresholdPercent

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
FetchConsumeOptions	build() Build the FetchConsumeOptions.
protected FetchConsumeOptions.Builder	getThis()
FetchConsumeOptions.Builder	max(int maxBytes, int maxMessages) Set maximum number of bytes or messages to fetch.
FetchConsumeOptions.Builder	maxBytes(long maxBytes) Set maximum number of bytes to fetch and remove any previously set constraint The number of bytes fetched will also be constrained by the expiration time.
FetchConsumeOptions.Builder	maxMessages(int maxMessages) Set the maximum number of messages to fetch and remove any previously set maxBytes(long) constraint.
FetchConsumeOptions.Builder	noWait() Set no wait to true
FetchConsumeOptions.Builder	noWaitExpiresIn(long expiresInMillis) Set no wait to true with an expiration, special behavior.

Methods inherited from class io.nats.client.BaseConsumeOptions.Builder

bytes, expiresIn, json, jsonValue, messages, thresholdPercent

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

getThis

protected FetchConsumeOptions.Builder getThis()

Specified by:

getThis in class BaseConsumeOptions.Builder<FetchConsumeOptions.Builder,FetchConsumeOptions>

maxMessages

public FetchConsumeOptions.Builder maxMessages(int maxMessages)

Set the maximum number of messages to fetch and remove any previously set maxBytes(long) constraint. The number of messages fetched will also be constrained by the expiration time.

Less than 1 means default of .

Parameters:

maxMessages - the number of messages.

Returns:

the builder

maxBytes

public FetchConsumeOptions.Builder maxBytes(long maxBytes)

Set maximum number of bytes to fetch and remove any previously set constraint The number of bytes fetched will also be constrained by the expiration time.

Less than 1 removes any previously set max bytes constraint.

It is important to set the byte size greater than your largest message payload, plus some amount to account for overhead, otherwise the consume process will stall if there are no messages that fit the criteria.

Parameters:

maxBytes - the maximum bytes

Returns:

the builder

See Also:

Message.consumeByteCount()

max

public FetchConsumeOptions.Builder max(int maxBytes,
                                       int maxMessages)

Set maximum number of bytes or messages to fetch. The number of messages/bytes fetched will also be constrained by whichever constraint is reached first, as well as the expiration time.

Less than 1 max bytes removes any previously set max bytes constraint.

Less than 1 max messages removes any previously set max messages constraint.

It is important to set the byte size greater than your largest message payload, plus some amount to account for overhead, otherwise the consume process will stall if there are no messages that fit the criteria.

Parameters:

maxBytes - the maximum bytes

maxMessages - the maximum number of messages

Returns:

the builder

See Also:

Message.consumeByteCount()

noWait

public FetchConsumeOptions.Builder noWait()

Set no wait to true

Overrides:

noWait in class BaseConsumeOptions.Builder<FetchConsumeOptions.Builder,FetchConsumeOptions>

Returns:

the builder

noWaitExpiresIn

public FetchConsumeOptions.Builder noWaitExpiresIn(long expiresInMillis)

Set no wait to true with an expiration, special behavior.

Parameters:

expiresInMillis - the expiration time in milliseconds

Returns:

the builder

build

public FetchConsumeOptions build()

Build the FetchConsumeOptions.

Specified by:

build in class BaseConsumeOptions.Builder<FetchConsumeOptions.Builder,FetchConsumeOptions>

Returns:

a FetchConsumeOptions instance