Package s2.v1alpha

Class ReadRequest

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.io.Serializable, ReadRequestOrBuilder

    public final class ReadRequest
    extends com.google.protobuf.GeneratedMessage
    implements ReadRequestOrBuilder
     Read request.
     
    Protobuf type s2.v1alpha.ReadRequest
    See Also:
    Serialized Form
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  ReadRequest.Builder
      Read request.
      static class  ReadRequest.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 Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object obj)  
      static ReadRequest getDefaultInstance()  
      ReadRequest getDefaultInstanceForType()  
      static com.google.protobuf.Descriptors.Descriptor getDescriptor()  
      ReadLimit getLimit()
      Limit how many records can be returned.
      ReadLimitOrBuilder getLimitOrBuilder()
      Limit how many records can be returned.
      com.google.protobuf.Parser<ReadRequest> getParserForType()  
      long getSeqNum()
      Sequence number.
      int getSerializedSize()  
      ReadRequest.StartCase getStartCase()  
      java.lang.String getStream()
      Stream name.
      com.google.protobuf.ByteString getStreamBytes()
      Stream name.
      long getTailOffset()
      Number of records before the tail, i.e.
      long getTimestamp()
      Timestamp.
      long getUntil()
      Exclusive timestamp to read until.
      int hashCode()  
      boolean hasLimit()
      Limit how many records can be returned.
      boolean hasSeqNum()
      Sequence number.
      boolean hasTailOffset()
      Number of records before the tail, i.e.
      boolean hasTimestamp()
      Timestamp.
      boolean hasUntil()
      Exclusive timestamp to read until.
      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()  
      boolean isInitialized()  
      static ReadRequest.Builder newBuilder()  
      static ReadRequest.Builder newBuilder​(ReadRequest prototype)  
      ReadRequest.Builder newBuilderForType()  
      protected ReadRequest.Builder newBuilderForType​(com.google.protobuf.AbstractMessage.BuilderParent parent)  
      static ReadRequest parseDelimitedFrom​(java.io.InputStream input)  
      static ReadRequest parseDelimitedFrom​(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static ReadRequest parseFrom​(byte[] data)  
      static ReadRequest parseFrom​(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static ReadRequest parseFrom​(com.google.protobuf.ByteString data)  
      static ReadRequest parseFrom​(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static ReadRequest parseFrom​(com.google.protobuf.CodedInputStream input)  
      static ReadRequest parseFrom​(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static ReadRequest parseFrom​(java.io.InputStream input)  
      static ReadRequest parseFrom​(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static ReadRequest parseFrom​(java.nio.ByteBuffer data)  
      static ReadRequest parseFrom​(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static com.google.protobuf.Parser<ReadRequest> parser()  
      ReadRequest.Builder toBuilder()  
      void writeTo​(com.google.protobuf.CodedOutputStream output)  
      • Methods inherited from class com.google.protobuf.GeneratedMessage

        canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag
      • Methods inherited from class com.google.protobuf.AbstractMessage

        findInitializationErrors, getInitializationErrorString, hashFields, toString
      • Methods inherited from class com.google.protobuf.AbstractMessageLite

        addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo
      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait
      • Methods inherited from interface com.google.protobuf.MessageLite

        toByteArray, toByteString, writeDelimitedTo, writeTo
      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
    • 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
      • getStream

        public java.lang.String getStream()
         Stream name.
         
        string stream = 1;
        Specified by:
        getStream in interface ReadRequestOrBuilder
        Returns:
        The stream.
      • getStreamBytes

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

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

        public long getSeqNum()
         Sequence number.
         
        uint64 seq_num = 2;
        Specified by:
        getSeqNum in interface ReadRequestOrBuilder
        Returns:
        The seqNum.
      • hasTimestamp

        public boolean hasTimestamp()
         Timestamp.
         
        uint64 timestamp = 4;
        Specified by:
        hasTimestamp in interface ReadRequestOrBuilder
        Returns:
        Whether the timestamp field is set.
      • getTimestamp

        public long getTimestamp()
         Timestamp.
         
        uint64 timestamp = 4;
        Specified by:
        getTimestamp in interface ReadRequestOrBuilder
        Returns:
        The timestamp.
      • hasTailOffset

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

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

        public boolean hasLimit()
         Limit how many records can be returned.
         This will get capped at the default limit,
         which is up to 1000 records or 1MiB of metered bytes.
         
        .s2.v1alpha.ReadLimit limit = 3;
        Specified by:
        hasLimit in interface ReadRequestOrBuilder
        Returns:
        Whether the limit field is set.
      • getLimit

        public ReadLimit getLimit()
         Limit how many records can be returned.
         This will get capped at the default limit,
         which is up to 1000 records or 1MiB of metered bytes.
         
        .s2.v1alpha.ReadLimit limit = 3;
        Specified by:
        getLimit in interface ReadRequestOrBuilder
        Returns:
        The limit.
      • getLimitOrBuilder

        public ReadLimitOrBuilder getLimitOrBuilder()
         Limit how many records can be returned.
         This will get capped at the default limit,
         which is up to 1000 records or 1MiB of metered bytes.
         
        .s2.v1alpha.ReadLimit limit = 3;
        Specified by:
        getLimitOrBuilder in interface ReadRequestOrBuilder
      • 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 = 6;
        Specified by:
        hasUntil in interface ReadRequestOrBuilder
        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 = 6;
        Specified by:
        getUntil in interface ReadRequestOrBuilder
        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 ReadRequest parseFrom​(java.nio.ByteBuffer data)
                                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

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

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

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

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

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

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

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

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

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

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

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

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

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

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

        public static ReadRequest getDefaultInstance()
      • parser

        public static com.google.protobuf.Parser<ReadRequest> parser()
      • getParserForType

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