Package org.yamcs.protobuf

Interface ListPacketIndexRequestOrBuilder

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

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      String getInstance()
      Yamcs instance name.
      com.google.protobuf.ByteString getInstanceBytes()
      Yamcs instance name.
      int getLimit()
      The maximum number of returned entries.
      int getMergeTime()
      Value in milliseconds that indicates the maximum gap before two consecutive index ranges are merged together.
      String getName​(int index)
      repeated string name = 7;
      com.google.protobuf.ByteString getNameBytes​(int index)
      repeated string name = 7;
      int getNameCount()
      repeated string name = 7;
      List<String> getNameList()
      repeated string name = 7;
      String getNext()
      optional string next = 6;
      com.google.protobuf.ByteString getNextBytes()
      optional string next = 6;
      com.google.protobuf.Timestamp getStart()
      Filter the lower bound of the index entries.
      com.google.protobuf.TimestampOrBuilder getStartOrBuilder()
      Filter the lower bound of the index entries.
      com.google.protobuf.Timestamp getStop()
      Filter the upper bound of the index entries.
      com.google.protobuf.TimestampOrBuilder getStopOrBuilder()
      Filter the upper bound of the index entries.
      boolean hasInstance()
      Yamcs instance name.
      boolean hasLimit()
      The maximum number of returned entries.
      boolean hasMergeTime()
      Value in milliseconds that indicates the maximum gap before two consecutive index ranges are merged together.
      boolean hasNext()
      optional string next = 6;
      boolean hasStart()
      Filter the lower bound of the index entries.
      boolean hasStop()
      Filter the upper bound of the index entries.

      • 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

      • hasInstance

        boolean hasInstance()
         Yamcs instance name.
        optional string instance = 1;

      • getInstance

        String getInstance()
         Yamcs instance name.
        optional string instance = 1;

      • getInstanceBytes

        com.google.protobuf.ByteString getInstanceBytes()
         Yamcs instance name.
        optional string instance = 1;

      • hasMergeTime

        boolean hasMergeTime()
         Value in milliseconds that indicates the maximum gap before two consecutive index
 ranges are merged together. Default: ``2000``
        optional int32 mergeTime = 2;

      • getMergeTime

        int getMergeTime()
         Value in milliseconds that indicates the maximum gap before two consecutive index
 ranges are merged together. Default: ``2000``
        optional int32 mergeTime = 2;

      • hasLimit

        boolean hasLimit()
         The maximum number of returned entries. Choose this value too high and you risk
 hitting the maximum response size limit enforced by the server. Default: ``1000``.
 Note that in general it is advised to control the size of the response via
 ``mergeTime``, rather than via ``limit``.
        optional int32 limit = 3;

      • getLimit

        int getLimit()
         The maximum number of returned entries. Choose this value too high and you risk
 hitting the maximum response size limit enforced by the server. Default: ``1000``.
 Note that in general it is advised to control the size of the response via
 ``mergeTime``, rather than via ``limit``.
        optional int32 limit = 3;

      • hasStart

        boolean hasStart()
         Filter the lower bound of the index entries. Specify a date string in ISO 8601 format.
        optional .google.protobuf.Timestamp start = 4;

      • getStart

        com.google.protobuf.Timestamp getStart()
         Filter the lower bound of the index entries. Specify a date string in ISO 8601 format.
        optional .google.protobuf.Timestamp start = 4;

      • getStartOrBuilder

        com.google.protobuf.TimestampOrBuilder getStartOrBuilder()
         Filter the lower bound of the index entries. Specify a date string in ISO 8601 format.
        optional .google.protobuf.Timestamp start = 4;

      • hasStop

        boolean hasStop()
         Filter the upper bound of the index entries. Specify a date string in ISO 8601 format.
        optional .google.protobuf.Timestamp stop = 5;

      • getStop

        com.google.protobuf.Timestamp getStop()
         Filter the upper bound of the index entries. Specify a date string in ISO 8601 format.
        optional .google.protobuf.Timestamp stop = 5;

      • getStopOrBuilder

        com.google.protobuf.TimestampOrBuilder getStopOrBuilder()
         Filter the upper bound of the index entries. Specify a date string in ISO 8601 format.
        optional .google.protobuf.Timestamp stop = 5;

      • hasNext

        boolean hasNext()
        optional string next = 6;

      • getNext

        String getNext()
        optional string next = 6;

      • getNextBytes

        com.google.protobuf.ByteString getNextBytes()
        optional string next = 6;

      • getNameList

        List<String> getNameList()
        repeated string name = 7;

      • getNameCount

        int getNameCount()
        repeated string name = 7;

      • getName

        String getName​(int index)
        repeated string name = 7;

      • getNameBytes

        com.google.protobuf.ByteString getNameBytes​(int index)
        repeated string name = 7;