Package s2.v1alpha

Class ReadSessionRequest

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.io.Serializable, ReadSessionRequestOrBuilder
    public final class ReadSessionRequest
extends com.google.protobuf.GeneratedMessage
implements ReadSessionRequestOrBuilder
     Read session request.
    Protobuf type s2.v1alpha.ReadSessionRequest
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  ReadSessionRequest.Builder
      Read session request.
      static class  ReadSessionRequest.StartCase  

      • 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 java.lang.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

    • 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

      • getStreamBytes

        public com.google.protobuf.ByteString getStreamBytes()
         Stream name.
        string stream = 1;
        Specified by:
        getStreamBytes in interface ReadSessionRequestOrBuilder
        Returns:
        The bytes for stream.

      • hasSeqNum

        public boolean hasSeqNum()
         Sequence number.
        uint64 seq_num = 2;
        Specified by:
        hasSeqNum in interface ReadSessionRequestOrBuilder
        Returns:
        Whether the seqNum field is set.

      • hasTailOffset

        public boolean hasTailOffset()
         Number of records before the tail, i.e. the next sequence number.
        uint64 tail_offset = 6;
        Specified by:
        hasTailOffset in interface ReadSessionRequestOrBuilder
        Returns:
        Whether the tailOffset field is set.

      • getTailOffset

        public long getTailOffset()
         Number of records before the tail, i.e. the next sequence number.
        uint64 tail_offset = 6;
        Specified by:
        getTailOffset in interface ReadSessionRequestOrBuilder
        Returns:
        The tailOffset.

      • hasLimit

        public boolean hasLimit()
         Limit on how many records can be returned. When a limit is specified, the session will be terminated as soon as
 the limit is met, or when the current tail of the stream is reached -- whichever occurs first.
 If no limit is specified, the session will remain open after catching up to the tail, and continue tailing as
 new messages are written to the stream.
        .s2.v1alpha.ReadLimit limit = 3;
        Specified by:
        hasLimit in interface ReadSessionRequestOrBuilder
        Returns:
        Whether the limit field is set.

      • getLimit

        public ReadLimit getLimit()
         Limit on how many records can be returned. When a limit is specified, the session will be terminated as soon as
 the limit is met, or when the current tail of the stream is reached -- whichever occurs first.
 If no limit is specified, the session will remain open after catching up to the tail, and continue tailing as
 new messages are written to the stream.
        .s2.v1alpha.ReadLimit limit = 3;
        Specified by:
        getLimit in interface ReadSessionRequestOrBuilder
        Returns:
        The limit.

      • getLimitOrBuilder

        public ReadLimitOrBuilder getLimitOrBuilder()
         Limit on how many records can be returned. When a limit is specified, the session will be terminated as soon as
 the limit is met, or when the current tail of the stream is reached -- whichever occurs first.
 If no limit is specified, the session will remain open after catching up to the tail, and continue tailing as
 new messages are written to the stream.
        .s2.v1alpha.ReadLimit limit = 3;
        Specified by:
        getLimitOrBuilder in interface ReadSessionRequestOrBuilder

      • getHeartbeats

        public boolean getHeartbeats()
         Heartbeats can be enabled to monitor end-to-end session health.
 A heartbeat will be sent when the initial switch to real-time tailing happens,
 as well as when no records are available at a randomized interval between 5 and 15 seconds.
        bool heartbeats = 4;
        Specified by:
        getHeartbeats in interface ReadSessionRequestOrBuilder
        Returns:
        The heartbeats.

      • hasUntil

        public boolean hasUntil()
         Exclusive timestamp to read until.
 If provided, this is applied as an additional constraint on top of the `limit`,
 and will guarantee that all records returned have timestamps < the provided `until`.
        optional uint64 until = 7;
        Specified by:
        hasUntil in interface ReadSessionRequestOrBuilder
        Returns:
        Whether the until field is set.

      • getUntil

        public long getUntil()
         Exclusive timestamp to read until.
 If provided, this is applied as an additional constraint on top of the `limit`,
 and will guarantee that all records returned have timestamps < the provided `until`.
        optional uint64 until = 7;
        Specified by:
        getUntil in interface ReadSessionRequestOrBuilder
        Returns:
        The until.

      • 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 java.io.IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessage
        Throws:
        java.io.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​(java.lang.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 ReadSessionRequest parseFrom​(java.nio.ByteBuffer data)
                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ReadSessionRequest parseFrom​(java.nio.ByteBuffer data,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

        public static ReadSessionRequest parseFrom​(java.io.InputStream input)
                                    throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static ReadSessionRequest parseFrom​(java.io.InputStream input,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

        public static ReadSessionRequest parseDelimitedFrom​(java.io.InputStream input)
                                             throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

        public static ReadSessionRequest parseDelimitedFrom​(java.io.InputStream input,
                                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                             throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static ReadSessionRequest parseFrom​(com.google.protobuf.CodedInputStream input)
                                    throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static ReadSessionRequest parseFrom​(com.google.protobuf.CodedInputStream input,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws java.io.IOException
        Throws:
        java.io.IOException

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getParserForType

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