org.yamcs.protobuf.ListItemsRequestOrBuilder 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/timeline/timeline.proto

package org.yamcs.protobuf;

public interface ListItemsRequestOrBuilder extends
    // @@protoc_insertion_point(interface_extends:yamcs.protobuf.timeline.ListItemsRequest)
    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();

  /**
   *    * Item source
   * 
   *
   * optional string source = 2;
   * @return Whether the source field is set.
   */
  boolean hasSource();
  /**
   *    * Item source
   * 
   *
   * optional string source = 2;
   * @return The source.
   */
  java.lang.String getSource();
  /**
   *    * Item source
   * 
   *
   * optional string source = 2;
   * @return The bytes for source.
   */
  com.google.protobuf.ByteString
      getSourceBytes();

  /**
   * optional int32 limit = 3;
   * @return Whether the limit field is set.
   */
  boolean hasLimit();
  /**
   * optional int32 limit = 3;
   * @return The limit.
   */
  int getLimit();

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

  /**
   * optional .google.protobuf.Timestamp start = 5;
   * @return Whether the start field is set.
   */
  boolean hasStart();
  /**
   * optional .google.protobuf.Timestamp start = 5;
   * @return The start.
   */
  com.google.protobuf.Timestamp getStart();
  /**
   * optional .google.protobuf.Timestamp start = 5;
   */
  com.google.protobuf.TimestampOrBuilder getStartOrBuilder();

  /**
   * optional .google.protobuf.Timestamp stop = 6;
   * @return Whether the stop field is set.
   */
  boolean hasStop();
  /**
   * optional .google.protobuf.Timestamp stop = 6;
   * @return The stop.
   */
  com.google.protobuf.Timestamp getStop();
  /**
   * optional .google.protobuf.Timestamp stop = 6;
   */
  com.google.protobuf.TimestampOrBuilder getStopOrBuilder();

  /**
   *    * Use the band defined source and filter
   * 
   *
   * optional string band = 7;
   * @return Whether the band field is set.
   */
  boolean hasBand();
  /**
   *    * Use the band defined source and filter
   * 
   *
   * optional string band = 7;
   * @return The band.
   */
  java.lang.String getBand();
  /**
   *    * Use the band defined source and filter
   * 
   *
   * optional string band = 7;
   * @return The bytes for band.
   */
  com.google.protobuf.ByteString
      getBandBytes();

  /**
   *    * If the band is not specified, these filters and the source above will be used
   * 
   *
   * repeated .yamcs.protobuf.timeline.ItemFilter filters = 8;
   */
  java.util.List 
      getFiltersList();
  /**
   *    * If the band is not specified, these filters and the source above will be used
   * 
   *
   * repeated .yamcs.protobuf.timeline.ItemFilter filters = 8;
   */
  org.yamcs.protobuf.ItemFilter getFilters(int index);
  /**
   *    * If the band is not specified, these filters and the source above will be used
   * 
   *
   * repeated .yamcs.protobuf.timeline.ItemFilter filters = 8;
   */
  int getFiltersCount();
  /**
   *    * If the band is not specified, these filters and the source above will be used
   * 
   *
   * repeated .yamcs.protobuf.timeline.ItemFilter filters = 8;
   */
  java.util.List 
      getFiltersOrBuilderList();
  /**
   *    * If the band is not specified, these filters and the source above will be used
   * 
   *
   * repeated .yamcs.protobuf.timeline.ItemFilter filters = 8;
   */
  org.yamcs.protobuf.ItemFilterOrBuilder getFiltersOrBuilder(
      int index);

  /**
   *    * If true, send the items with full details
   * If false, some details like the description will be omited from the listed items
   * 
   *
   * optional bool details = 9;
   * @return Whether the details field is set.
   */
  boolean hasDetails();
  /**
   *    * If true, send the items with full details
   * If false, some details like the description will be omited from the listed items
   * 
   *
   * optional bool details = 9;
   * @return The details.
   */
  boolean getDetails();
}