org.yamcs.protobuf.TemplateVariableOrBuilder 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/instances/instances.proto

package org.yamcs.protobuf;

public interface TemplateVariableOrBuilder extends
    // @@protoc_insertion_point(interface_extends:yamcs.protobuf.instances.TemplateVariable)
    com.google.protobuf.MessageOrBuilder {

  /**
   *    * Variable name. 
   * 
   *
   * optional string name = 1;
   * @return Whether the name field is set.
   */
  boolean hasName();
  /**
   *    * Variable name. 
   * 
   *
   * optional string name = 1;
   * @return The name.
   */
  java.lang.String getName();
  /**
   *    * Variable name. 
   * 
   *
   * optional string name = 1;
   * @return The bytes for name.
   */
  com.google.protobuf.ByteString
      getNameBytes();

  /**
   *    * Verbose name for use in UI forms
   * 
   *
   * optional string label = 6;
   * @return Whether the label field is set.
   */
  boolean hasLabel();
  /**
   *    * Verbose name for use in UI forms
   * 
   *
   * optional string label = 6;
   * @return The label.
   */
  java.lang.String getLabel();
  /**
   *    * Verbose name for use in UI forms
   * 
   *
   * optional string label = 6;
   * @return The bytes for label.
   */
  com.google.protobuf.ByteString
      getLabelBytes();

  /**
   *    * Type of variable (Java class extending org.yamcs.templating.Variable)
   * 
   *
   * optional string type = 4;
   * @return Whether the type field is set.
   */
  boolean hasType();
  /**
   *    * Type of variable (Java class extending org.yamcs.templating.Variable)
   * 
   *
   * optional string type = 4;
   * @return The type.
   */
  java.lang.String getType();
  /**
   *    * Type of variable (Java class extending org.yamcs.templating.Variable)
   * 
   *
   * optional string type = 4;
   * @return The bytes for type.
   */
  com.google.protobuf.ByteString
      getTypeBytes();

  /**
   *    * Verbose user guidance (HTML)
   * 
   *
   * optional string help = 2;
   * @return Whether the help field is set.
   */
  boolean hasHelp();
  /**
   *    * Verbose user guidance (HTML)
   * 
   *
   * optional string help = 2;
   * @return The help.
   */
  java.lang.String getHelp();
  /**
   *    * Verbose user guidance (HTML)
   * 
   *
   * optional string help = 2;
   * @return The bytes for help.
   */
  com.google.protobuf.ByteString
      getHelpBytes();

  /**
   *    * Whether this variable is required input
   * 
   *
   * optional bool required = 3;
   * @return Whether the required field is set.
   */
  boolean hasRequired();
  /**
   *    * Whether this variable is required input
   * 
   *
   * optional bool required = 3;
   * @return The required.
   */
  boolean getRequired();

  /**
   *    * List of valid choices
   * 
   *
   * repeated string choices = 5;
   * @return A list containing the choices.
   */
  java.util.List
      getChoicesList();
  /**
   *    * List of valid choices
   * 
   *
   * repeated string choices = 5;
   * @return The count of choices.
   */
  int getChoicesCount();
  /**
   *    * List of valid choices
   * 
   *
   * repeated string choices = 5;
   * @param index The index of the element to return.
   * @return The choices at the given index.
   */
  java.lang.String getChoices(int index);
  /**
   *    * List of valid choices
   * 
   *
   * repeated string choices = 5;
   * @param index The index of the value to return.
   * @return The bytes of the choices at the given index.
   */
  com.google.protobuf.ByteString
      getChoicesBytes(int index);

  /**
   *    * Initial value for use in UI forms
   * 
   *
   * optional string initial = 7;
   * @return Whether the initial field is set.
   */
  boolean hasInitial();
  /**
   *    * Initial value for use in UI forms
   * 
   *
   * optional string initial = 7;
   * @return The initial.
   */
  java.lang.String getInitial();
  /**
   *    * Initial value for use in UI forms
   * 
   *
   * optional string initial = 7;
   * @return The bytes for initial.
   */
  com.google.protobuf.ByteString
      getInitialBytes();
}