Package s2.v1alpha

Interface ReadRequestOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    ReadRequest, ReadRequest.Builder
    public interface ReadRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      ReadLimit getLimit()
      Limit how many records can be returned.
      ReadLimitOrBuilder getLimitOrBuilder()
      Limit how many records can be returned.
      long getSeqNum()
      Sequence number.
      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.
      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.

      • Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

        isInitialized

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

    • Method Detail

      • getStream

        java.lang.String getStream()
         Stream name.
        string stream = 1;
        Returns:
        The stream.

      • getStreamBytes

        com.google.protobuf.ByteString getStreamBytes()
         Stream name.
        string stream = 1;
        Returns:
        The bytes for stream.

      • hasSeqNum

        boolean hasSeqNum()
         Sequence number.
        uint64 seq_num = 2;
        Returns:
        Whether the seqNum field is set.

      • getSeqNum

        long getSeqNum()
         Sequence number.
        uint64 seq_num = 2;
        Returns:
        The seqNum.

      • hasTimestamp

        boolean hasTimestamp()
         Timestamp.
        uint64 timestamp = 4;
        Returns:
        Whether the timestamp field is set.

      • getTimestamp

        long getTimestamp()
         Timestamp.
        uint64 timestamp = 4;
        Returns:
        The timestamp.

      • hasTailOffset

        boolean hasTailOffset()
         Number of records before the tail, i.e. before the next sequence number.
        uint64 tail_offset = 5;
        Returns:
        Whether the tailOffset field is set.

      • getTailOffset

        long getTailOffset()
         Number of records before the tail, i.e. before the next sequence number.
        uint64 tail_offset = 5;
        Returns:
        The tailOffset.

      • hasLimit

        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;
        Returns:
        Whether the limit field is set.

      • getLimit

        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;
        Returns:
        The limit.

      • getLimitOrBuilder

        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;

      • hasUntil

        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;
        Returns:
        Whether the until field is set.

      • getUntil

        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;
        Returns:
        The until.