Package org.yamcs.protobuf

Class ParameterSubscriptionRequest.Builder

    • Method Detail

      • 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.Builder<ParameterSubscriptionRequest.Builder>

      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<ParameterSubscriptionRequest.Builder>

      • getDefaultInstanceForType

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

      • build

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

      • buildPartial

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

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<ParameterSubscriptionRequest.Builder>

      • mergeFrom

        public ParameterSubscriptionRequest.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                               throws IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ParameterSubscriptionRequest.Builder>
        Throws:
        IOException

      • 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

      • setAbortOnInvalid

        public ParameterSubscriptionRequest.Builder setAbortOnInvalid​(boolean value)
        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;

      • clearAbortOnInvalid

        public ParameterSubscriptionRequest.Builder clearAbortOnInvalid()
        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;

      • 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

      • setUpdateOnExpiration

        public ParameterSubscriptionRequest.Builder setUpdateOnExpiration​(boolean value)
         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;

      • clearUpdateOnExpiration

        public ParameterSubscriptionRequest.Builder clearUpdateOnExpiration()
         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;

      • 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

      • setSendFromCache

        public ParameterSubscriptionRequest.Builder setSendFromCache​(boolean value)
        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;

      • clearSendFromCache

        public ParameterSubscriptionRequest.Builder clearSendFromCache()
        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;

      • 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

      • setSubscriptionId

        public ParameterSubscriptionRequest.Builder setSubscriptionId​(int value)
        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;

      • clearSubscriptionId

        public ParameterSubscriptionRequest.Builder clearSubscriptionId()
        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;