Class GetEventsRequest.Builder

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

    public static final class GetEventsRequest.Builder
    extends com.google.protobuf.GeneratedMessage.Builder<GetEventsRequest.Builder>
    implements GetEventsRequestOrBuilder
     Request message to open an Event Stream from the Event Store. 
     
    Protobuf type io.axoniq.axonserver.grpc.event.GetEventsRequest
    • 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<GetEventsRequest.Builder>
      • clear

        public GetEventsRequest.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<GetEventsRequest.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<GetEventsRequest.Builder>
      • getDefaultInstanceForType

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

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

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

        public GetEventsRequest.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<GetEventsRequest.Builder>
      • isInitialized

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

        public GetEventsRequest.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<GetEventsRequest.Builder>
        Throws:
        IOException
      • getTrackingToken

        public long getTrackingToken()
         The token to start streaming from 
         
        int64 tracking_token = 1;
        Specified by:
        getTrackingToken in interface GetEventsRequestOrBuilder
        Returns:
        The trackingToken.
      • setTrackingToken

        public GetEventsRequest.Builder setTrackingToken​(long value)
         The token to start streaming from 
         
        int64 tracking_token = 1;
        Parameters:
        value - The trackingToken to set.
        Returns:
        This builder for chaining.
      • clearTrackingToken

        public GetEventsRequest.Builder clearTrackingToken()
         The token to start streaming from 
         
        int64 tracking_token = 1;
        Returns:
        This builder for chaining.
      • getNumberOfPermits

        public long getNumberOfPermits()
         The number of messages the server may send before it needs to wait for more permits 
         
        int64 number_of_permits = 2;
        Specified by:
        getNumberOfPermits in interface GetEventsRequestOrBuilder
        Returns:
        The numberOfPermits.
      • setNumberOfPermits

        public GetEventsRequest.Builder setNumberOfPermits​(long value)
         The number of messages the server may send before it needs to wait for more permits 
         
        int64 number_of_permits = 2;
        Parameters:
        value - The numberOfPermits to set.
        Returns:
        This builder for chaining.
      • clearNumberOfPermits

        public GetEventsRequest.Builder clearNumberOfPermits()
         The number of messages the server may send before it needs to wait for more permits 
         
        int64 number_of_permits = 2;
        Returns:
        This builder for chaining.
      • getClientId

        public String getClientId()
         The unique identifier of this client instance. Used for monitoring. 
         
        string client_id = 3;
        Specified by:
        getClientId in interface GetEventsRequestOrBuilder
        Returns:
        The clientId.
      • getClientIdBytes

        public com.google.protobuf.ByteString getClientIdBytes()
         The unique identifier of this client instance. Used for monitoring. 
         
        string client_id = 3;
        Specified by:
        getClientIdBytes in interface GetEventsRequestOrBuilder
        Returns:
        The bytes for clientId.
      • setClientId

        public GetEventsRequest.Builder setClientId​(String value)
         The unique identifier of this client instance. Used for monitoring. 
         
        string client_id = 3;
        Parameters:
        value - The clientId to set.
        Returns:
        This builder for chaining.
      • clearClientId

        public GetEventsRequest.Builder clearClientId()
         The unique identifier of this client instance. Used for monitoring. 
         
        string client_id = 3;
        Returns:
        This builder for chaining.
      • setClientIdBytes

        public GetEventsRequest.Builder setClientIdBytes​(com.google.protobuf.ByteString value)
         The unique identifier of this client instance. Used for monitoring. 
         
        string client_id = 3;
        Parameters:
        value - The bytes for clientId to set.
        Returns:
        This builder for chaining.
      • getComponentName

        public String getComponentName()
         The component name of this client instance. Used for monitoring. 
         
        string component_name = 4;
        Specified by:
        getComponentName in interface GetEventsRequestOrBuilder
        Returns:
        The componentName.
      • getComponentNameBytes

        public com.google.protobuf.ByteString getComponentNameBytes()
         The component name of this client instance. Used for monitoring. 
         
        string component_name = 4;
        Specified by:
        getComponentNameBytes in interface GetEventsRequestOrBuilder
        Returns:
        The bytes for componentName.
      • setComponentName

        public GetEventsRequest.Builder setComponentName​(String value)
         The component name of this client instance. Used for monitoring. 
         
        string component_name = 4;
        Parameters:
        value - The componentName to set.
        Returns:
        This builder for chaining.
      • clearComponentName

        public GetEventsRequest.Builder clearComponentName()
         The component name of this client instance. Used for monitoring. 
         
        string component_name = 4;
        Returns:
        This builder for chaining.
      • setComponentNameBytes

        public GetEventsRequest.Builder setComponentNameBytes​(com.google.protobuf.ByteString value)
         The component name of this client instance. Used for monitoring. 
         
        string component_name = 4;
        Parameters:
        value - The bytes for componentName to set.
        Returns:
        This builder for chaining.
      • getProcessor

        public String getProcessor()
         The name of the processor requesting this stream. Used for monitoring. 
         
        string processor = 5;
        Specified by:
        getProcessor in interface GetEventsRequestOrBuilder
        Returns:
        The processor.
      • getProcessorBytes

        public com.google.protobuf.ByteString getProcessorBytes()
         The name of the processor requesting this stream. Used for monitoring. 
         
        string processor = 5;
        Specified by:
        getProcessorBytes in interface GetEventsRequestOrBuilder
        Returns:
        The bytes for processor.
      • setProcessor

        public GetEventsRequest.Builder setProcessor​(String value)
         The name of the processor requesting this stream. Used for monitoring. 
         
        string processor = 5;
        Parameters:
        value - The processor to set.
        Returns:
        This builder for chaining.
      • clearProcessor

        public GetEventsRequest.Builder clearProcessor()
         The name of the processor requesting this stream. Used for monitoring. 
         
        string processor = 5;
        Returns:
        This builder for chaining.
      • setProcessorBytes

        public GetEventsRequest.Builder setProcessorBytes​(com.google.protobuf.ByteString value)
         The name of the processor requesting this stream. Used for monitoring. 
         
        string processor = 5;
        Parameters:
        value - The bytes for processor to set.
        Returns:
        This builder for chaining.
      • getBlacklistList

        public List<PayloadDescription> getBlacklistList()
         An enumeration of payload types that need to be blacklisted. The Server will stop sending messages of these
         types in order to reduce I/O. Note that the Server may occasionally send a blacklisted message to prevent
         time-outs and stale tokens on clients.
         
        repeated .io.axoniq.axonserver.grpc.event.PayloadDescription blacklist = 6;
        Specified by:
        getBlacklistList in interface GetEventsRequestOrBuilder
      • getBlacklistCount

        public int getBlacklistCount()
         An enumeration of payload types that need to be blacklisted. The Server will stop sending messages of these
         types in order to reduce I/O. Note that the Server may occasionally send a blacklisted message to prevent
         time-outs and stale tokens on clients.
         
        repeated .io.axoniq.axonserver.grpc.event.PayloadDescription blacklist = 6;
        Specified by:
        getBlacklistCount in interface GetEventsRequestOrBuilder
      • getBlacklist

        public PayloadDescription getBlacklist​(int index)
         An enumeration of payload types that need to be blacklisted. The Server will stop sending messages of these
         types in order to reduce I/O. Note that the Server may occasionally send a blacklisted message to prevent
         time-outs and stale tokens on clients.
         
        repeated .io.axoniq.axonserver.grpc.event.PayloadDescription blacklist = 6;
        Specified by:
        getBlacklist in interface GetEventsRequestOrBuilder
      • setBlacklist

        public GetEventsRequest.Builder setBlacklist​(int index,
                                                     PayloadDescription value)
         An enumeration of payload types that need to be blacklisted. The Server will stop sending messages of these
         types in order to reduce I/O. Note that the Server may occasionally send a blacklisted message to prevent
         time-outs and stale tokens on clients.
         
        repeated .io.axoniq.axonserver.grpc.event.PayloadDescription blacklist = 6;
      • setBlacklist

        public GetEventsRequest.Builder setBlacklist​(int index,
                                                     PayloadDescription.Builder builderForValue)
         An enumeration of payload types that need to be blacklisted. The Server will stop sending messages of these
         types in order to reduce I/O. Note that the Server may occasionally send a blacklisted message to prevent
         time-outs and stale tokens on clients.
         
        repeated .io.axoniq.axonserver.grpc.event.PayloadDescription blacklist = 6;
      • addBlacklist

        public GetEventsRequest.Builder addBlacklist​(PayloadDescription value)
         An enumeration of payload types that need to be blacklisted. The Server will stop sending messages of these
         types in order to reduce I/O. Note that the Server may occasionally send a blacklisted message to prevent
         time-outs and stale tokens on clients.
         
        repeated .io.axoniq.axonserver.grpc.event.PayloadDescription blacklist = 6;
      • addBlacklist

        public GetEventsRequest.Builder addBlacklist​(int index,
                                                     PayloadDescription value)
         An enumeration of payload types that need to be blacklisted. The Server will stop sending messages of these
         types in order to reduce I/O. Note that the Server may occasionally send a blacklisted message to prevent
         time-outs and stale tokens on clients.
         
        repeated .io.axoniq.axonserver.grpc.event.PayloadDescription blacklist = 6;
      • addBlacklist

        public GetEventsRequest.Builder addBlacklist​(PayloadDescription.Builder builderForValue)
         An enumeration of payload types that need to be blacklisted. The Server will stop sending messages of these
         types in order to reduce I/O. Note that the Server may occasionally send a blacklisted message to prevent
         time-outs and stale tokens on clients.
         
        repeated .io.axoniq.axonserver.grpc.event.PayloadDescription blacklist = 6;
      • addBlacklist

        public GetEventsRequest.Builder addBlacklist​(int index,
                                                     PayloadDescription.Builder builderForValue)
         An enumeration of payload types that need to be blacklisted. The Server will stop sending messages of these
         types in order to reduce I/O. Note that the Server may occasionally send a blacklisted message to prevent
         time-outs and stale tokens on clients.
         
        repeated .io.axoniq.axonserver.grpc.event.PayloadDescription blacklist = 6;
      • addAllBlacklist

        public GetEventsRequest.Builder addAllBlacklist​(Iterable<? extends PayloadDescription> values)
         An enumeration of payload types that need to be blacklisted. The Server will stop sending messages of these
         types in order to reduce I/O. Note that the Server may occasionally send a blacklisted message to prevent
         time-outs and stale tokens on clients.
         
        repeated .io.axoniq.axonserver.grpc.event.PayloadDescription blacklist = 6;
      • clearBlacklist

        public GetEventsRequest.Builder clearBlacklist()
         An enumeration of payload types that need to be blacklisted. The Server will stop sending messages of these
         types in order to reduce I/O. Note that the Server may occasionally send a blacklisted message to prevent
         time-outs and stale tokens on clients.
         
        repeated .io.axoniq.axonserver.grpc.event.PayloadDescription blacklist = 6;
      • removeBlacklist

        public GetEventsRequest.Builder removeBlacklist​(int index)
         An enumeration of payload types that need to be blacklisted. The Server will stop sending messages of these
         types in order to reduce I/O. Note that the Server may occasionally send a blacklisted message to prevent
         time-outs and stale tokens on clients.
         
        repeated .io.axoniq.axonserver.grpc.event.PayloadDescription blacklist = 6;
      • getBlacklistBuilder

        public PayloadDescription.Builder getBlacklistBuilder​(int index)
         An enumeration of payload types that need to be blacklisted. The Server will stop sending messages of these
         types in order to reduce I/O. Note that the Server may occasionally send a blacklisted message to prevent
         time-outs and stale tokens on clients.
         
        repeated .io.axoniq.axonserver.grpc.event.PayloadDescription blacklist = 6;
      • getBlacklistOrBuilder

        public PayloadDescriptionOrBuilder getBlacklistOrBuilder​(int index)
         An enumeration of payload types that need to be blacklisted. The Server will stop sending messages of these
         types in order to reduce I/O. Note that the Server may occasionally send a blacklisted message to prevent
         time-outs and stale tokens on clients.
         
        repeated .io.axoniq.axonserver.grpc.event.PayloadDescription blacklist = 6;
        Specified by:
        getBlacklistOrBuilder in interface GetEventsRequestOrBuilder
      • getBlacklistOrBuilderList

        public List<? extends PayloadDescriptionOrBuilder> getBlacklistOrBuilderList()
         An enumeration of payload types that need to be blacklisted. The Server will stop sending messages of these
         types in order to reduce I/O. Note that the Server may occasionally send a blacklisted message to prevent
         time-outs and stale tokens on clients.
         
        repeated .io.axoniq.axonserver.grpc.event.PayloadDescription blacklist = 6;
        Specified by:
        getBlacklistOrBuilderList in interface GetEventsRequestOrBuilder
      • addBlacklistBuilder

        public PayloadDescription.Builder addBlacklistBuilder()
         An enumeration of payload types that need to be blacklisted. The Server will stop sending messages of these
         types in order to reduce I/O. Note that the Server may occasionally send a blacklisted message to prevent
         time-outs and stale tokens on clients.
         
        repeated .io.axoniq.axonserver.grpc.event.PayloadDescription blacklist = 6;
      • addBlacklistBuilder

        public PayloadDescription.Builder addBlacklistBuilder​(int index)
         An enumeration of payload types that need to be blacklisted. The Server will stop sending messages of these
         types in order to reduce I/O. Note that the Server may occasionally send a blacklisted message to prevent
         time-outs and stale tokens on clients.
         
        repeated .io.axoniq.axonserver.grpc.event.PayloadDescription blacklist = 6;
      • getBlacklistBuilderList

        public List<PayloadDescription.Builder> getBlacklistBuilderList()
         An enumeration of payload types that need to be blacklisted. The Server will stop sending messages of these
         types in order to reduce I/O. Note that the Server may occasionally send a blacklisted message to prevent
         time-outs and stale tokens on clients.
         
        repeated .io.axoniq.axonserver.grpc.event.PayloadDescription blacklist = 6;
      • getForceReadFromLeader

        public boolean getForceReadFromLeader()
         Indicates whether to force reading 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 = 7;
        Specified by:
        getForceReadFromLeader in interface GetEventsRequestOrBuilder
        Returns:
        The forceReadFromLeader.
      • setForceReadFromLeader

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

        public GetEventsRequest.Builder clearForceReadFromLeader()
         Indicates whether to force reading 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 = 7;
        Returns:
        This builder for chaining.