org.yamcs.protobuf.CreateInstanceRequestOrBuilder 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_service.proto

package org.yamcs.protobuf;

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

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

  /**
   *    * **Required.** The name of the template for this instance.
   * 
   *
   * optional string template = 2;
   * @return Whether the template field is set.
   */
  boolean hasTemplate();
  /**
   *    * **Required.** The name of the template for this instance.
   * 
   *
   * optional string template = 2;
   * @return The template.
   */
  java.lang.String getTemplate();
  /**
   *    * **Required.** The name of the template for this instance.
   * 
   *
   * optional string template = 2;
   * @return The bytes for template.
   */
  com.google.protobuf.ByteString
      getTemplateBytes();

  /**
   *    * Arguments for substitution in the template definition. Each entry is
   * keyed by the argument name. The value must be a string.
   * 
   *
   * map<string, string> templateArgs = 3;
   */
  int getTemplateArgsCount();
  /**
   *    * Arguments for substitution in the template definition. Each entry is
   * keyed by the argument name. The value must be a string.
   * 
   *
   * map<string, string> templateArgs = 3;
   */
  boolean containsTemplateArgs(
      java.lang.String key);
  /**
   * Use {@link #getTemplateArgsMap()} instead.
   */
  @java.lang.Deprecated
  java.util.Map
  getTemplateArgs();
  /**
   *    * Arguments for substitution in the template definition. Each entry is
   * keyed by the argument name. The value must be a string.
   * 
   *
   * map<string, string> templateArgs = 3;
   */
  java.util.Map
  getTemplateArgsMap();
  /**
   *    * Arguments for substitution in the template definition. Each entry is
   * keyed by the argument name. The value must be a string.
   * 
   *
   * map<string, string> templateArgs = 3;
   */

  java.lang.String getTemplateArgsOrDefault(
      java.lang.String key,
      java.lang.String defaultValue);
  /**
   *    * Arguments for substitution in the template definition. Each entry is
   * keyed by the argument name. The value must be a string.
   * 
   *
   * map<string, string> templateArgs = 3;
   */

  java.lang.String getTemplateArgsOrThrow(
      java.lang.String key);

  /**
   *    * Labels assigned to this instance. Each entry is keyed by the tag name
   * of the label. The value represent the label value for that tag.
   * 
   *
   * map<string, string> labels = 4;
   */
  int getLabelsCount();
  /**
   *    * Labels assigned to this instance. Each entry is keyed by the tag name
   * of the label. The value represent the label value for that tag.
   * 
   *
   * map<string, string> labels = 4;
   */
  boolean containsLabels(
      java.lang.String key);
  /**
   * Use {@link #getLabelsMap()} instead.
   */
  @java.lang.Deprecated
  java.util.Map
  getLabels();
  /**
   *    * Labels assigned to this instance. Each entry is keyed by the tag name
   * of the label. The value represent the label value for that tag.
   * 
   *
   * map<string, string> labels = 4;
   */
  java.util.Map
  getLabelsMap();
  /**
   *    * Labels assigned to this instance. Each entry is keyed by the tag name
   * of the label. The value represent the label value for that tag.
   * 
   *
   * map<string, string> labels = 4;
   */

  java.lang.String getLabelsOrDefault(
      java.lang.String key,
      java.lang.String defaultValue);
  /**
   *    * Labels assigned to this instance. Each entry is keyed by the tag name
   * of the label. The value represent the label value for that tag.
   * 
   *
   * map<string, string> labels = 4;
   */

  java.lang.String getLabelsOrThrow(
      java.lang.String key);
}