io.nats.client.api

Class ConsumerConfiguration.Builder

java.lang.Object

io.nats.client.api.ConsumerConfiguration.Builder

Enclosing class:

ConsumerConfiguration

public static class ConsumerConfiguration.Builder
extends java.lang.Object

ConsumerConfiguration is created using a Builder. The builder supports chaining and will create a default set of options if no methods are calls.

new ConsumerConfiguration.Builder().build() will create a default ConsumerConfiguration.

Constructor Summary

Constructors

Constructor and Description
Builder() Construct the builder
Builder(ConsumerConfiguration cc) Construct the builder and initialize values with the existing ConsumerConfiguration

Method Summary

Modifier and Type	Method and Description
ConsumerConfiguration.Builder	ackPolicy(AckPolicy policy) Sets the acknowledgement policy of the ConsumerConfiguration.
ConsumerConfiguration.Builder	ackWait(java.time.Duration timeout) Sets the acknowledgement wait duration of the ConsumerConfiguration.
ConsumerConfiguration.Builder	ackWait(long timeoutMillis) Sets the acknowledgement wait duration of the ConsumerConfiguration.
ConsumerConfiguration.Builder	backoff(java.time.Duration... backoffs) Set the list of backoff.
ConsumerConfiguration.Builder	backoff(long... backoffsMillis) Set the list of backoff.
ConsumerConfiguration	build() Builds the ConsumerConfiguration
PullSubscribeOptions	buildPullSubscribeOptions() Builds the PullSubscribeOptions with this configuration
PullSubscribeOptions	buildPullSubscribeOptions(java.lang.String stream) Builds the PullSubscribeOptions with this configuration Providing the stream is a hint for the subscription process that saves a call to the server.
PushSubscribeOptions	buildPushSubscribeOptions() Builds the PushSubscribeOptions with this configuration
PushSubscribeOptions	buildPushSubscribeOptions(java.lang.String stream) Builds the PushSubscribeOptions with this configuration.
ConsumerConfiguration.Builder	deliverGroup(java.lang.String group) Sets the group to deliver messages to.
ConsumerConfiguration.Builder	deliverPolicy(DeliverPolicy policy) Sets the delivery policy of the ConsumerConfiguration.
ConsumerConfiguration.Builder	deliverSubject(java.lang.String subject) Sets the subject to deliver messages to.
ConsumerConfiguration.Builder	description(java.lang.String description) Sets the description
ConsumerConfiguration.Builder	durable(java.lang.String durable) Sets the name of the durable consumer.
ConsumerConfiguration.Builder	filterSubject(java.lang.String filterSubject) Sets the filter subject of the ConsumerConfiguration.
ConsumerConfiguration.Builder	filterSubjects(java.util.List<java.lang.String> filterSubjects) Sets the filter subjects of the ConsumerConfiguration.
ConsumerConfiguration.Builder	filterSubjects(java.lang.String... filterSubjects) Sets the filter subjects of the ConsumerConfiguration.
ConsumerConfiguration.Builder	flowControl(java.time.Duration idleHeartbeat) set the flow control on and set the idle heartbeat
ConsumerConfiguration.Builder	flowControl(long idleHeartbeatMillis) set the flow control on and set the idle heartbeat
ConsumerConfiguration.Builder	headersOnly(java.lang.Boolean headersOnly) set the headers only flag saying to deliver only the headers of messages in the stream and not the bodies
ConsumerConfiguration.Builder	idleHeartbeat(java.time.Duration idleHeartbeat) sets the idle heart beat wait time
ConsumerConfiguration.Builder	idleHeartbeat(long idleHeartbeatMillis) sets the idle heart beat wait time
ConsumerConfiguration.Builder	inactiveThreshold(java.time.Duration inactiveThreshold) sets the amount of time before the consumer is deemed inactive.
ConsumerConfiguration.Builder	inactiveThreshold(long inactiveThreshold) sets the amount of time before the consumer is deemed inactive.
ConsumerConfiguration.Builder	json(java.lang.String json) Initialize values from the json string.
ConsumerConfiguration.Builder	jsonValue(JsonValue jsonValue) Initialize values from the JsonValue object.
ConsumerConfiguration.Builder	maxAckPending(long maxAckPending) Sets the maximum ack pending.
ConsumerConfiguration.Builder	maxAckPending(java.lang.Long maxAckPending) Sets the maximum ack pending or null to unset / clear.
ConsumerConfiguration.Builder	maxBatch(long maxBatch) sets the max batch size for the server to allow on pull requests.
ConsumerConfiguration.Builder	maxBatch(java.lang.Long maxBatch) sets the max batch size for the server to allow on pull requests.
ConsumerConfiguration.Builder	maxBytes(long maxBytes) sets the max bytes size for the server to allow on pull requests.
ConsumerConfiguration.Builder	maxBytes(java.lang.Long maxBytes) sets the max bytes size for the server to allow on pull requests.
ConsumerConfiguration.Builder	maxDeliver(long maxDeliver) Sets the maximum delivery amount of the ConsumerConfiguration.
ConsumerConfiguration.Builder	maxDeliver(java.lang.Long maxDeliver) Sets the maximum delivery amount of the ConsumerConfiguration or null to unset / clear.
ConsumerConfiguration.Builder	maxExpires(java.time.Duration maxExpires) sets the max amount of expire time for the server to allow on pull requests.
ConsumerConfiguration.Builder	maxExpires(long maxExpires) sets the max amount of expire time for the server to allow on pull requests.
ConsumerConfiguration.Builder	maxPullWaiting(long maxPullWaiting) sets the max pull waiting, the number of pulls that can be outstanding on a pull consumer, pulls received after this is reached are ignored.
ConsumerConfiguration.Builder	maxPullWaiting(java.lang.Long maxPullWaiting) sets the max pull waiting, the number of pulls that can be outstanding on a pull consumer, pulls received after this is reached are ignored.
ConsumerConfiguration.Builder	memStorage(java.lang.Boolean memStorage) set the mem storage flag to force the consumer state to be kept in memory rather than inherit the setting from the stream
ConsumerConfiguration.Builder	metadata(java.util.Map<java.lang.String,java.lang.String> metadata) Sets the metadata for the configuration
ConsumerConfiguration.Builder	name(java.lang.String name) Sets the name of the consumer.
ConsumerConfiguration.Builder	numReplicas(java.lang.Integer numReplicas) set the number of replicas for the consumer.
ConsumerConfiguration.Builder	pauseUntil(java.time.ZonedDateTime pauseUntil) Sets the time to pause the consumer until.
ConsumerConfiguration.Builder	rateLimit(long bitsPerSecond) Set the rate limit of the ConsumerConfiguration.
ConsumerConfiguration.Builder	rateLimit(java.lang.Long bitsPerSecond) Set the rate limit of the ConsumerConfiguration or null to unset / clear.
ConsumerConfiguration.Builder	replayPolicy(ReplayPolicy policy) Sets the replay policy of the ConsumerConfiguration.
ConsumerConfiguration.Builder	sampleFrequency(java.lang.String frequency) Sets the sample frequency of the ConsumerConfiguration.
ConsumerConfiguration.Builder	startSequence(long sequence) Sets the start sequence of the ConsumerConfiguration.
ConsumerConfiguration.Builder	startSequence(java.lang.Long sequence) Sets the start sequence of the ConsumerConfiguration or null to unset / clear.
ConsumerConfiguration.Builder	startTime(java.time.ZonedDateTime startTime) Sets the start time of the ConsumerConfiguration.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Construct the builder

