org.yamcs.protobuf.config.OptionInfoOrBuilder 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/config/config.proto

package org.yamcs.protobuf.config;

public interface OptionInfoOrBuilder extends
    // @@protoc_insertion_point(interface_extends:yamcs.protobuf.config.OptionInfo)
    com.google.protobuf.MessageOrBuilder {

  /**
   *    * Name of this option, unique within a spec
   * 
   *
   * optional string name = 1;
   * @return Whether the name field is set.
   */
  boolean hasName();
  /**
   *    * Name of this option, unique within a spec
   * 
   *
   * optional string name = 1;
   * @return The name.
   */
  java.lang.String getName();
  /**
   *    * Name of this option, unique within a spec
   * 
   *
   * optional string name = 1;
   * @return The bytes for name.
   */
  com.google.protobuf.ByteString
      getNameBytes();

  /**
   *    * Type of this option
   * 
   *
   * optional .yamcs.protobuf.config.OptionType type = 2;
   * @return Whether the type field is set.
   */
  boolean hasType();
  /**
   *    * Type of this option
   * 
   *
   * optional .yamcs.protobuf.config.OptionType type = 2;
   * @return The type.
   */
  org.yamcs.protobuf.config.OptionType getType();

  /**
   *    * UI-friendly label for this option
   * 
   *
   * optional string title = 3;
   * @return Whether the title field is set.
   */
  boolean hasTitle();
  /**
   *    * UI-friendly label for this option
   * 
   *
   * optional string title = 3;
   * @return The title.
   */
  java.lang.String getTitle();
  /**
   *    * UI-friendly label for this option
   * 
   *
   * optional string title = 3;
   * @return The bytes for title.
   */
  com.google.protobuf.ByteString
      getTitleBytes();

  /**
   *    * Default value when the option is not specified
   * 
   *
   * optional .google.protobuf.Value default = 4;
   * @return Whether the default field is set.
   */
  boolean hasDefault();
  /**
   *    * Default value when the option is not specified
   * 
   *
   * optional .google.protobuf.Value default = 4;
   * @return The default.
   */
  com.google.protobuf.Value getDefault();
  /**
   *    * Default value when the option is not specified
   * 
   *
   * optional .google.protobuf.Value default = 4;
   */
  com.google.protobuf.ValueOrBuilder getDefaultOrBuilder();

  /**
   *    * Whether this options must be specified
   * 
   *
   * optional bool required = 5;
   * @return Whether the required field is set.
   */
  boolean hasRequired();
  /**
   *    * Whether this options must be specified
   * 
   *
   * optional bool required = 5;
   * @return The required.
   */
  boolean getRequired();

  /**
   *    * Hint that this option should be excluded from any
   * document generation
   * 
   *
   * optional bool hidden = 6;
   * @return Whether the hidden field is set.
   */
  boolean hasHidden();
  /**
   *    * Hint that this option should be excluded from any
   * document generation
   * 
   *
   * optional bool hidden = 6;
   * @return The hidden.
   */
  boolean getHidden();

  /**
   *    * Hint that value for this option should not be
   * logged
   * 
   *
   * optional bool secret = 7;
   * @return Whether the secret field is set.
   */
  boolean hasSecret();
  /**
   *    * Hint that value for this option should not be
   * logged
   * 
   *
   * optional bool secret = 7;
   * @return The secret.
   */
  boolean getSecret();

  /**
   *    * Which version of this software this option was added.
   * Can be the Yamcs version, or the version of a plugin.  
   * 
   *
   * optional string versionAdded = 8;
   * @return Whether the versionAdded field is set.
   */
  boolean hasVersionAdded();
  /**
   *    * Which version of this software this option was added.
   * Can be the Yamcs version, or the version of a plugin.  
   * 
   *
   * optional string versionAdded = 8;
   * @return The versionAdded.
   */
  java.lang.String getVersionAdded();
  /**
   *    * Which version of this software this option was added.
   * Can be the Yamcs version, or the version of a plugin.  
   * 
   *
   * optional string versionAdded = 8;
   * @return The bytes for versionAdded.
   */
  com.google.protobuf.ByteString
      getVersionAddedBytes();

  /**
   *    * Deprecation message for this option
   * 
   *
   * optional string deprecationMessage = 9;
   * @return Whether the deprecationMessage field is set.
   */
  boolean hasDeprecationMessage();
  /**
   *    * Deprecation message for this option
   * 
   *
   * optional string deprecationMessage = 9;
   * @return The deprecationMessage.
   */
  java.lang.String getDeprecationMessage();
  /**
   *    * Deprecation message for this option
   * 
   *
   * optional string deprecationMessage = 9;
   * @return The bytes for deprecationMessage.
   */
  com.google.protobuf.ByteString
      getDeprecationMessageBytes();

  /**
   *    * Description, each list entry represents a paragraph
   * 
   *
   * repeated string description = 10;
   * @return A list containing the description.
   */
  java.util.List
      getDescriptionList();
  /**
   *    * Description, each list entry represents a paragraph
   * 
   *
   * repeated string description = 10;
   * @return The count of description.
   */
  int getDescriptionCount();
  /**
   *    * Description, each list entry represents a paragraph
   * 
   *
   * repeated string description = 10;
   * @param index The index of the element to return.
   * @return The description at the given index.
   */
  java.lang.String getDescription(int index);
  /**
   *    * Description, each list entry represents a paragraph
   * 
   *
   * repeated string description = 10;
   * @param index The index of the value to return.
   * @return The bytes of the description at the given index.
   */
  com.google.protobuf.ByteString
      getDescriptionBytes(int index);

  /**
   *    * When the type is ``LIST`` or ``LIST_OR_ELEMENT``, this indicates the type
   * of each element of that list
   * 
   *
   * optional .yamcs.protobuf.config.OptionType elementType = 11;
   * @return Whether the elementType field is set.
   */
  boolean hasElementType();
  /**
   *    * When the type is ``LIST`` or ``LIST_OR_ELEMENT``, this indicates the type
   * of each element of that list
   * 
   *
   * optional .yamcs.protobuf.config.OptionType elementType = 11;
   * @return The elementType.
   */
  org.yamcs.protobuf.config.OptionType getElementType();

  /**
   *    * When the type or elementType is ``MAP``, this specifies
   * the options with that map
   * 
   *
   * optional .yamcs.protobuf.config.SpecInfo spec = 12;
   * @return Whether the spec field is set.
   */
  boolean hasSpec();
  /**
   *    * When the type or elementType is ``MAP``, this specifies
   * the options with that map
   * 
   *
   * optional .yamcs.protobuf.config.SpecInfo spec = 12;
   * @return The spec.
   */
  org.yamcs.protobuf.config.SpecInfo getSpec();
  /**
   *    * When the type or elementType is ``MAP``, this specifies
   * the options with that map
   * 
   *
   * optional .yamcs.protobuf.config.SpecInfo spec = 12;
   */
  org.yamcs.protobuf.config.SpecInfoOrBuilder getSpecOrBuilder();

  /**
   *    * Allowed values for this option
   * 
   *
   * repeated .google.protobuf.Value choices = 13;
   */
  java.util.List 
      getChoicesList();
  /**
   *    * Allowed values for this option
   * 
   *
   * repeated .google.protobuf.Value choices = 13;
   */
  com.google.protobuf.Value getChoices(int index);
  /**
   *    * Allowed values for this option
   * 
   *
   * repeated .google.protobuf.Value choices = 13;
   */
  int getChoicesCount();
  /**
   *    * Allowed values for this option
   * 
   *
   * repeated .google.protobuf.Value choices = 13;
   */
  java.util.List 
      getChoicesOrBuilderList();
  /**
   *    * Allowed values for this option
   * 
   *
   * repeated .google.protobuf.Value choices = 13;
   */
  com.google.protobuf.ValueOrBuilder getChoicesOrBuilder(
      int index);

  /**
   *    * When the type is ``MAP``, this property determines whether default values
   * are generated even when a value for that option was not provided.
   * 
   *
   * optional bool applySpecDefaults = 14;
   * @return Whether the applySpecDefaults field is set.
   */
  boolean hasApplySpecDefaults();
  /**
   *    * When the type is ``MAP``, this property determines whether default values
   * are generated even when a value for that option was not provided.
   * 
   *
   * optional bool applySpecDefaults = 14;
   * @return The applySpecDefaults.
   */
  boolean getApplySpecDefaults();

  /**
   *    * Additional names that can be used for this option
   * 
   *
   * repeated string aliases = 15;
   * @return A list containing the aliases.
   */
  java.util.List
      getAliasesList();
  /**
   *    * Additional names that can be used for this option
   * 
   *
   * repeated string aliases = 15;
   * @return The count of aliases.
   */
  int getAliasesCount();
  /**
   *    * Additional names that can be used for this option
   * 
   *
   * repeated string aliases = 15;
   * @param index The index of the element to return.
   * @return The aliases at the given index.
   */
  java.lang.String getAliases(int index);
  /**
   *    * Additional names that can be used for this option
   * 
   *
   * repeated string aliases = 15;
   * @param index The index of the value to return.
   * @return The bytes of the aliases at the given index.
   */
  com.google.protobuf.ByteString
      getAliasesBytes(int index);
}