Class GetEventsRequest

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, GetEventsRequestOrBuilder, Serializable

    @Generated
    public final class GetEventsRequest
    extends com.google.protobuf.GeneratedMessage
    implements GetEventsRequestOrBuilder
     Request message to open an Event Stream from the Event Store. 
     
    Protobuf type io.axoniq.axonserver.grpc.event.GetEventsRequest
    See Also:
    Serialized Form
    • Field Detail

      • TRACKING_TOKEN_FIELD_NUMBER

        public static final int TRACKING_TOKEN_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
      • COMPONENT_NAME_FIELD_NUMBER

        public static final int COMPONENT_NAME_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
    • 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
      • getTrackingToken

        public long getTrackingToken()
         The token to start streaming from 
         
        int64 tracking_token = 1;
        Specified by:
        getTrackingToken in interface GetEventsRequestOrBuilder
        Returns:
        The trackingToken.
      • 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.
      • 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.
      • 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.
      • 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.
      • 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
      • 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
      • 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
      • 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
      • 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.
      • 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 GetEventsRequest parseFrom​(ByteBuffer data)
                                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static GetEventsRequest parseFrom​(ByteBuffer data,
                                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static GetEventsRequest parseFrom​(com.google.protobuf.ByteString data)
                                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static GetEventsRequest parseFrom​(com.google.protobuf.ByteString data,
                                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static GetEventsRequest parseFrom​(byte[] data)
                                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static GetEventsRequest parseFrom​(byte[] data,
                                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static GetEventsRequest parseFrom​(com.google.protobuf.CodedInputStream input,
                                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                          throws IOException
        Throws:
        IOException
      • newBuilderForType

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

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

        protected GetEventsRequest.Builder newBuilderForType​(com.google.protobuf.AbstractMessage.BuilderParent parent)
        Overrides:
        newBuilderForType in class com.google.protobuf.AbstractMessage
      • getParserForType

        public com.google.protobuf.Parser<GetEventsRequest> 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 GetEventsRequest getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder