Package org.yamcs.protobuf

Class SubscribeParametersRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
org.yamcs.protobuf.SubscribeParametersRequest
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable, SubscribeParametersRequestOrBuilder
public final class SubscribeParametersRequest extends com.google.protobuf.GeneratedMessageV3 implements SubscribeParametersRequestOrBuilder
 Request message for `SubscribeParameters`.
Protobuf type yamcs.protobuf.processing.SubscribeParametersRequest
See Also:

  • Field Details

  • Method Details

    • 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()

    • 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 = 1;
      Specified by:
      hasInstance in interface SubscribeParametersRequestOrBuilder
      Returns:
      Whether the instance field is set.

    • getInstance

      public String getInstance()
       Yamcs instance name
      optional string instance = 1;
      Specified by:
      getInstance in interface SubscribeParametersRequestOrBuilder
      Returns:
      The instance.

    • getInstanceBytes

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

    • hasProcessor

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

    • getProcessor

      public String getProcessor()
       Processor name
      optional string processor = 2;
      Specified by:
      getProcessor in interface SubscribeParametersRequestOrBuilder
      Returns:
      The processor.

    • getProcessorBytes

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

    • getIdList

      public List<Yamcs.NamedObjectId> getIdList()
       Parameter identifiers. Each identifier takes the form of
 a namespace and a name.
 For Yamcs-native naming only the name field is required and
 should be the fully qualified name. The namespace is only
 required when the name represents an alias of that parameter.
      repeated .yamcs.protobuf.NamedObjectId id = 3;
      Specified by:
      getIdList in interface SubscribeParametersRequestOrBuilder

    • getIdOrBuilderList

      public List<? extends Yamcs.NamedObjectIdOrBuilder> getIdOrBuilderList()
       Parameter identifiers. Each identifier takes the form of
 a namespace and a name.
 For Yamcs-native naming only the name field is required and
 should be the fully qualified name. The namespace is only
 required when the name represents an alias of that parameter.
      repeated .yamcs.protobuf.NamedObjectId id = 3;
      Specified by:
      getIdOrBuilderList in interface SubscribeParametersRequestOrBuilder

    • getIdCount

      public int getIdCount()
       Parameter identifiers. Each identifier takes the form of
 a namespace and a name.
 For Yamcs-native naming only the name field is required and
 should be the fully qualified name. The namespace is only
 required when the name represents an alias of that parameter.
      repeated .yamcs.protobuf.NamedObjectId id = 3;
      Specified by:
      getIdCount in interface SubscribeParametersRequestOrBuilder

    • getId

      public Yamcs.NamedObjectId getId(int index)
       Parameter identifiers. Each identifier takes the form of
 a namespace and a name.
 For Yamcs-native naming only the name field is required and
 should be the fully qualified name. The namespace is only
 required when the name represents an alias of that parameter.
      repeated .yamcs.protobuf.NamedObjectId id = 3;
      Specified by:
      getId in interface SubscribeParametersRequestOrBuilder

    • getIdOrBuilder

      public Yamcs.NamedObjectIdOrBuilder getIdOrBuilder(int index)
       Parameter identifiers. Each identifier takes the form of
 a namespace and a name.
 For Yamcs-native naming only the name field is required and
 should be the fully qualified name. The namespace is only
 required when the name represents an alias of that parameter.
      repeated .yamcs.protobuf.NamedObjectId id = 3;
      Specified by:
      getIdOrBuilder in interface SubscribeParametersRequestOrBuilder

    • hasAbortOnInvalid

      public boolean hasAbortOnInvalid()
       Send an error message if any parameter is invalid.
 Default: true
      optional bool abortOnInvalid = 4;
      Specified by:
      hasAbortOnInvalid in interface SubscribeParametersRequestOrBuilder
      Returns:
      Whether the abortOnInvalid field is set.

    • getAbortOnInvalid

      public boolean getAbortOnInvalid()
       Send an error message if any parameter is invalid.
 Default: true
      optional bool abortOnInvalid = 4;
      Specified by:
      getAbortOnInvalid in interface SubscribeParametersRequestOrBuilder
      Returns:
      The abortOnInvalid.

    • hasUpdateOnExpiration

      public boolean hasUpdateOnExpiration()
       Send parameter updates when parameters expire.
 The update will have the same value and timestamp like
 the preceding update, but with acquisition status set to
 EXPIRED (instead of ACQUIRED)
 Default: false
      optional bool updateOnExpiration = 5;
      Specified by:
      hasUpdateOnExpiration in interface SubscribeParametersRequestOrBuilder
      Returns:
      Whether the updateOnExpiration field is set.

    • getUpdateOnExpiration

      public boolean getUpdateOnExpiration()
       Send parameter updates when parameters expire.
 The update will have the same value and timestamp like
 the preceding update, but with acquisition status set to
 EXPIRED (instead of ACQUIRED)
 Default: false
      optional bool updateOnExpiration = 5;
      Specified by:
      getUpdateOnExpiration in interface SubscribeParametersRequestOrBuilder
      Returns:
      The updateOnExpiration.

    • hasSendFromCache

      public boolean hasSendFromCache()
       If available, send immediately the last cached value
 of each subscribed parameter.
 Default: true
      optional bool sendFromCache = 6;
      Specified by:
      hasSendFromCache in interface SubscribeParametersRequestOrBuilder
      Returns:
      Whether the sendFromCache field is set.

    • getSendFromCache

      public boolean getSendFromCache()
       If available, send immediately the last cached value
 of each subscribed parameter.
 Default: true
      optional bool sendFromCache = 6;
      Specified by:
      getSendFromCache in interface SubscribeParametersRequestOrBuilder
      Returns:
      The sendFromCache.

    • hasAction

      public boolean hasAction()
       How to interpret the submitted parameter ids. Default
 is to replace an existing subscription with the newly
 submitted list.
      optional .yamcs.protobuf.processing.SubscribeParametersRequest.Action action = 7;
      Specified by:
      hasAction in interface SubscribeParametersRequestOrBuilder
      Returns:
      Whether the action field is set.

    • getAction

      public SubscribeParametersRequest.Action getAction()
       How to interpret the submitted parameter ids. Default
 is to replace an existing subscription with the newly
 submitted list.
      optional .yamcs.protobuf.processing.SubscribeParametersRequest.Action action = 7;
      Specified by:
      getAction in interface SubscribeParametersRequestOrBuilder
      Returns:
      The action.

    • hasMaxBytes

      public boolean hasMaxBytes()
       If set, truncate binary values to the specified byte length.
 This may be necessary when Yamcs contains large binary values.
 A negative value implies no truncating, which is the default.
      optional int32 maxBytes = 8;
      Specified by:
      hasMaxBytes in interface SubscribeParametersRequestOrBuilder
      Returns:
      Whether the maxBytes field is set.

    • getMaxBytes

      public int getMaxBytes()
       If set, truncate binary values to the specified byte length.
 This may be necessary when Yamcs contains large binary values.
 A negative value implies no truncating, which is the default.
      optional int32 maxBytes = 8;
      Specified by:
      getMaxBytes in interface SubscribeParametersRequestOrBuilder
      Returns:
      The maxBytes.

    • 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 SubscribeParametersRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

      public static SubscribeParametersRequest parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static SubscribeParametersRequest parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static SubscribeParametersRequest parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static SubscribeParametersRequest parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static SubscribeParametersRequest parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static SubscribeParametersRequest parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static SubscribeParametersRequest parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

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

    • newBuilder

      public static SubscribeParametersRequest.Builder newBuilder()

    • newBuilder

      public static SubscribeParametersRequest.Builder newBuilder(SubscribeParametersRequest prototype)

    • toBuilder

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

    • newBuilderForType

      protected SubscribeParametersRequest.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static SubscribeParametersRequest getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<SubscribeParametersRequest> parser()

    • getParserForType

      public com.google.protobuf.Parser<SubscribeParametersRequest> 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 SubscribeParametersRequest getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder