Class QueryEventsRequest.Builder

  • All Implemented Interfaces:
    com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, QueryEventsRequestOrBuilder, Cloneable
    Enclosing class:
    QueryEventsRequest

    public static final class QueryEventsRequest.Builder
    extends com.google.protobuf.GeneratedMessage.Builder<QueryEventsRequest.Builder>
    implements QueryEventsRequestOrBuilder
     Message providing the parameters for executing a Query against AxonServer. 
     
    Protobuf type io.axoniq.axonserver.grpc.event.QueryEventsRequest
    • Method Detail

      • getDescriptor

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

        protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<QueryEventsRequest.Builder>
      • clear

        public QueryEventsRequest.Builder clear()
        Specified by:
        clear in interface com.google.protobuf.Message.Builder
        Specified by:
        clear in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clear in class com.google.protobuf.GeneratedMessage.Builder<QueryEventsRequest.Builder>
      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<QueryEventsRequest.Builder>
      • getDefaultInstanceForType

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

        public QueryEventsRequest build()
        Specified by:
        build in interface com.google.protobuf.Message.Builder
        Specified by:
        build in interface com.google.protobuf.MessageLite.Builder
      • buildPartial

        public QueryEventsRequest buildPartial()
        Specified by:
        buildPartial in interface com.google.protobuf.Message.Builder
        Specified by:
        buildPartial in interface com.google.protobuf.MessageLite.Builder
      • mergeFrom

        public QueryEventsRequest.Builder mergeFrom​(com.google.protobuf.Message other)
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<QueryEventsRequest.Builder>
      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessage.Builder<QueryEventsRequest.Builder>
      • mergeFrom

        public QueryEventsRequest.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                             throws IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<QueryEventsRequest.Builder>
        Throws:
        IOException
      • 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.
      • setQuery

        public QueryEventsRequest.Builder setQuery​(String value)
         The query to execute against the Event Stream 
         
        string query = 1;
        Parameters:
        value - The query to set.
        Returns:
        This builder for chaining.
      • clearQuery

        public QueryEventsRequest.Builder clearQuery()
         The query to execute against the Event Stream 
         
        string query = 1;
        Returns:
        This builder for chaining.
      • setQueryBytes

        public QueryEventsRequest.Builder setQueryBytes​(com.google.protobuf.ByteString value)
         The query to execute against the Event Stream 
         
        string query = 1;
        Parameters:
        value - The bytes for query to set.
        Returns:
        This builder for chaining.
      • 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.
      • setNumberOfPermits

        public QueryEventsRequest.Builder setNumberOfPermits​(long value)
         The number of results AxonServer may send before new permits need to be provided 
         
        int64 number_of_permits = 2;
        Parameters:
        value - The numberOfPermits to set.
        Returns:
        This builder for chaining.
      • clearNumberOfPermits

        public QueryEventsRequest.Builder clearNumberOfPermits()
         The number of results AxonServer may send before new permits need to be provided 
         
        int64 number_of_permits = 2;
        Returns:
        This builder for chaining.
      • 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.
      • setLiveEvents

        public QueryEventsRequest.Builder setLiveEvents​(boolean value)
         Whether to keep the query running against incoming events once the Head of the Stream is reached 
         
        bool live_events = 3;
        Parameters:
        value - The liveEvents to set.
        Returns:
        This builder for chaining.
      • clearLiveEvents

        public QueryEventsRequest.Builder clearLiveEvents()
         Whether to keep the query running against incoming events once the Head of the Stream is reached 
         
        bool live_events = 3;
        Returns:
        This builder for chaining.
      • 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.
      • setForceReadFromLeader

        public QueryEventsRequest.Builder setForceReadFromLeader​(boolean value)
         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;
        Parameters:
        value - The forceReadFromLeader to set.
        Returns:
        This builder for chaining.
      • clearForceReadFromLeader

        public QueryEventsRequest.Builder clearForceReadFromLeader()
         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;
        Returns:
        This builder for chaining.
      • 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.
      • setQuerySnapshots

        public QueryEventsRequest.Builder setQuerySnapshots​(boolean value)
         If true, snapshots will be queried instead of events 
         
        bool query_snapshots = 5;
        Parameters:
        value - The querySnapshots to set.
        Returns:
        This builder for chaining.
      • clearQuerySnapshots

        public QueryEventsRequest.Builder clearQuerySnapshots()
         If true, snapshots will be queried instead of events 
         
        bool query_snapshots = 5;
        Returns:
        This builder for chaining.
      • 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.
      • setContextName

        public QueryEventsRequest.Builder setContextName​(String value)
         Query from this context, not from the default context of the connection 
         
        string context_name = 6;
        Parameters:
        value - The contextName to set.
        Returns:
        This builder for chaining.
      • clearContextName

        public QueryEventsRequest.Builder clearContextName()
         Query from this context, not from the default context of the connection 
         
        string context_name = 6;
        Returns:
        This builder for chaining.
      • setContextNameBytes

        public QueryEventsRequest.Builder setContextNameBytes​(com.google.protobuf.ByteString value)
         Query from this context, not from the default context of the connection 
         
        string context_name = 6;
        Parameters:
        value - The bytes for contextName to set.
        Returns:
        This builder for chaining.