io.nats.client.api

Class OrderedConsumerConfiguration

java.lang.Object

io.nats.client.api.OrderedConsumerConfiguration

All Implemented Interfaces:

io.nats.client.support.JsonSerializable

public class OrderedConsumerConfiguration
extends java.lang.Object
implements io.nats.client.support.JsonSerializable

The ConsumerConfiguration class specifies the configuration for creating an ordered JetStream consumer

Constructor Summary

Constructors

Constructor and Description
OrderedConsumerConfiguration() OrderedConsumerConfiguration creation works like a builder.
OrderedConsumerConfiguration(@NonNull io.nats.client.support.JsonValue jv) OrderedConsumerConfiguration creation works like a builder.
OrderedConsumerConfiguration(@NonNull java.lang.String json) OrderedConsumerConfiguration creation works like a builder.

Method Summary

Modifier and Type	Method and Description
OrderedConsumerConfiguration	consumerNamePrefix(java.lang.String consumerNamePrefix) Sets the consumer name prefix for consumers created by this configuration.
OrderedConsumerConfiguration	deliverPolicy(DeliverPolicy deliverPolicy) Sets the delivery policy of the OrderedConsumerConfiguration.
OrderedConsumerConfiguration	filterSubject(java.lang.String filterSubject) Sets the filter subject of the OrderedConsumerConfiguration.
OrderedConsumerConfiguration	filterSubjects(java.util.List<java.lang.String> filterSubjects) Sets the filter subject of the OrderedConsumerConfiguration.
OrderedConsumerConfiguration	filterSubjects(java.lang.String... filterSubjects) Sets the filter subjects of the OrderedConsumerConfiguration.
java.lang.String	getConsumerNamePrefix() Gets the prefix that will be used for names of underlying consumers
@Nullable DeliverPolicy	getDeliverPolicy() Gets the deliver policy of this consumer configuration.
@Nullable java.lang.String	getFilterSubject() Gets the filter subject of this consumer configuration.
@NonNull java.util.List<java.lang.String>	getFilterSubjects() Gets the filter subjects as a list.
@Nullable java.lang.Boolean	getHeadersOnly() Get the header only flag indicating whether it's on or off.
@Nullable ReplayPolicy	getReplayPolicy() Gets the replay policy of this consumer configuration.
@Nullable java.lang.Long	getStartSequence() Gets the start sequence of this consumer configuration.
@Nullable java.time.ZonedDateTime	getStartTime() Gets the start time of this consumer configuration.
boolean	hasMultipleFilterSubjects() Whether there are multiple filter subjects for this consumer configuration.
OrderedConsumerConfiguration	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
boolean	isHeadersOnly() Get the header only flag indicating whether it's on or off.
OrderedConsumerConfiguration	replayPolicy(ReplayPolicy replayPolicy) Sets the replay policy of the OrderedConsumerConfiguration.
OrderedConsumerConfiguration	startSequence(long startSequence) Sets the start sequence of the OrderedConsumerConfiguration.
OrderedConsumerConfiguration	startTime(java.time.ZonedDateTime startTime) Sets the start time of the OrderedConsumerConfiguration.
@NonNull java.lang.String	toJson() Returns a JSON representation of this ordered consumer configuration.

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

Constructor Detail

OrderedConsumerConfiguration

public OrderedConsumerConfiguration()

OrderedConsumerConfiguration creation works like a builder. The builder supports chaining and will create a default set of options if no methods are calls, including setting the filter subject to >

OrderedConsumerConfiguration

public OrderedConsumerConfiguration(@NonNull java.lang.String json)
                             throws io.nats.client.support.JsonParseException

OrderedConsumerConfiguration creation works like a builder. The builder supports chaining and will create a default set of options if no methods are calls, including setting the filter subject to >

Parameters:

json - the JSON used to seed the builder

Throws:

io.nats.client.support.JsonParseException - if there is a problem parsing the json

OrderedConsumerConfiguration

public OrderedConsumerConfiguration(@NonNull io.nats.client.support.JsonValue jv)
                             throws io.nats.client.support.JsonParseException

OrderedConsumerConfiguration creation works like a builder. The builder supports chaining and will create a default set of options if no methods are calls, including setting the filter subject to >

