Module io.axoniq.connector.axonserver
Package io.axoniq.axonserver.grpc.event

Class QueryEventsRequest

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, QueryEventsRequestOrBuilder, Serializable
    @Generated
public final class QueryEventsRequest
extends com.google.protobuf.GeneratedMessage
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 Description
      static class  QueryEventsRequest.Builder
      Message providing the parameters for executing a Query against AxonServer.

      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

        com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,​BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,​BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,​T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

        com.google.protobuf.AbstractMessage.BuilderParent

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

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • Field Detail

      • 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

      • CONTEXT_NAME_FIELD_NUMBER

        public static final int CONTEXT_NAME_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • getDescriptor

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

      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessage

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

      • getQueryBytes

        public com.google.protobuf.ByteString getQueryBytes()
         The query to execute against the Event Stream
        string query = 1;
        Specified by:
        getQueryBytes in interface QueryEventsRequestOrBuilder
        Returns:
        The bytes for query.

      • 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
        Returns:
        The numberOfPermits.

      • 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
        Returns:
        The liveEvents.

      • 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
        Returns:
        The forceReadFromLeader.

      • getQuerySnapshots

        public boolean getQuerySnapshots()
         If true, snapshots will be queried instead of events
        bool query_snapshots = 5;
        Specified by:
        getQuerySnapshots in interface QueryEventsRequestOrBuilder
        Returns:
        The querySnapshots.

      • getContextName

        public String getContextName()
         Query from this context, not from the default context of the connection
        string context_name = 6;
        Specified by:
        getContextName in interface QueryEventsRequestOrBuilder
        Returns:
        The contextName.

      • getContextNameBytes

        public com.google.protobuf.ByteString getContextNameBytes()
         Query from this context, not from the default context of the connection
        string context_name = 6;
        Specified by:
        getContextNameBytes in interface QueryEventsRequestOrBuilder
        Returns:
        The bytes for contextName.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessage

      • 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.GeneratedMessage
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessage

      • 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​(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

      • 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.AbstractMessage.BuilderParent parent)
        Overrides:
        newBuilderForType in class com.google.protobuf.AbstractMessage

      • 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.GeneratedMessage

      • getDefaultInstanceForType

        public QueryEventsRequest getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder