io.nats.client.api

Class MessageBatchGetRequest

java.lang.Object

io.nats.client.api.MessageBatchGetRequest

All Implemented Interfaces:

JsonSerializable

public class MessageBatchGetRequest
extends java.lang.Object
implements JsonSerializable

Object used to make a request for message batch get requests.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MessageBatchGetRequest.Builder MessageBatchGetRequest is created using a Builder.

Method Summary

Modifier and Type	Method and Description
static MessageBatchGetRequest.Builder	builder() Creates a builder for the request.
static MessageBatchGetRequest.Builder	builder(MessageBatchGetRequest req) Creates a builder for the request.
int	getBatch() Maximum amount of messages to be returned for this request.
int	getMaxBytes() Maximum amount of returned bytes for this request.
java.util.List<java.lang.String>	getMultiLastForSubjects() Subjects filter used, these can include wildcards.
long	getSequence() Minimum sequence for returned messages.
java.time.ZonedDateTime	getStartTime() Minimum start time for returned messages.
java.lang.String	getSubject() Subject used to filter messages that should be returned.
long	getUpToSequence() Only return messages up to this sequence.
java.time.ZonedDateTime	getUpToTime() Only return messages up to this time.
java.lang.String	toJson()

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.nats.client.support.JsonSerializable

serialize, toJsonValue

Method Detail

getBatch

public int getBatch()

Maximum amount of messages to be returned for this request.

Returns:

batch size

getMaxBytes

public int getMaxBytes()

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

Returns:

maximum bytes

getSequence

public long getSequence()

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

Returns:

minimum message sequence

getStartTime

public java.time.ZonedDateTime getStartTime()

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

Returns:

minimum message start time

getSubject

public java.lang.String getSubject()

Subject used to filter messages that should be returned.

Returns:

the subject to filter

getMultiLastForSubjects

public java.util.List<java.lang.String> getMultiLastForSubjects()

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

Returns:

the subjects to get the last messages for

getUpToSequence

public long getUpToSequence()

Only return messages up to this sequence.

Returns:

the maximum message sequence to return results for

getUpToTime

public java.time.ZonedDateTime getUpToTime()

Only return messages up to this time.

Returns:

the maximum message time to return results for

toJson

public java.lang.String toJson()

Specified by:

toJson in interface JsonSerializable

builder

public static MessageBatchGetRequest.Builder builder()

Creates a builder for the request.

Returns:

Builder

builder

public static MessageBatchGetRequest.Builder builder(MessageBatchGetRequest req)

Creates a builder for the request.

Parameters:

req - the MessageBatchGetRequest

Returns:

Builder