org.yamcs.protobuf.GetArchivedParametersInfoRequestOrBuilder 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/parameter_archive_service.proto

package org.yamcs.protobuf;

public interface GetArchivedParametersInfoRequestOrBuilder extends
    // @@protoc_insertion_point(interface_extends:yamcs.protobuf.archive.GetArchivedParametersInfoRequest)
    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 search keywords.
   * 
   *
   * optional string q = 2;
   * @return Whether the q field is set.
   */
  boolean hasQ();
  /**
   *    * The search keywords.
   * 
   *
   * optional string q = 2;
   * @return The q.
   */
  java.lang.String getQ();
  /**
   *    * The search keywords.
   * 
   *
   * optional string q = 2;
   * @return The bytes for q.
   */
  com.google.protobuf.ByteString
      getQBytes();

  /**
   *    * List only direct child parameters of the specified system. 
   * Only the parameters whose fully qualified name start with system will be returned.
   * When ``system`` and ``q`` are used together, the q search will be matched on the parameters 
   * filtered by system.
   * 
   *
   * optional string system = 3;
   * @return Whether the system field is set.
   */
  boolean hasSystem();
  /**
   *    * List only direct child parameters of the specified system. 
   * Only the parameters whose fully qualified name start with system will be returned.
   * When ``system`` and ``q`` are used together, the q search will be matched on the parameters 
   * filtered by system.
   * 
   *
   * optional string system = 3;
   * @return The system.
   */
  java.lang.String getSystem();
  /**
   *    * List only direct child parameters of the specified system. 
   * Only the parameters whose fully qualified name start with system will be returned.
   * When ``system`` and ``q`` are used together, the q search will be matched on the parameters 
   * filtered by system.
   * 
   *
   * optional string system = 3;
   * @return The bytes for system.
   */
  com.google.protobuf.ByteString
      getSystemBytes();

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