Builder

public Builder(ConsumerConfiguration cc)

Construct the builder and initialize values with the existing ConsumerConfiguration

Parameters:

cc - the consumer configuration to clone

Method Detail

json

public ConsumerConfiguration.Builder 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 ConsumerConfiguration.Builder jsonValue(JsonValue jsonValue)

Initialize values from the JsonValue object.

Parameters:

jsonValue - the json value object

Returns:

the builder

description

public ConsumerConfiguration.Builder description(java.lang.String description)

Sets the description

Parameters:

description - the description

Returns:

the builder

durable

public ConsumerConfiguration.Builder durable(java.lang.String durable)

Sets the name of the durable consumer. Null or empty clears the field.

Parameters:

durable - name of the durable consumer.

Returns:

the builder

name

public ConsumerConfiguration.Builder name(java.lang.String name)

Sets the name of the consumer. Null or empty clears the field.

Parameters:

name - name of the consumer.

Returns:

the builder

deliverPolicy

public ConsumerConfiguration.Builder deliverPolicy(DeliverPolicy policy)

Sets the delivery policy of the ConsumerConfiguration.

Parameters:

policy - the delivery policy.

Returns:

Builder

deliverSubject

public ConsumerConfiguration.Builder deliverSubject(java.lang.String subject)

Sets the subject to deliver messages to.

