Package s2.v1alpha

Interface ReadSessionRequestOrBuilder

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

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      boolean getHeartbeats()
      Heartbeats can be enabled to monitor end-to-end session health.
      ReadLimit getLimit()
      Limit on how many records can be returned.
      ReadLimitOrBuilder getLimitOrBuilder()
      Limit on how many records can be returned.
      long getSeqNum()
      Sequence number.
      ReadSessionRequest.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.
      boolean hasLimit()
      Limit on how many records can be returned.
      boolean hasSeqNum()
      Sequence number.
      boolean hasTailOffset()
      Number of records before the tail, i.e.
      boolean hasTimestamp()
      Timestamp.

      • 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 = 5;
        Returns:
        Whether the timestamp field is set.

      • getTimestamp

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

      • hasTailOffset

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

      • getTailOffset

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

      • hasLimit

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

      • getLimit

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

      • getLimitOrBuilder

        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;

      • getHeartbeats

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