Package org.yamcs.protobuf

Class ParameterSubscriptionRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
org.yamcs.protobuf.ParameterSubscriptionRequest
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable, ParameterSubscriptionRequestOrBuilder
public final class ParameterSubscriptionRequest extends com.google.protobuf.GeneratedMessageV3 implements ParameterSubscriptionRequestOrBuilder
Protobuf type yamcs.protobuf.web.ParameterSubscriptionRequest
See Also:

  • Field Details

  • Method Details

    • 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

    • getIdList

      public List<Yamcs.NamedObjectId> getIdList()
      repeated .yamcs.protobuf.NamedObjectId id = 1;
      Specified by:
      getIdList in interface ParameterSubscriptionRequestOrBuilder

    • getIdOrBuilderList

      public List<? extends Yamcs.NamedObjectIdOrBuilder> getIdOrBuilderList()
      repeated .yamcs.protobuf.NamedObjectId id = 1;
      Specified by:
      getIdOrBuilderList in interface ParameterSubscriptionRequestOrBuilder

    • getIdCount

      public int getIdCount()
      repeated .yamcs.protobuf.NamedObjectId id = 1;
      Specified by:
      getIdCount in interface ParameterSubscriptionRequestOrBuilder

    • getId

      public Yamcs.NamedObjectId getId(int index)
      repeated .yamcs.protobuf.NamedObjectId id = 1;
      Specified by:
      getId in interface ParameterSubscriptionRequestOrBuilder

    • getIdOrBuilder

      public Yamcs.NamedObjectIdOrBuilder getIdOrBuilder(int index)
      repeated .yamcs.protobuf.NamedObjectId id = 1;
      Specified by:
      getIdOrBuilder in interface ParameterSubscriptionRequestOrBuilder

    • hasAbortOnInvalid

      public boolean hasAbortOnInvalid()
      if set to true, an error message will be sent back if any parameter from the list above is invalid
 by default is false
      optional bool abortOnInvalid = 2;
      Specified by:
      hasAbortOnInvalid in interface ParameterSubscriptionRequestOrBuilder

    • getAbortOnInvalid

      public boolean getAbortOnInvalid()
      if set to true, an error message will be sent back if any parameter from the list above is invalid
 by default is false
      optional bool abortOnInvalid = 2;
      Specified by:
      getAbortOnInvalid in interface ParameterSubscriptionRequestOrBuilder

    • hasUpdateOnExpiration

      public boolean hasUpdateOnExpiration()
       if set to true, send parameter updates when parameters expire.
 the parameter will have the same value and timestamp like the previous sent one, but the acquisition status will be set to EXPIRED (instead of ACQUIRED)
by default is false
      optional bool updateOnExpiration = 3;
      Specified by:
      hasUpdateOnExpiration in interface ParameterSubscriptionRequestOrBuilder

    • getUpdateOnExpiration

      public boolean getUpdateOnExpiration()
       if set to true, send parameter updates when parameters expire.
 the parameter will have the same value and timestamp like the previous sent one, but the acquisition status will be set to EXPIRED (instead of ACQUIRED)
by default is false
      optional bool updateOnExpiration = 3;
      Specified by:
      getUpdateOnExpiration in interface ParameterSubscriptionRequestOrBuilder

    • hasSendFromCache

      public boolean hasSendFromCache()
      if set to true (default), send a first batch of the parameters from cache if available
 otherwise just wait for the parameters to be updated
      optional bool sendFromCache = 4;
      Specified by:
      hasSendFromCache in interface ParameterSubscriptionRequestOrBuilder

    • getSendFromCache

      public boolean getSendFromCache()
      if set to true (default), send a first batch of the parameters from cache if available
 otherwise just wait for the parameters to be updated
      optional bool sendFromCache = 4;
      Specified by:
      getSendFromCache in interface ParameterSubscriptionRequestOrBuilder

    • hasSubscriptionId

      public boolean hasSubscriptionId()
      subcriptionId
  0 or not specified means to add parameters to the first subscription made
     this is for compatibility with the previous yamcs version before 4.1 
     when it was not possible to have multiple subscriptions   
 -1 means to create a new subscription
 >1 means to add parameters to the existing subcription with that id
      optional int32 subscriptionId = 5;
      Specified by:
      hasSubscriptionId in interface ParameterSubscriptionRequestOrBuilder

    • getSubscriptionId

      public int getSubscriptionId()
      subcriptionId
  0 or not specified means to add parameters to the first subscription made
     this is for compatibility with the previous yamcs version before 4.1 
     when it was not possible to have multiple subscriptions   
 -1 means to create a new subscription
 >1 means to add parameters to the existing subcription with that id
      optional int32 subscriptionId = 5;
      Specified by:
      getSubscriptionId in interface ParameterSubscriptionRequestOrBuilder

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static ParameterSubscriptionRequest.Builder newBuilder()

    • newBuilder

      public static ParameterSubscriptionRequest.Builder newBuilder(ParameterSubscriptionRequest prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static ParameterSubscriptionRequest getDefaultInstance()

    • parser

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

    • getParserForType

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