By setting the deliverySubject this configuration will create a push consumer. When left empty or set to NULL a pull consumer will be created.

Parameters:

subject - the subject.

Returns:

the builder

deliverGroup

public ConsumerConfiguration.Builder deliverGroup(java.lang.String group)

Sets the group to deliver messages to.

Parameters:

group - the delivery group.

Returns:

the builder

startSequence

public ConsumerConfiguration.Builder startSequence(java.lang.Long sequence)

Sets the start sequence of the ConsumerConfiguration or null to unset / clear.

Parameters:

sequence - the start sequence

Returns:

Builder

startSequence

public ConsumerConfiguration.Builder startSequence(long sequence)

Sets the start sequence of the ConsumerConfiguration.

Parameters:

sequence - the start sequence

Returns:

Builder

startTime

public ConsumerConfiguration.Builder startTime(java.time.ZonedDateTime startTime)

Sets the start time of the ConsumerConfiguration.

Parameters:

startTime - the start time

Returns:

Builder

ackPolicy

public ConsumerConfiguration.Builder ackPolicy(AckPolicy policy)

Sets the acknowledgement policy of the ConsumerConfiguration.

Parameters:

policy - the acknowledgement policy.

Returns:

Builder

ackWait

public ConsumerConfiguration.Builder ackWait(java.time.Duration timeout)

Sets the acknowledgement wait duration of the ConsumerConfiguration.

Parameters:

timeout - the wait timeout

Returns:

Builder

ackWait

public ConsumerConfiguration.Builder ackWait(long timeoutMillis)

Sets the acknowledgement wait duration of the ConsumerConfiguration.

Parameters:

timeoutMillis - the wait timeout in milliseconds

Returns:

Builder

maxDeliver

public ConsumerConfiguration.Builder maxDeliver(java.lang.Long maxDeliver)

Sets the maximum delivery amount of the ConsumerConfiguration or null to unset / clear.

Parameters:

maxDeliver - the maximum delivery amount

Returns:

Builder

maxDeliver

public ConsumerConfiguration.Builder maxDeliver(long maxDeliver)

Sets the maximum delivery amount of the ConsumerConfiguration.

Parameters:

maxDeliver - the maximum delivery amount

Returns:

Builder

filterSubject

public ConsumerConfiguration.Builder filterSubject(java.lang.String filterSubject)

Sets the filter subject of the ConsumerConfiguration. Replaces any other filter subjects set in the builder

Parameters:

filterSubject - the filter subject

Returns:

Builder

filterSubjects

public ConsumerConfiguration.Builder filterSubjects(java.lang.String... filterSubjects)

Sets the filter subjects of the ConsumerConfiguration. Replaces any other filter subjects set in the builder

Parameters:

filterSubjects - one or more filter subjects

Returns:

Builder

filterSubjects

public ConsumerConfiguration.Builder filterSubjects(java.util.List<java.lang.String> filterSubjects)

Sets the filter subjects of the ConsumerConfiguration. Replaces any other filter subjects set in the builder

Parameters:

filterSubjects - the list of filter subjects

Returns:

Builder

replayPolicy

