io.axoniq.axonserver.grpc.event

Class QueryEventsRequest

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

io.axoniq.axonserver.grpc.event.QueryEventsRequest

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, QueryEventsRequestOrBuilder, Serializable

public final class QueryEventsRequest
extends com.google.protobuf.GeneratedMessageV3
implements QueryEventsRequestOrBuilder

 Message providing the parameters for executing a Query against AxonServer. 
 

Protobuf type io.axoniq.axonserver.grpc.event.QueryEventsRequest

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	QueryEventsRequest.Builder Message providing the parameters for executing a Query against AxonServer.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	FORCE_READ_FROM_LEADER_FIELD_NUMBER
static int	LIVE_EVENTS_FIELD_NUMBER
static int	NUMBER_OF_PERMITS_FIELD_NUMBER
static int	QUERY_FIELD_NUMBER
static int	QUERY_SNAPSHOTS_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
static QueryEventsRequest	getDefaultInstance()
QueryEventsRequest	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
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
com.google.protobuf.Parser<QueryEventsRequest>	getParserForType()
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
int	getSerializedSize()
com.google.protobuf.UnknownFieldSet	getUnknownFields()
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static QueryEventsRequest.Builder	newBuilder()
static QueryEventsRequest.Builder	newBuilder(QueryEventsRequest prototype)
QueryEventsRequest.Builder	newBuilderForType()
protected QueryEventsRequest.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
static QueryEventsRequest	parseDelimitedFrom(InputStream input)
static QueryEventsRequest	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static QueryEventsRequest	parseFrom(byte[] data)
static QueryEventsRequest	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static QueryEventsRequest	parseFrom(ByteBuffer data)
static QueryEventsRequest	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static QueryEventsRequest	parseFrom(com.google.protobuf.ByteString data)
static QueryEventsRequest	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static QueryEventsRequest	parseFrom(com.google.protobuf.CodedInputStream input)
static QueryEventsRequest	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static QueryEventsRequest	parseFrom(InputStream input)
static QueryEventsRequest	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<QueryEventsRequest>	parser()
QueryEventsRequest.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newInstance, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

QUERY_FIELD_NUMBER

public static final int QUERY_FIELD_NUMBER

See Also:

Constant Field Values

NUMBER_OF_PERMITS_FIELD_NUMBER

public static final int NUMBER_OF_PERMITS_FIELD_NUMBER

See Also:

Constant Field Values

LIVE_EVENTS_FIELD_NUMBER

public static final int LIVE_EVENTS_FIELD_NUMBER

See Also:

Constant Field Values

FORCE_READ_FROM_LEADER_FIELD_NUMBER

public static final int FORCE_READ_FROM_LEADER_FIELD_NUMBER

See Also:

Constant Field Values

QUERY_SNAPSHOTS_FIELD_NUMBER

public static final int QUERY_SNAPSHOTS_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getQuery

public String getQuery()

 The query to execute against the Event Stream 
 

string query = 1;

Specified by:

getQuery in interface QueryEventsRequestOrBuilder

getQueryBytes

public com.google.protobuf.ByteString getQueryBytes()

 The query to execute against the Event Stream 
 

string query = 1;

Specified by:

getQueryBytes in interface QueryEventsRequestOrBuilder

getNumberOfPermits

public long getNumberOfPermits()

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

int64 number_of_permits = 2;

Specified by:

getNumberOfPermits in interface QueryEventsRequestOrBuilder

getLiveEvents

public boolean getLiveEvents()

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

bool live_events = 3;

Specified by:

getLiveEvents in interface QueryEventsRequestOrBuilder

getForceReadFromLeader

public 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;

Specified by:

getForceReadFromLeader in interface QueryEventsRequestOrBuilder

getQuerySnapshots

public boolean getQuerySnapshots()

 If true, snapshots will be queried instead of events 
 

bool query_snapshots = 5;

Specified by:

getQuerySnapshots in interface QueryEventsRequestOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static QueryEventsRequest parseFrom(ByteBuffer data)
                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static QueryEventsRequest parseFrom(ByteBuffer data,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static QueryEventsRequest parseFrom(com.google.protobuf.ByteString data)
                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static QueryEventsRequest parseFrom(com.google.protobuf.ByteString data,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static QueryEventsRequest parseFrom(byte[] data)
                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static QueryEventsRequest parseFrom(byte[] data,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static QueryEventsRequest parseFrom(InputStream input)
                                    throws IOException

Throws:

IOException

parseFrom

public static QueryEventsRequest parseFrom(InputStream input,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws IOException

Throws:

IOException

parseDelimitedFrom

public static QueryEventsRequest parseDelimitedFrom(InputStream input)
                                             throws IOException

Throws:

IOException

parseDelimitedFrom

public static QueryEventsRequest parseDelimitedFrom(InputStream input,
                                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                             throws IOException

Throws:

IOException

parseFrom

public static QueryEventsRequest parseFrom(com.google.protobuf.CodedInputStream input)
                                    throws IOException

Throws:

IOException

parseFrom

public static QueryEventsRequest parseFrom(com.google.protobuf.CodedInputStream input,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws IOException

Throws:

IOException

newBuilderForType

public QueryEventsRequest.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static QueryEventsRequest.Builder newBuilder()

newBuilder

public static QueryEventsRequest.Builder newBuilder(QueryEventsRequest prototype)

toBuilder

public QueryEventsRequest.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected QueryEventsRequest.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static QueryEventsRequest getDefaultInstance()

parser

public static com.google.protobuf.Parser<QueryEventsRequest> parser()

getParserForType

public com.google.protobuf.Parser<QueryEventsRequest> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public QueryEventsRequest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder