org.yamcs.protobuf.IssueCommandRequestOrBuilder 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/commanding/commands_service.proto

package org.yamcs.protobuf;

public interface IssueCommandRequestOrBuilder extends
    // @@protoc_insertion_point(interface_extends:yamcs.protobuf.commanding.IssueCommandRequest)
    com.google.protobuf.MessageOrBuilder {

  /**
   *    * Yamcs instance name
   * 
   *
   * optional string instance = 6;
   * @return Whether the instance field is set.
   */
  boolean hasInstance();
  /**
   *    * Yamcs instance name
   * 
   *
   * optional string instance = 6;
   * @return The instance.
   */
  java.lang.String getInstance();
  /**
   *    * Yamcs instance name
   * 
   *
   * optional string instance = 6;
   * @return The bytes for instance.
   */
  com.google.protobuf.ByteString
      getInstanceBytes();

  /**
   *    * Processor name
   * 
   *
   * optional string processor = 7;
   * @return Whether the processor field is set.
   */
  boolean hasProcessor();
  /**
   *    * Processor name
   * 
   *
   * optional string processor = 7;
   * @return The processor.
   */
  java.lang.String getProcessor();
  /**
   *    * Processor name
   * 
   *
   * optional string processor = 7;
   * @return The bytes for processor.
   */
  com.google.protobuf.ByteString
      getProcessorBytes();

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

  /**
   *    * The name/value assignments for this command.
   * 
   *
   * optional .google.protobuf.Struct args = 16;
   * @return Whether the args field is set.
   */
  boolean hasArgs();
  /**
   *    * The name/value assignments for this command.
   * 
   *
   * optional .google.protobuf.Struct args = 16;
   * @return The args.
   */
  com.google.protobuf.Struct getArgs();
  /**
   *    * The name/value assignments for this command.
   * 
   *
   * optional .google.protobuf.Struct args = 16;
   */
  com.google.protobuf.StructOrBuilder getArgsOrBuilder();

  /**
   *    * The origin of the command. Typically a hostname.
   * 
   *
   * optional string origin = 2;
   * @return Whether the origin field is set.
   */
  boolean hasOrigin();
  /**
   *    * The origin of the command. Typically a hostname.
   * 
   *
   * optional string origin = 2;
   * @return The origin.
   */
  java.lang.String getOrigin();
  /**
   *    * The origin of the command. Typically a hostname.
   * 
   *
   * optional string origin = 2;
   * @return The bytes for origin.
   */
  com.google.protobuf.ByteString
      getOriginBytes();

  /**
   *    * The sequence number as specified by the origin. This gets
   * communicated back in command history and command queue entries,
   * thereby allowing clients to map local with remote command
   * identities.
   * 
   *
   * optional int32 sequenceNumber = 3;
   * @return Whether the sequenceNumber field is set.
   */
  boolean hasSequenceNumber();
  /**
   *    * The sequence number as specified by the origin. This gets
   * communicated back in command history and command queue entries,
   * thereby allowing clients to map local with remote command
   * identities.
   * 
   *
   * optional int32 sequenceNumber = 3;
   * @return The sequenceNumber.
   */
  int getSequenceNumber();

  /**
   *    * Whether a response will be returned without actually issuing
   * the command. This is useful when debugging commands.
   * Default ``no``
   * 
   *
   * optional bool dryRun = 4;
   * @return Whether the dryRun field is set.
   */
  boolean hasDryRun();
  /**
   *    * Whether a response will be returned without actually issuing
   * the command. This is useful when debugging commands.
   * Default ``no``
   * 
   *
   * optional bool dryRun = 4;
   * @return The dryRun.
   */
  boolean getDryRun();

  /**
   *    * Comment attached to this command.
   * 
   *
   * optional string comment = 5;
   * @return Whether the comment field is set.
   */
  boolean hasComment();
  /**
   *    * Comment attached to this command.
   * 
   *
   * optional string comment = 5;
   * @return The comment.
   */
  java.lang.String getComment();
  /**
   *    * Comment attached to this command.
   * 
   *
   * optional string comment = 5;
   * @return The bytes for comment.
   */
  com.google.protobuf.ByteString
      getCommentBytes();

  /**
   *    * Override the stream on which the command should be sent out.
   * Requires elevated privilege.
   * 
   *
   * optional string stream = 11;
   * @return Whether the stream field is set.
   */
  boolean hasStream();
  /**
   *    * Override the stream on which the command should be sent out.
   * Requires elevated privilege.
   * 
   *
   * optional string stream = 11;
   * @return The stream.
   */
  java.lang.String getStream();
  /**
   *    * Override the stream on which the command should be sent out.
   * Requires elevated privilege.
   * 
   *
   * optional string stream = 11;
   * @return The bytes for stream.
   */
  com.google.protobuf.ByteString
      getStreamBytes();

  /**
   *    * Disable verification of all transmission constrains (if any
   * specified in the MDB).
   * Requires elevated privilege.
   * 
   *
   * optional bool disableTransmissionConstraints = 12;
   * @return Whether the disableTransmissionConstraints field is set.
   */
  boolean hasDisableTransmissionConstraints();
  /**
   *    * Disable verification of all transmission constrains (if any
   * specified in the MDB).
   * Requires elevated privilege.
   * 
   *
   * optional bool disableTransmissionConstraints = 12;
   * @return The disableTransmissionConstraints.
   */
  boolean getDisableTransmissionConstraints();

  /**
   *    * Disable all post transmission verifiers (if any specified in the MDB)
   * Requires elevated privilege.
   * 
   *
   * optional bool disableVerifiers = 13;
   * @return Whether the disableVerifiers field is set.
   */
  boolean hasDisableVerifiers();
  /**
   *    * Disable all post transmission verifiers (if any specified in the MDB)
   * Requires elevated privilege.
   * 
   *
   * optional bool disableVerifiers = 13;
   * @return The disableVerifiers.
   */
  boolean getDisableVerifiers();

  /**
   *    * Override verifier configuration. Keyed by verifier name
   * Requires elevated privilege.
   * 
   *
   * map<string, .yamcs.protobuf.commanding.VerifierConfig> verifierConfig = 14;
   */
  int getVerifierConfigCount();
  /**
   *    * Override verifier configuration. Keyed by verifier name
   * Requires elevated privilege.
   * 
   *
   * map<string, .yamcs.protobuf.commanding.VerifierConfig> verifierConfig = 14;
   */
  boolean containsVerifierConfig(
      java.lang.String key);
  /**
   * Use {@link #getVerifierConfigMap()} instead.
   */
  @java.lang.Deprecated
  java.util.Map
  getVerifierConfig();
  /**
   *    * Override verifier configuration. Keyed by verifier name
   * Requires elevated privilege.
   * 
   *
   * map<string, .yamcs.protobuf.commanding.VerifierConfig> verifierConfig = 14;
   */
  java.util.Map
  getVerifierConfigMap();
  /**
   *    * Override verifier configuration. Keyed by verifier name
   * Requires elevated privilege.
   * 
   *
   * map<string, .yamcs.protobuf.commanding.VerifierConfig> verifierConfig = 14;
   */

  org.yamcs.protobuf.Commanding.VerifierConfig getVerifierConfigOrDefault(
      java.lang.String key,
      org.yamcs.protobuf.Commanding.VerifierConfig defaultValue);
  /**
   *    * Override verifier configuration. Keyed by verifier name
   * Requires elevated privilege.
   * 
   *
   * map<string, .yamcs.protobuf.commanding.VerifierConfig> verifierConfig = 14;
   */

  org.yamcs.protobuf.Commanding.VerifierConfig getVerifierConfigOrThrow(
      java.lang.String key);

  /**
   *    * Specify custom options for interpretation by non-core extensions.
   * Extensions must register these options against org.yamcs.YamcsServer
   * 
   *
   * map<string, .yamcs.protobuf.Value> extra = 15;
   */
  int getExtraCount();
  /**
   *    * Specify custom options for interpretation by non-core extensions.
   * Extensions must register these options against org.yamcs.YamcsServer
   * 
   *
   * map<string, .yamcs.protobuf.Value> extra = 15;
   */
  boolean containsExtra(
      java.lang.String key);
  /**
   * Use {@link #getExtraMap()} instead.
   */
  @java.lang.Deprecated
  java.util.Map
  getExtra();
  /**
   *    * Specify custom options for interpretation by non-core extensions.
   * Extensions must register these options against org.yamcs.YamcsServer
   * 
   *
   * map<string, .yamcs.protobuf.Value> extra = 15;
   */
  java.util.Map
  getExtraMap();
  /**
   *    * Specify custom options for interpretation by non-core extensions.
   * Extensions must register these options against org.yamcs.YamcsServer
   * 
   *
   * map<string, .yamcs.protobuf.Value> extra = 15;
   */

  org.yamcs.protobuf.Yamcs.Value getExtraOrDefault(
      java.lang.String key,
      org.yamcs.protobuf.Yamcs.Value defaultValue);
  /**
   *    * Specify custom options for interpretation by non-core extensions.
   * Extensions must register these options against org.yamcs.YamcsServer
   * 
   *
   * map<string, .yamcs.protobuf.Value> extra = 15;
   */

  org.yamcs.protobuf.Yamcs.Value getExtraOrThrow(
      java.lang.String key);
}