public ConsumerConfiguration.Builder replayPolicy(ReplayPolicy policy)

Sets the replay policy of the ConsumerConfiguration.

Parameters:

policy - the replay policy.

Returns:

Builder

sampleFrequency

public ConsumerConfiguration.Builder sampleFrequency(java.lang.String frequency)

Sets the sample frequency of the ConsumerConfiguration.

Parameters:

frequency - the frequency

Returns:

Builder

rateLimit

public ConsumerConfiguration.Builder rateLimit(java.lang.Long bitsPerSecond)

Set the rate limit of the ConsumerConfiguration or null to unset / clear.

Parameters:

bitsPerSecond - bits per second to deliver

Returns:

Builder

rateLimit

public ConsumerConfiguration.Builder rateLimit(long bitsPerSecond)

Set the rate limit of the ConsumerConfiguration.

Parameters:

bitsPerSecond - bits per second to deliver

Returns:

Builder

maxAckPending

public ConsumerConfiguration.Builder maxAckPending(java.lang.Long maxAckPending)

Sets the maximum ack pending or null to unset / clear.

Parameters:

maxAckPending - maximum pending acknowledgements.

Returns:

Builder

maxAckPending

public ConsumerConfiguration.Builder maxAckPending(long maxAckPending)

Sets the maximum ack pending.

Parameters:

maxAckPending - maximum pending acknowledgements.

Returns:

Builder

idleHeartbeat

public ConsumerConfiguration.Builder idleHeartbeat(java.time.Duration idleHeartbeat)

sets the idle heart beat wait time

Parameters:

idleHeartbeat - the idle heart beat duration

Returns:

Builder

idleHeartbeat

public ConsumerConfiguration.Builder idleHeartbeat(long idleHeartbeatMillis)

sets the idle heart beat wait time

Parameters:

idleHeartbeatMillis - the idle heart beat duration in milliseconds

Returns:

Builder

flowControl

public ConsumerConfiguration.Builder flowControl(java.time.Duration idleHeartbeat)

set the flow control on and set the idle heartbeat

Parameters:

idleHeartbeat - the idle heart beat duration

Returns:

Builder

flowControl

public ConsumerConfiguration.Builder flowControl(long idleHeartbeatMillis)

set the flow control on and set the idle heartbeat

Parameters:

idleHeartbeatMillis - the idle heart beat duration in milliseconds

Returns:

Builder

maxExpires

public ConsumerConfiguration.Builder maxExpires(java.time.Duration maxExpires)

sets the max amount of expire time for the server to allow on pull requests.

Parameters:

maxExpires - the max expire duration

Returns:

Builder

maxExpires

public ConsumerConfiguration.Builder maxExpires(long maxExpires)

sets the max amount of expire time for the server to allow on pull requests.

Parameters:

maxExpires - the max expire duration in milliseconds

Returns:

Builder

inactiveThreshold

public ConsumerConfiguration.Builder inactiveThreshold(java.time.Duration inactiveThreshold)

sets the amount of time before the consumer is deemed inactive.

Parameters:

inactiveThreshold - the threshold duration

Returns:

Builder

inactiveThreshold

public ConsumerConfiguration.Builder inactiveThreshold(long inactiveThreshold)

sets the amount of time before the consumer is deemed inactive.

Parameters:

inactiveThreshold - the threshold duration in milliseconds

Returns:

Builder

maxPullWaiting

public ConsumerConfiguration.Builder maxPullWaiting(java.lang.Long maxPullWaiting)

sets the max pull waiting, the number of pulls that can be outstanding on a pull consumer, pulls received after this is reached are ignored. Use null to unset / clear.

Parameters:

maxPullWaiting - the max pull waiting

Returns:

Builder

maxPullWaiting

public ConsumerConfiguration.Builder maxPullWaiting(long maxPullWaiting)

sets the max pull waiting, the number of pulls that can be outstanding on a pull consumer, pulls received after this is reached are ignored.

Parameters:

maxPullWaiting - the max pull waiting

Returns:

Builder

