org.yamcs.protobuf.StreamPacketIndexRequestOrBuilder 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 StreamPacketIndexRequestOrBuilder extends
    // @@protoc_insertion_point(interface_extends:yamcs.protobuf.archive.StreamPacketIndexRequest)
    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();

  /**
   *    * The time at which to start retrieving index records.
   * 
   *
   * optional .google.protobuf.Timestamp start = 2;
   * @return Whether the start field is set.
   */
  boolean hasStart();
  /**
   *    * The time at which to start retrieving index records.
   * 
   *
   * optional .google.protobuf.Timestamp start = 2;
   * @return The start.
   */
  com.google.protobuf.Timestamp getStart();
  /**
   *    * The time at which to start retrieving index records.
   * 
   *
   * optional .google.protobuf.Timestamp start = 2;
   */
  com.google.protobuf.TimestampOrBuilder getStartOrBuilder();

  /**
   *    * The time at which to stop retrieving index records.
   * 
   *
   * optional .google.protobuf.Timestamp stop = 3;
   * @return Whether the stop field is set.
   */
  boolean hasStop();
  /**
   *    * The time at which to stop retrieving index records.
   * 
   *
   * optional .google.protobuf.Timestamp stop = 3;
   * @return The stop.
   */
  com.google.protobuf.Timestamp getStop();
  /**
   *    * The time at which to stop retrieving index records.
   * 
   *
   * optional .google.protobuf.Timestamp stop = 3;
   */
  com.google.protobuf.TimestampOrBuilder getStopOrBuilder();

  /**
   *    * Filter on specific packet names
   * 
   *
   * repeated string names = 4;
   * @return A list containing the names.
   */
  java.util.List
      getNamesList();
  /**
   *    * Filter on specific packet names
   * 
   *
   * repeated string names = 4;
   * @return The count of names.
   */
  int getNamesCount();
  /**
   *    * Filter on specific packet names
   * 
   *
   * repeated string names = 4;
   * @param index The index of the element to return.
   * @return The names at the given index.
   */
  java.lang.String getNames(int index);
  /**
   *    * Filter on specific packet names
   * 
   *
   * repeated string names = 4;
   * @param index The index of the value to return.
   * @return The bytes of the names at the given index.
   */
  com.google.protobuf.ByteString
      getNamesBytes(int index);

  /**
   *    * Value in milliseconds that indicates the maximum gap before two consecutive index
   * ranges are merged together.
   * 
   *
   * optional uint32 mergeTime = 5;
   * @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.
   * 
   *
   * optional uint32 mergeTime = 5;
   * @return The mergeTime.
   */
  int getMergeTime();
}