io.nats.client.api

Class MessageBatchGetRequest.Builder

java.lang.Object

io.nats.client.api.MessageBatchGetRequest.Builder

Enclosing class:

MessageBatchGetRequest

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

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

MessageBatchGetRequest.builder().build() will create a default MessageBatchGetRequest.

Constructor Summary

Constructors

Constructor and Description
Builder() Construct the builder
Builder(MessageBatchGetRequest req) Construct the builder and initialize values with the existing MessageBatchGetRequest

Method Summary

Modifier and Type	Method and Description
MessageBatchGetRequest.Builder	batch(int batch) Set the maximum amount of messages to be returned for this request.
MessageBatchGetRequest	build() Build the MessageBatchGetRequest.
MessageBatchGetRequest.Builder	maxBytes(int maxBytes) Maximum amount of returned bytes for this request.
MessageBatchGetRequest.Builder	multiLastForSubjects(java.util.Collection<java.lang.String> subjects) Subjects filter used, these can include wildcards.
MessageBatchGetRequest.Builder	multiLastForSubjects(java.lang.String... subjects) Subjects filter used, these can include wildcards.
MessageBatchGetRequest.Builder	sequence(long sequence) Minimum sequence for returned messages.
MessageBatchGetRequest.Builder	startTime(java.time.ZonedDateTime startTime) Minimum start time for returned messages.
MessageBatchGetRequest.Builder	subject(java.lang.String subject) Subject used to filter messages that should be returned.
MessageBatchGetRequest.Builder	upToSequence(long upToSequence) Only return messages up to this sequence.
MessageBatchGetRequest.Builder	upToTime(java.time.ZonedDateTime upToTime) Only return messages up to this time.

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(MessageBatchGetRequest req)

Construct the builder and initialize values with the existing MessageBatchGetRequest

Parameters:

req - the MessageBatchGetRequest to clone

Method Detail

batch

public MessageBatchGetRequest.Builder batch(int batch)

Set the maximum amount of messages to be returned for this request.

Parameters:

batch - the batch size

Returns:

Builder

maxBytes

public MessageBatchGetRequest.Builder maxBytes(int maxBytes)

Maximum amount of returned bytes for this request. Limits the amount of returned messages to not exceed this.

Parameters:

maxBytes - the maximum bytes

Returns:

Builder

sequence

public MessageBatchGetRequest.Builder sequence(long sequence)

Minimum sequence for returned messages. All returned messages will have a sequence equal to or higher than this.

Parameters:

sequence - the minimum message sequence

Returns:

Builder

startTime

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

Minimum start time for returned messages. All returned messages will have a start time equal to or higher than this.

Parameters:

startTime - the minimum message start time

Returns:

Builder

subject

public MessageBatchGetRequest.Builder subject(java.lang.String subject)

Subject used to filter messages that should be returned.

Parameters:

subject - the subject to filter

Returns:

Builder

multiLastForSubjects

public MessageBatchGetRequest.Builder multiLastForSubjects(java.lang.String... subjects)

Subjects filter used, these can include wildcards. Will get the last messages matching the subjects.

Parameters:

subjects - the subjects to get the last messages for

Returns:

Builder

multiLastForSubjects

public MessageBatchGetRequest.Builder multiLastForSubjects(java.util.Collection<java.lang.String> subjects)

Subjects filter used, these can include wildcards. Will get the last messages matching the subjects.

Parameters:

subjects - the subjects to get the last messages for

Returns:

Builder

upToSequence

public MessageBatchGetRequest.Builder upToSequence(long upToSequence)

Only return messages up to this sequence. If not set, will be last sequence for the stream.

Parameters:

upToSequence - the maximum message sequence to return results for

Returns:

Builder

upToTime

public MessageBatchGetRequest.Builder upToTime(java.time.ZonedDateTime upToTime)

Only return messages up to this time.

Parameters:

upToTime - the maximum message time to return results for

Returns:

Builder

build

public MessageBatchGetRequest build()

Build the MessageBatchGetRequest.

Returns:

MessageBatchGetRequest