org.yamcs.protobuf.ListPacketsRequestOrBuilder 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/packets/packets_service.proto

package org.yamcs.protobuf;

public interface ListPacketsRequestOrBuilder extends
    // @@protoc_insertion_point(interface_extends:yamcs.protobuf.packets.ListPacketsRequest)
    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 zero-based row number at which to start outputting results.
   * Default: ``0``
   * This option is deprecated and will be removed in a later version.
   * Use the returned continuationToken instead.
   * 
   *
   * optional int64 pos = 2 [deprecated = true];
   * @deprecated
   * @return Whether the pos field is set.
   */
  @java.lang.Deprecated boolean hasPos();
  /**
   *    * The zero-based row number at which to start outputting results.
   * Default: ``0``
   * This option is deprecated and will be removed in a later version.
   * Use the returned continuationToken instead.
   * 
   *
   * optional int64 pos = 2 [deprecated = true];
   * @deprecated
   * @return The pos.
   */
  @java.lang.Deprecated long getPos();

  /**
   *    * The maximum number of returned records per page. Choose this value too high
   * and you risk hitting the maximum response size limit enforced by the server.
   * Default: ``100``
   * 
   *
   * optional int32 limit = 3;
   * @return Whether the limit field is set.
   */
  boolean hasLimit();
  /**
   *    * The maximum number of returned records per page. Choose this value too high
   * and you risk hitting the maximum response size limit enforced by the server.
   * Default: ``100``
   * 
   *
   * optional int32 limit = 3;
   * @return The limit.
   */
  int getLimit();

  /**
   *    * The order of the returned results. Can be either ``asc`` or ``desc``. Default: ``desc``
   * 
   *
   * optional string order = 4;
   * @return Whether the order field is set.
   */
  boolean hasOrder();
  /**
   *    * The order of the returned results. Can be either ``asc`` or ``desc``. Default: ``desc``
   * 
   *
   * optional string order = 4;
   * @return The order.
   */
  java.lang.String getOrder();
  /**
   *    * The order of the returned results. Can be either ``asc`` or ``desc``. Default: ``desc``
   * 
   *
   * optional string order = 4;
   * @return The bytes for order.
   */
  com.google.protobuf.ByteString
      getOrderBytes();

  /**
   *    * The archived name of the packets. Names must match exactly.
   * 
   *
   * repeated string name = 5;
   * @return A list containing the name.
   */
  java.util.List
      getNameList();
  /**
   *    * The archived name of the packets. Names must match exactly.
   * 
   *
   * repeated string name = 5;
   * @return The count of name.
   */
  int getNameCount();
  /**
   *    * The archived name of the packets. Names must match exactly.
   * 
   *
   * repeated string name = 5;
   * @param index The index of the element to return.
   * @return The name at the given index.
   */
  java.lang.String getName(int index);
  /**
   *    * The archived name of the packets. Names must match exactly.
   * 
   *
   * repeated string name = 5;
   * @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);

  /**
   *    * Filter by the link where the packet was received from.
   * 
   *
   * optional string link = 9;
   * @return Whether the link field is set.
   */
  boolean hasLink();
  /**
   *    * Filter by the link where the packet was received from.
   * 
   *
   * optional string link = 9;
   * @return The link.
   */
  java.lang.String getLink();
  /**
   *    * Filter by the link where the packet was received from.
   * 
   *
   * optional string link = 9;
   * @return The bytes for link.
   */
  com.google.protobuf.ByteString
      getLinkBytes();

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

  /**
   *    * Filter the upper bound of the packet's generation time. Specify a date
   * string in ISO 8601 format. This bound is exclusive.
   * 
   *
   * optional .google.protobuf.Timestamp stop = 8;
   * @return Whether the stop field is set.
   */
  boolean hasStop();
  /**
   *    * Filter the upper bound of the packet's generation time. Specify a date
   * string in ISO 8601 format. This bound is exclusive.
   * 
   *
   * optional .google.protobuf.Timestamp stop = 8;
   * @return The stop.
   */
  com.google.protobuf.Timestamp getStop();
  /**
   *    * Filter the upper bound of the packet's generation time. Specify a date
   * string in ISO 8601 format. This bound is exclusive.
   * 
   *
   * optional .google.protobuf.Timestamp stop = 8;
   */
  com.google.protobuf.TimestampOrBuilder getStopOrBuilder();
}