Module org.yamcs.api
Package org.yamcs.protobuf

Interface IssueCommandRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
IssueCommandRequest, IssueCommandRequest.Builder
public interface IssueCommandRequestOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • hasInstance

      boolean hasInstance()
       Yamcs instance name.
      optional string instance = 6;
      Returns:
      Whether the instance field is set.

    • getInstance

      String getInstance()
       Yamcs instance name.
      optional string instance = 6;
      Returns:
      The instance.

    • getInstanceBytes

      com.google.protobuf.ByteString getInstanceBytes()
       Yamcs instance name.
      optional string instance = 6;
      Returns:
      The bytes for instance.

    • hasProcessor

      boolean hasProcessor()
       Processor name.
      optional string processor = 7;
      Returns:
      Whether the processor field is set.

    • getProcessor

      String getProcessor()
       Processor name.
      optional string processor = 7;
      Returns:
      The processor.

    • getProcessorBytes

      com.google.protobuf.ByteString getProcessorBytes()
       Processor name.
      optional string processor = 7;
      Returns:
      The bytes for processor.

    • hasName

      boolean hasName()
       Command name.
      optional string name = 8;
      Returns:
      Whether the name field is set.

    • getName

      String getName()
       Command name.
      optional string name = 8;
      Returns:
      The name.

    • getNameBytes

      com.google.protobuf.ByteString getNameBytes()
       Command name.
      optional string name = 8;
      Returns:
      The bytes for name.

    • hasArgs

      boolean hasArgs()
       The name/value assignments for this command.
      optional .google.protobuf.Struct args = 16;
      Returns:
      Whether the args field is set.

    • getArgs

      com.google.protobuf.Struct getArgs()
       The name/value assignments for this command.
      optional .google.protobuf.Struct args = 16;
      Returns:
      The args.

    • getArgsOrBuilder

      com.google.protobuf.StructOrBuilder getArgsOrBuilder()
       The name/value assignments for this command.
      optional .google.protobuf.Struct args = 16;

    • getAssignmentList

      @Deprecated List<IssueCommandRequest.Assignment> getAssignmentList()
      Deprecated.
       The name/value assignments for this command.
 Deprecated: use ``args`` instead.
      repeated .yamcs.protobuf.commanding.IssueCommandRequest.Assignment assignment = 1 [deprecated = true];

    • getAssignment

      @Deprecated IssueCommandRequest.Assignment getAssignment(int index)
      Deprecated.
       The name/value assignments for this command.
 Deprecated: use ``args`` instead.
      repeated .yamcs.protobuf.commanding.IssueCommandRequest.Assignment assignment = 1 [deprecated = true];

    • getAssignmentCount

      @Deprecated int getAssignmentCount()
      Deprecated.
       The name/value assignments for this command.
 Deprecated: use ``args`` instead.
      repeated .yamcs.protobuf.commanding.IssueCommandRequest.Assignment assignment = 1 [deprecated = true];

    • getAssignmentOrBuilderList

      @Deprecated List<? extends IssueCommandRequest.AssignmentOrBuilder> getAssignmentOrBuilderList()
      Deprecated.
       The name/value assignments for this command.
 Deprecated: use ``args`` instead.
      repeated .yamcs.protobuf.commanding.IssueCommandRequest.Assignment assignment = 1 [deprecated = true];

    • getAssignmentOrBuilder

      @Deprecated IssueCommandRequest.AssignmentOrBuilder getAssignmentOrBuilder(int index)
      Deprecated.
       The name/value assignments for this command.
 Deprecated: use ``args`` instead.
      repeated .yamcs.protobuf.commanding.IssueCommandRequest.Assignment assignment = 1 [deprecated = true];

    • hasOrigin

      boolean hasOrigin()
       The origin of the command. Typically a hostname.
      optional string origin = 2;
      Returns:
      Whether the origin field is set.

    • getOrigin

      String getOrigin()
       The origin of the command. Typically a hostname.
      optional string origin = 2;
      Returns:
      The origin.

    • getOriginBytes

      com.google.protobuf.ByteString getOriginBytes()
       The origin of the command. Typically a hostname.
      optional string origin = 2;
      Returns:
      The bytes for origin.

    • hasSequenceNumber

      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;
      Returns:
      Whether the sequenceNumber field is set.

    • getSequenceNumber

      int getSequenceNumber()
       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;
      Returns:
      The sequenceNumber.

    • hasDryRun

      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;
      Returns:
      Whether the dryRun field is set.

    • getDryRun

      boolean getDryRun()
       Whether a response will be returned without actually issuing
 the command. This is useful when debugging commands.
 Default ``no``
      optional bool dryRun = 4;
      Returns:
      The dryRun.

    • hasComment

      boolean hasComment()
       Comment attached to this command.
      optional string comment = 5;
      Returns:
      Whether the comment field is set.

    • getComment

      String getComment()
       Comment attached to this command.
      optional string comment = 5;
      Returns:
      The comment.

    • getCommentBytes

      com.google.protobuf.ByteString getCommentBytes()
       Comment attached to this command.
      optional string comment = 5;
      Returns:
      The bytes for comment.

    • hasStream

      boolean hasStream()
       Override the stream on which the command should be sent out.
 Requires elevated privilege.
      optional string stream = 11;
      Returns:
      Whether the stream field is set.

    • getStream

      String getStream()
       Override the stream on which the command should be sent out.
 Requires elevated privilege.
      optional string stream = 11;
      Returns:
      The stream.

    • getStreamBytes

      com.google.protobuf.ByteString getStreamBytes()
       Override the stream on which the command should be sent out.
 Requires elevated privilege.
      optional string stream = 11;
      Returns:
      The bytes for stream.

    • hasDisableTransmissionConstraints

      boolean hasDisableTransmissionConstraints()
       Disable verification of all transmission constrains (if any
 specified in the MDB).
 Requires elevated privilege.
      optional bool disableTransmissionConstraints = 12;
      Returns:
      Whether the disableTransmissionConstraints field is set.

    • getDisableTransmissionConstraints

      boolean getDisableTransmissionConstraints()
       Disable verification of all transmission constrains (if any
 specified in the MDB).
 Requires elevated privilege.
      optional bool disableTransmissionConstraints = 12;
      Returns:
      The disableTransmissionConstraints.

    • hasDisableVerifiers

      boolean hasDisableVerifiers()
       Disable all post transmission verifiers (if any specified in the MDB)
 Requires elevated privilege.
      optional bool disableVerifiers = 13;
      Returns:
      Whether the disableVerifiers field is set.

    • getDisableVerifiers

      boolean getDisableVerifiers()
       Disable all post transmission verifiers (if any specified in the MDB)
 Requires elevated privilege.
      optional bool disableVerifiers = 13;
      Returns:
      The disableVerifiers.

    • getVerifierConfigCount

      int getVerifierConfigCount()
       Override verifier configuration. Keyed by verifier name
 Requires elevated privilege.
      map<string, .yamcs.protobuf.commanding.VerifierConfig> verifierConfig = 14;

    • containsVerifierConfig

      boolean containsVerifierConfig(String key)
       Override verifier configuration. Keyed by verifier name
 Requires elevated privilege.
      map<string, .yamcs.protobuf.commanding.VerifierConfig> verifierConfig = 14;

    • getVerifierConfig

      @Deprecated Map<String,Commanding.VerifierConfig> getVerifierConfig()
      Deprecated.
      Use getVerifierConfigMap() instead.

    • getVerifierConfigMap

      Map<String,Commanding.VerifierConfig> getVerifierConfigMap()
       Override verifier configuration. Keyed by verifier name
 Requires elevated privilege.
      map<string, .yamcs.protobuf.commanding.VerifierConfig> verifierConfig = 14;

    • getVerifierConfigOrDefault

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

    • getVerifierConfigOrThrow

      Commanding.VerifierConfig getVerifierConfigOrThrow(String key)
       Override verifier configuration. Keyed by verifier name
 Requires elevated privilege.
      map<string, .yamcs.protobuf.commanding.VerifierConfig> verifierConfig = 14;

    • getExtraCount

      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;

    • containsExtra

      boolean containsExtra(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;

    • getExtra

      @Deprecated Map<String,Yamcs.Value> getExtra()
      Deprecated.
      Use getExtraMap() instead.

    • getExtraMap

      Map<String,Yamcs.Value> 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;

    • getExtraOrDefault

      Yamcs.Value getExtraOrDefault(String key, 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;

    • getExtraOrThrow

      Yamcs.Value getExtraOrThrow(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;