Parameters:

jv - the JsonValue used to seed the builder

Throws:

io.nats.client.support.JsonParseException - if there is a problem parsing the json

Method Detail

toJson

public @NonNull java.lang.String toJson()

Returns a JSON representation of this ordered consumer configuration.

Specified by:

toJson in interface io.nats.client.support.JsonSerializable

Returns:

JSON ordered consumer configuration JSON string

filterSubject

public OrderedConsumerConfiguration filterSubject(java.lang.String filterSubject)

Sets the filter subject of the OrderedConsumerConfiguration. null or empty string means no filter.

Parameters:

filterSubject - the filter subject

Returns:

The Builder

filterSubjects

public OrderedConsumerConfiguration filterSubjects(java.lang.String... filterSubjects)

Sets the filter subjects of the OrderedConsumerConfiguration. A null or empty array or no items that are not null or empty means no filter

Parameters:

filterSubjects - the filter subject

Returns:

The Builder

filterSubjects

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

Sets the filter subject of the OrderedConsumerConfiguration. A null or empty list or no items that are not null or empty means no filter

Parameters:

filterSubjects - one or more filter subjects

Returns:

The Builder

deliverPolicy

public OrderedConsumerConfiguration deliverPolicy(DeliverPolicy deliverPolicy)

Sets the delivery policy of the OrderedConsumerConfiguration.

Parameters:

deliverPolicy - the delivery policy.

Returns:

The Builder

startSequence

public OrderedConsumerConfiguration startSequence(long startSequence)

Sets the start sequence of the OrderedConsumerConfiguration.

Parameters:

startSequence - the start sequence

Returns:

The Builder

startTime

public OrderedConsumerConfiguration startTime(java.time.ZonedDateTime startTime)

Sets the start time of the OrderedConsumerConfiguration.

Parameters:

startTime - the start time

Returns:

The Builder

replayPolicy

public OrderedConsumerConfiguration replayPolicy(ReplayPolicy replayPolicy)

Sets the replay policy of the OrderedConsumerConfiguration.

Parameters:

replayPolicy - the replay policy.

Returns:

The Builder

headersOnly

public OrderedConsumerConfiguration 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:

The Builder

consumerNamePrefix

public OrderedConsumerConfiguration consumerNamePrefix(java.lang.String consumerNamePrefix)

Sets the consumer name prefix for consumers created by this configuration.

Parameters:

consumerNamePrefix - the prefix or null to clear.

Returns:

The Builder

getFilterSubject

public @Nullable java.lang.String getFilterSubject()

Gets the filter subject of this consumer configuration. With the introduction of multiple filter subjects, this method will return null if there are not exactly one filter subjects

Returns:

the first filter subject.

getFilterSubjects

public @NonNull java.util.List<java.lang.String> getFilterSubjects()

Gets the filter subjects as a list. May be null, otherwise won't be empty

Returns:

the list

hasMultipleFilterSubjects

public boolean hasMultipleFilterSubjects()

Whether there are multiple filter subjects for this consumer configuration.

Returns:

true if there are multiple filter subjects

getDeliverPolicy

public @Nullable DeliverPolicy getDeliverPolicy()

Gets the deliver policy of this consumer configuration.

Returns:

the deliver policy.

getStartSequence

public @Nullable java.lang.Long getStartSequence()

Gets the start sequence of this consumer configuration.

Returns:

the start sequence.

getStartTime

public @Nullable java.time.ZonedDateTime getStartTime()

Gets the start time of this consumer configuration.

Returns:

the start time.

getReplayPolicy

public @Nullable ReplayPolicy getReplayPolicy()

Gets the replay policy of this consumer configuration.

Returns:

the replay policy.

getHeadersOnly

public @Nullable java.lang.Boolean getHeadersOnly()

Get the header only flag indicating whether it's on or off. Same as isHeadersOnly

Returns:

the flow control mode

isHeadersOnly

public boolean isHeadersOnly()

Get the header only flag indicating whether it's on or off. Same as getHeadersOnly

Returns:

the flow control mode

getConsumerNamePrefix

public java.lang.String getConsumerNamePrefix()

Gets the prefix that will be used for names of underlying consumers

Returns:

the prefix