Class IssueCommandRequest

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable, IssueCommandRequestOrBuilder

    public final class IssueCommandRequest
    extends com.google.protobuf.GeneratedMessageV3
    implements IssueCommandRequestOrBuilder
    Protobuf type yamcs.protobuf.commanding.IssueCommandRequest
    See Also:
    Serialized Form
    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3
      • getUnknownFields

        public final com.google.protobuf.UnknownFieldSet getUnknownFields()
        Specified by:
        getUnknownFields in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getUnknownFields in class com.google.protobuf.GeneratedMessageV3
      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
      • internalGetMapField

        protected com.google.protobuf.MapField internalGetMapField​(int number)
        Overrides:
        internalGetMapField in class com.google.protobuf.GeneratedMessageV3
      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3
      • hasInstance

        public boolean hasInstance()
         Yamcs instance name.
         
        optional string instance = 6;
        Specified by:
        hasInstance in interface IssueCommandRequestOrBuilder
        Returns:
        Whether the instance field is set.
      • getInstanceBytes

        public com.google.protobuf.ByteString getInstanceBytes()
         Yamcs instance name.
         
        optional string instance = 6;
        Specified by:
        getInstanceBytes in interface IssueCommandRequestOrBuilder
        Returns:
        The bytes for instance.
      • hasProcessor

        public boolean hasProcessor()
         Processor name.
         
        optional string processor = 7;
        Specified by:
        hasProcessor in interface IssueCommandRequestOrBuilder
        Returns:
        Whether the processor field is set.
      • getProcessorBytes

        public com.google.protobuf.ByteString getProcessorBytes()
         Processor name.
         
        optional string processor = 7;
        Specified by:
        getProcessorBytes in interface IssueCommandRequestOrBuilder
        Returns:
        The bytes for processor.
      • hasName

        public boolean hasName()
         Command name.
         
        optional string name = 8;
        Specified by:
        hasName in interface IssueCommandRequestOrBuilder
        Returns:
        Whether the name field is set.
      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         Command name.
         
        optional string name = 8;
        Specified by:
        getNameBytes in interface IssueCommandRequestOrBuilder
        Returns:
        The bytes for name.
      • hasArgs

        public boolean hasArgs()
         The name/value assignments for this command.
         
        optional .google.protobuf.Struct args = 16;
        Specified by:
        hasArgs in interface IssueCommandRequestOrBuilder
        Returns:
        Whether the args field is set.
      • getArgs

        public com.google.protobuf.Struct getArgs()
         The name/value assignments for this command.
         
        optional .google.protobuf.Struct args = 16;
        Specified by:
        getArgs in interface IssueCommandRequestOrBuilder
        Returns:
        The args.
      • getArgsOrBuilder

        public com.google.protobuf.StructOrBuilder getArgsOrBuilder()
         The name/value assignments for this command.
         
        optional .google.protobuf.Struct args = 16;
        Specified by:
        getArgsOrBuilder in interface IssueCommandRequestOrBuilder
      • getAssignmentCount

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

        public boolean hasOrigin()
         The origin of the command. Typically a hostname.
         
        optional string origin = 2;
        Specified by:
        hasOrigin in interface IssueCommandRequestOrBuilder
        Returns:
        Whether the origin field is set.
      • getOriginBytes

        public com.google.protobuf.ByteString getOriginBytes()
         The origin of the command. Typically a hostname.
         
        optional string origin = 2;
        Specified by:
        getOriginBytes in interface IssueCommandRequestOrBuilder
        Returns:
        The bytes for origin.
      • hasSequenceNumber

        public 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;
        Specified by:
        hasSequenceNumber in interface IssueCommandRequestOrBuilder
        Returns:
        Whether the sequenceNumber field is set.
      • getSequenceNumber

        public 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;
        Specified by:
        getSequenceNumber in interface IssueCommandRequestOrBuilder
        Returns:
        The sequenceNumber.
      • hasDryRun

        public 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;
        Specified by:
        hasDryRun in interface IssueCommandRequestOrBuilder
        Returns:
        Whether the dryRun field is set.
      • getDryRun

        public 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;
        Specified by:
        getDryRun in interface IssueCommandRequestOrBuilder
        Returns:
        The dryRun.
      • hasComment

        public boolean hasComment()
         Comment attached to this command.
         
        optional string comment = 5;
        Specified by:
        hasComment in interface IssueCommandRequestOrBuilder
        Returns:
        Whether the comment field is set.
      • getCommentBytes

        public com.google.protobuf.ByteString getCommentBytes()
         Comment attached to this command.
         
        optional string comment = 5;
        Specified by:
        getCommentBytes in interface IssueCommandRequestOrBuilder
        Returns:
        The bytes for comment.
      • hasStream

        public boolean hasStream()
         Override the stream on which the command should be sent out.
         Requires elevated privilege.
         
        optional string stream = 11;
        Specified by:
        hasStream in interface IssueCommandRequestOrBuilder
        Returns:
        Whether the stream field is set.
      • getStream

        public String getStream()
         Override the stream on which the command should be sent out.
         Requires elevated privilege.
         
        optional string stream = 11;
        Specified by:
        getStream in interface IssueCommandRequestOrBuilder
        Returns:
        The stream.
      • getStreamBytes

        public com.google.protobuf.ByteString getStreamBytes()
         Override the stream on which the command should be sent out.
         Requires elevated privilege.
         
        optional string stream = 11;
        Specified by:
        getStreamBytes in interface IssueCommandRequestOrBuilder
        Returns:
        The bytes for stream.
      • hasDisableTransmissionConstraints

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

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

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

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

        public boolean containsVerifierConfig​(String key)
         Override verifier configuration. Keyed by verifier name
         Requires elevated privilege.
         
        map<string, .yamcs.protobuf.commanding.VerifierConfig> verifierConfig = 14;
        Specified by:
        containsVerifierConfig in interface IssueCommandRequestOrBuilder
      • getExtraCount

        public int getExtraCount()
        Description copied from interface: IssueCommandRequestOrBuilder
         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;
        Specified by:
        getExtraCount in interface IssueCommandRequestOrBuilder
      • containsExtra

        public 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;
        Specified by:
        containsExtra in interface IssueCommandRequestOrBuilder
      • getExtraMap

        public 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;
        Specified by:
        getExtraMap in interface IssueCommandRequestOrBuilder
      • getExtraOrThrow

        public 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;
        Specified by:
        getExtraOrThrow in interface IssueCommandRequestOrBuilder
      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3
      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
                     throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException
      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3
      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage
      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage
      • parseFrom

        public static IssueCommandRequest parseFrom​(ByteBuffer data)
                                             throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static IssueCommandRequest parseFrom​(ByteBuffer data,
                                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                             throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static IssueCommandRequest parseFrom​(com.google.protobuf.ByteString data)
                                             throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static IssueCommandRequest parseFrom​(com.google.protobuf.ByteString data,
                                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                             throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static IssueCommandRequest parseFrom​(byte[] data)
                                             throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static IssueCommandRequest parseFrom​(byte[] data,
                                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                             throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static IssueCommandRequest parseFrom​(com.google.protobuf.CodedInputStream input,
                                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                             throws IOException
        Throws:
        IOException
      • newBuilderForType

        public IssueCommandRequest.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite
      • toBuilder

        public IssueCommandRequest.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite
      • newBuilderForType

        protected IssueCommandRequest.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3
      • getParserForType

        public com.google.protobuf.Parser<IssueCommandRequest> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3
      • getDefaultInstanceForType

        public IssueCommandRequest getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder