io.nats.client

Class BaseConsumeOptions.Builder<B,CO>

java.lang.Object

io.nats.client.BaseConsumeOptions.Builder<B,CO>

Direct Known Subclasses:

ConsumeOptions.Builder, FetchConsumeOptions.Builder

Enclosing class:

BaseConsumeOptions

protected abstract static class BaseConsumeOptions.Builder<B,CO>
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
protected long	bytes
protected long	expiresIn
protected java.lang.String	group
protected int	messages
protected long	minAckPending
protected long	minPending
protected boolean	raiseStatusWarnings
protected int	thresholdPercent

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Builder()

Method Summary

Modifier and Type	Method and Description
abstract CO	build() Build the options.
protected B	bytes(long bytes)
B	expiresIn(long expiresInMillis) In Fetch, sets the maximum amount of time to wait to reach the batch size or max byte.
protected abstract B	getThis()
B	group(java.lang.String group) Sets the group
B	json(java.lang.String json) Initialize values from the json string.
B	jsonValue(JsonValue jsonValue) Initialize values from the JsonValue object.
protected B	messages(int messages)
B	minAckPending(long minAckPending) When specified, the consumer will only receive messages when the consumer has at least this many ack pending messages.
B	minPending(long minPending) When specified, the consumer will only receive messages when the consumer has at least this many pending messages.
B	raiseStatusWarnings() Raise status warning turns on sending status messages to the error listener.
B	raiseStatusWarnings(boolean raiseStatusWarnings) Turn on or off raise status warning turns.
B	thresholdPercent(int thresholdPercent) Set the threshold percent of max bytes (if max bytes is specified) or messages that will trigger issuing pull requests to keep messages flowing.

Methods inherited from class java.lang.Object

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

Field Detail

messages

protected int messages

bytes

protected long bytes

thresholdPercent

protected int thresholdPercent

expiresIn

protected long expiresIn

raiseStatusWarnings

protected boolean raiseStatusWarnings

group

protected java.lang.String group

minPending

protected long minPending

minAckPending

protected long minAckPending

Constructor Detail

Builder

protected Builder()

Method Detail

getThis

protected abstract B getThis()

json

public B json(java.lang.String json)
       throws JsonParseException

Initialize values from the json string.

Parameters:

json - the json string to parse

Returns:

the builder

Throws:

JsonParseException - if the json is invalid

jsonValue

public B jsonValue(JsonValue jsonValue)

Initialize values from the JsonValue object.

Parameters:

jsonValue - the json value object

Returns:

the builder

messages

protected B messages(int messages)

bytes

protected B bytes(long bytes)

expiresIn

public B expiresIn(long expiresInMillis)

In Fetch, sets the maximum amount of time to wait to reach the batch size or max byte. In Consume, sets the maximum amount of time for an individual pull to be open before issuing a replacement pull.

Zero or less will default to , otherwise, cannot be less than

Parameters:

expiresInMillis - the expiration time in milliseconds

Returns:

the builder

thresholdPercent

public B thresholdPercent(int thresholdPercent)

Set the threshold percent of max bytes (if max bytes is specified) or messages that will trigger issuing pull requests to keep messages flowing.

Only applies to endless consumes.

For instance if the batch size is 100 and the re-pull percent is 25, the first pull will be for 100, and then when 25 messages have been received another 75 will be requested, keeping the number of messages in transit always at 100.

Must be between 1 and 100 inclusive. Less than 1 will assume the default of . Greater than 100 will assume 100.

Parameters:

thresholdPercent - the threshold percent

Returns:

the builder

raiseStatusWarnings

public B raiseStatusWarnings()

Raise status warning turns on sending status messages to the error listener. The default of to not raise status warning

Returns:

the builder

raiseStatusWarnings

public B raiseStatusWarnings(boolean raiseStatusWarnings)

Turn on or off raise status warning turns. When on, status messages are sent to the error listener. The default of to not raise status warning

Returns:

the builder

group

public B group(java.lang.String group)

Sets the group

Parameters:

group - the priority group for this pull

Returns:

Builder

minPending

public B minPending(long minPending)

When specified, the consumer will only receive messages when the consumer has at least this many pending messages.

Parameters:

minPending - the min pending

Returns:

the builder

minAckPending

public B minAckPending(long minAckPending)

When specified, the consumer will only receive messages when the consumer has at least this many ack pending messages.

Parameters:

minAckPending - the min ack pending

Returns:

the builder

build

public abstract CO build()

Build the options.

Returns:

the built options