io.nats.client

Class PushSubscribeOptions.Builder

java.lang.Object

io.nats.client.PushSubscribeOptions.Builder

Enclosing class:

PushSubscribeOptions

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

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

Constructor Summary

Constructors

Constructor and Description
Builder() Construct an instance of the builder

Method Summary

Modifier and Type	Method and Description
PushSubscribeOptions	build() Builds the push subscribe options.
PushSubscribeOptions.Builder	deliverGroup(java.lang.String deliverGroup) Setting this specifies deliver group.
PushSubscribeOptions.Builder	deliverSubject(java.lang.String deliverSubject) Setting this specifies the push model to a delivery subject.
PushSubscribeOptions.Builder	ordered(boolean ordered) Set the ordered consumer flag
PushSubscribeOptions.Builder	pendingByteLimit(long pendingByteLimit) Set the maximum number of bytes that non-dispatched push subscriptions can hold in the internal (pending) message queue.
PushSubscribeOptions.Builder	pendingMessageLimit(long pendingMessageLimit) Set the maximum number of messages that non-dispatched push subscriptions can hold in the internal (pending) message queue.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Construct an instance of the builder

Method Detail

ordered

public PushSubscribeOptions.Builder ordered(boolean ordered)

Set the ordered consumer flag

Parameters:

ordered - flag indicating whether this subscription should be ordered

Returns:

the builder.

deliverSubject

public PushSubscribeOptions.Builder deliverSubject(java.lang.String deliverSubject)

Setting this specifies the push model to a delivery subject. Null or empty clears the field.

Parameters:

deliverSubject - the subject to deliver on.

Returns:

the builder.

deliverGroup

public PushSubscribeOptions.Builder deliverGroup(java.lang.String deliverGroup)

Setting this specifies deliver group. Must match queue is both are supplied. Null or empty clears the field.

Parameters:

deliverGroup - the group to queue on

Returns:

the builder.

pendingMessageLimit

public PushSubscribeOptions.Builder pendingMessageLimit(long pendingMessageLimit)

Set the maximum number of messages that non-dispatched push subscriptions can hold in the internal (pending) message queue. Defaults to 512 * 1024 (Consumer.DEFAULT_MAX_MESSAGES)

Parameters:

pendingMessageLimit - the number of messages.

Returns:

the builder

pendingByteLimit

public PushSubscribeOptions.Builder pendingByteLimit(long pendingByteLimit)

Set the maximum number of bytes that non-dispatched push subscriptions can hold in the internal (pending) message queue. Defaults to 64 * 1024 * 1024 (Consumer.DEFAULT_MAX_BYTES)

Parameters:

pendingByteLimit - the number of bytes.

Returns:

the builder

build

public PushSubscribeOptions build()

Builds the push subscribe options.

Returns:

push subscribe options