Package org.yamcs.protobuf

Interface ListCommandHistoryIndexRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
ListCommandHistoryIndexRequest, ListCommandHistoryIndexRequest.Builder
public interface ListCommandHistoryIndexRequestOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    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)
    Filter on a specific command
    com.google.protobuf.ByteString
    getNameBytes(int index)
    Filter on a specific command
    int
    getNameCount()
    Filter on a specific command
    List<String>
    getNameList()
    Filter on a specific command
    String
    getNext()
    Continuation token returned by a previous page response.
    com.google.protobuf.ByteString
    getNextBytes()
    Continuation token returned by a previous page response.
    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()
    Continuation token returned by a previous page response.
    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 Details

    • hasInstance

      boolean hasInstance()
       Yamcs instance name
      optional string instance = 1;
      Returns:
      Whether the instance field is set.

    • getInstance

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

    • getInstanceBytes

      com.google.protobuf.ByteString getInstanceBytes()
       Yamcs instance name
      optional string instance = 1;
      Returns:
      The bytes for instance.

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

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

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

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

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

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

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

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

    • 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()
       Continuation token returned by a previous page response.
      optional string next = 6;
      Returns:
      Whether the next field is set.

    • getNext

      String getNext()
       Continuation token returned by a previous page response.
      optional string next = 6;
      Returns:
      The next.

    • getNextBytes

      com.google.protobuf.ByteString getNextBytes()
       Continuation token returned by a previous page response.
      optional string next = 6;
      Returns:
      The bytes for next.

    • getNameList

      List<String> getNameList()
       Filter on a specific command
      repeated string name = 7;
      Returns:
      A list containing the name.

    • getNameCount

      int getNameCount()
       Filter on a specific command
      repeated string name = 7;
      Returns:
      The count of name.

    • getName

      String getName(int index)
       Filter on a specific command
      repeated string name = 7;
      Parameters:
      index - The index of the element to return.
      Returns:
      The name at the given index.

    • getNameBytes

      com.google.protobuf.ByteString getNameBytes(int index)
       Filter on a specific command
      repeated string name = 7;
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the name at the given index.