io.axoniq.axonserver.grpc.event

Interface QueryEventsRequestOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

QueryEventsRequest, QueryEventsRequest.Builder

public interface QueryEventsRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
String	getContextName() Query from this context, not from the default context of the connection
com.google.protobuf.ByteString	getContextNameBytes() Query from this context, not from the default context of the connection
boolean	getForceReadFromLeader() Indicates whether to force querying events from the leader node of an Axon Server.
boolean	getLiveEvents() Whether to keep the query running against incoming events once the Head of the Stream is reached
long	getNumberOfPermits() The number of results AxonServer may send before new permits need to be provided
String	getQuery() The query to execute against the Event Stream
com.google.protobuf.ByteString	getQueryBytes() The query to execute against the Event Stream
boolean	getQuerySnapshots() If true, snapshots will be queried instead of events

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getQuery

String getQuery()

 The query to execute against the Event Stream 
 

string query = 1;

getQueryBytes

com.google.protobuf.ByteString getQueryBytes()

 The query to execute against the Event Stream 
 

string query = 1;

getNumberOfPermits

long getNumberOfPermits()

 The number of results AxonServer may send before new permits need to be provided 
 

int64 number_of_permits = 2;

getLiveEvents

boolean getLiveEvents()

 Whether to keep the query running against incoming events once the Head of the Stream is reached 
 

bool live_events = 3;

getForceReadFromLeader

boolean getForceReadFromLeader()

 Indicates whether to force querying events from the leader node of an Axon Server. Forcing reads from leader
 reduces the staleness of the data read, but also puts extra burden on the leader, reducing overall scalability.
 <p>
 This property has no effect on connections to AxonServer SE.
 </p>
 

bool force_read_from_leader = 4;

getQuerySnapshots

boolean getQuerySnapshots()

 If true, snapshots will be queried instead of events 
 

bool query_snapshots = 5;

getContextName

String getContextName()

 Query from this context, not from the default context of the connection 
 

string context_name = 6;

getContextNameBytes

com.google.protobuf.ByteString getContextNameBytes()

 Query from this context, not from the default context of the connection 
 

string context_name = 6;