Record Class SubscribeRequest

java.lang.Object

java.lang.Record

io.umadb.client.SubscribeRequest

Record Components:

query - optional filter selecting which events to listen to; may be null to receive all events

after - optional position to resume from; only events strictly after this position are delivered. May be null to start from the beginning of the stream

batchSize - optional hint for how many events to deliver per stream push; must be > 0 if provided

public record SubscribeRequest(Query query, Long after, Integer batchSize)
extends Record

Represents a request to open a real-time, continuous stream of events.

A subscription first replays already-recorded events matching the query and then continues to deliver new events as they are appended. Unlike a ReadRequest, the stream does not terminate at the current head.

Constructor Summary

Constructors

Constructor	Description
SubscribeRequest(Query query, Long after, Integer batchSize)	Creates a new SubscribeRequest.

Method Summary

Modifier and Type	Method	Description
Long	after()	Returns the value of the after record component.
SubscribeRequest	after(long after)	Returns a copy of this request resuming strictly after the given position.
static SubscribeRequest	all()	Creates a subscription to all events, starting from the beginning of the stream.
Integer	batchSize()	Returns the value of the batchSize record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
static SubscribeRequest	of(Query query)	Creates a subscription filtered by the given query.
Query	query()	Returns the value of the query record component.
final String	toString()	Returns a string representation of this record class.
SubscribeRequest	withBatchSize(int batchSize)	Returns a copy of this request with the given batch size hint.

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

SubscribeRequest

public SubscribeRequest(Query query,
 Long after,
 Integer batchSize)

Creates a new SubscribeRequest.

Throws:

IllegalArgumentException - if validation constraints are violated

Method Details

all

public static SubscribeRequest all()

Creates a subscription to all events, starting from the beginning of the stream.

Returns:

a SubscribeRequest with default parameters

of

public static SubscribeRequest of(Query query)

Creates a subscription filtered by the given query.

Parameters:

query - the query to filter events; may be null to receive all events

Returns:

a SubscribeRequest for the given query

after

public SubscribeRequest after(long after)

Returns a copy of this request resuming strictly after the given position.

Parameters:

after - the position to resume from

Returns:

a new SubscribeRequest with the specified resume point

withBatchSize

public SubscribeRequest withBatchSize(int batchSize)

Returns a copy of this request with the given batch size hint.

Parameters:

batchSize - the maximum number of events per stream push

Returns:

a new SubscribeRequest with the specified batch size

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

query

public Query query()

Returns the value of the query record component.

Returns:

the value of the query record component

after

public Long after()

Returns the value of the after record component.

Returns:

the value of the after record component

batchSize

public Integer batchSize()

Returns the value of the batchSize record component.

Returns:

the value of the batchSize record component