maxBatch

public ConsumerConfiguration.Builder maxBatch(java.lang.Long maxBatch)

sets the max batch size for the server to allow on pull requests.

Parameters:

maxBatch - the max batch size

Returns:

Builder

maxBatch

public ConsumerConfiguration.Builder maxBatch(long maxBatch)

sets the max batch size for the server to allow on pull requests.

Parameters:

maxBatch - the max batch size

Returns:

Builder

maxBytes

public ConsumerConfiguration.Builder maxBytes(java.lang.Long maxBytes)

sets the max bytes size for the server to allow on pull requests.

Parameters:

maxBytes - the max bytes size

Returns:

Builder

maxBytes

public ConsumerConfiguration.Builder maxBytes(long maxBytes)

sets the max bytes size for the server to allow on pull requests.

Parameters:

maxBytes - the max bytes size

Returns:

Builder

numReplicas

public ConsumerConfiguration.Builder numReplicas(java.lang.Integer numReplicas)

set the number of replicas for the consumer. When set do not inherit the replica count from the stream but specifically set it to this amount.

Parameters:

numReplicas - number of replicas for the consumer

Returns:

Builder

pauseUntil

public ConsumerConfiguration.Builder pauseUntil(java.time.ZonedDateTime pauseUntil)

Sets the time to pause the consumer until.

Parameters:

pauseUntil - the time to pause

Returns:

Builder

headersOnly

public ConsumerConfiguration.Builder headersOnly(java.lang.Boolean headersOnly)

set the headers only flag saying to deliver only the headers of messages in the stream and not the bodies

Parameters:

headersOnly - the flag

Returns:

Builder

memStorage

public ConsumerConfiguration.Builder memStorage(java.lang.Boolean memStorage)

set the mem storage flag to force the consumer state to be kept in memory rather than inherit the setting from the stream

Parameters:

memStorage - the flag

Returns:

Builder

backoff

public ConsumerConfiguration.Builder backoff(java.time.Duration... backoffs)

Set the list of backoff. Will override ackwait setting.

Parameters:

backoffs - zero or more backoff durations or an array of backoffs

Returns:

Builder

See Also:

Delivery Reliability

backoff

public ConsumerConfiguration.Builder backoff(long... backoffsMillis)

Set the list of backoff. Will override ackwait setting.

Parameters:

backoffsMillis - zero or more backoff in millis or an array of backoffsMillis

Returns:

Builder

See Also:

Delivery Reliability

metadata

public ConsumerConfiguration.Builder metadata(java.util.Map<java.lang.String,java.lang.String> metadata)

Sets the metadata for the configuration

Parameters:

metadata - the metadata map

Returns:

Builder

build

public ConsumerConfiguration build()

Builds the ConsumerConfiguration

Returns:

The consumer configuration.

buildPushSubscribeOptions

public PushSubscribeOptions buildPushSubscribeOptions()

Builds the PushSubscribeOptions with this configuration

Returns:

The PushSubscribeOptions.

buildPushSubscribeOptions

public PushSubscribeOptions buildPushSubscribeOptions(java.lang.String stream)

Builds the PushSubscribeOptions with this configuration. Providing the stream is a hint for the subscription process that saves a call to the server. Assumes the stream is the correct stream for the subject filter, otherwise the server will return an error which the subscription call will raise to the user.

Parameters:

stream - the stream for this consumer

Returns:

The PushSubscribeOptions.

buildPullSubscribeOptions

public PullSubscribeOptions buildPullSubscribeOptions()

Builds the PullSubscribeOptions with this configuration

Returns:

The PullSubscribeOptions.

buildPullSubscribeOptions

public PullSubscribeOptions buildPullSubscribeOptions(java.lang.String stream)

Builds the PullSubscribeOptions with this configuration Providing the stream is a hint for the subscription process that saves a call to the server. Assumes the stream is the correct stream for the subject filter, otherwise the server will return an error which the subscription call will raise to the user.

Parameters:

stream - the stream for this consumer

Returns:

The PullSubscribeOptions.