org.yamcs.protobuf.ListCommandHistoryIndexRequestOrBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of yamcs-api Show documentation
Used by external clients to communicate with Yamcs
There is a newer version: 5.10.9
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: yamcs/protobuf/archive/index_service.proto

package org.yamcs.protobuf;

public interface ListCommandHistoryIndexRequestOrBuilder extends
    // @@protoc_insertion_point(interface_extends:yamcs.protobuf.archive.ListCommandHistoryIndexRequest)
    com.google.protobuf.MessageOrBuilder {

  /**
   *    * Yamcs instance name
   * 
   *
   * optional string instance = 1;
   * @return Whether the instance field is set.
   */
  boolean hasInstance();
  /**
   *    * Yamcs instance name
   * 
   *
   * optional string instance = 1;
   * @return The instance.
   */
  java.lang.String getInstance();
  /**
   *    * Yamcs instance name
   * 
   *
   * optional string instance = 1;
   * @return The bytes for instance.
   */
  com.google.protobuf.ByteString
      getInstanceBytes();

  /**
   *    * Value in milliseconds that indicates the maximum gap before two consecutive index
   * ranges are merged together. Default: ``2000``
   * 
   *
   * optional int32 mergeTime = 2;
   * @return Whether the mergeTime field is set.
   */
  boolean hasMergeTime();
  /**
   *    * Value in milliseconds that indicates the maximum gap before two consecutive index
   * ranges are merged together. Default: ``2000``
   * 
   *
   * optional int32 mergeTime = 2;
   * @return The mergeTime.
   */
  int getMergeTime();

  /**
   *    * 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;
   * @return Whether the limit field is set.
   */
  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;
   * @return The limit.
   */
  int getLimit();

  /**
   *    * Filter the lower bound of the index entries. Specify a date string in ISO 8601 format.
   * 
   *
   * optional .google.protobuf.Timestamp start = 4;
   * @return Whether the start field is set.
   */
  boolean hasStart();
  /**
   *    * Filter the lower bound of the index entries. Specify a date string in ISO 8601 format.
   * 
   *
   * optional .google.protobuf.Timestamp start = 4;
   * @return The start.
   */
  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;
   */
  com.google.protobuf.TimestampOrBuilder getStartOrBuilder();

  /**
   *    * Filter the upper bound of the index entries. Specify a date string in ISO 8601 format.
   * 
   *
   * optional .google.protobuf.Timestamp stop = 5;
   * @return Whether the stop field is set.
   */
  boolean hasStop();
  /**
   *    * Filter the upper bound of the index entries. Specify a date string in ISO 8601 format.
   * 
   *
   * optional .google.protobuf.Timestamp stop = 5;
   * @return The stop.
   */
  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;
   */
  com.google.protobuf.TimestampOrBuilder getStopOrBuilder();

  /**
   *    * Continuation token returned by a previous page response.
   * 
   *
   * optional string next = 6;
   * @return Whether the next field is set.
   */
  boolean hasNext();
  /**
   *    * Continuation token returned by a previous page response.
   * 
   *
   * optional string next = 6;
   * @return The next.
   */
  java.lang.String getNext();
  /**
   *    * Continuation token returned by a previous page response.
   * 
   *
   * optional string next = 6;
   * @return The bytes for next.
   */
  com.google.protobuf.ByteString
      getNextBytes();

  /**
   *    * Filter on a specific command
   * 
   *
   * repeated string name = 7;
   * @return A list containing the name.
   */
  java.util.List
      getNameList();
  /**
   *    * Filter on a specific command
   * 
   *
   * repeated string name = 7;
   * @return The count of name.
   */
  int getNameCount();
  /**
   *    * Filter on a specific command
   * 
   *
   * repeated string name = 7;
   * @param index The index of the element to return.
   * @return The name at the given index.
   */
  java.lang.String getName(int index);
  /**
   *    * Filter on a specific command
   * 
   *
   * repeated string name = 7;
   * @param index The index of the value to return.
   * @return The bytes of the name at the given index.
   */
  com.google.protobuf.ByteString
      getNameBytes(int index);
}