Package org.yamcs.protobuf

Interface ParameterSubscriptionRequestOrBuilder

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

  • Method Summary

    Modifier and Type
    Method
    Description
    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
    Yamcs.NamedObjectId
    getId(int index)
    repeated .yamcs.protobuf.NamedObjectId id = 1;
    int
    getIdCount()
    repeated .yamcs.protobuf.NamedObjectId id = 1;
    List<Yamcs.NamedObjectId>
    getIdList()
    repeated .yamcs.protobuf.NamedObjectId id = 1;
    Yamcs.NamedObjectIdOrBuilder
    getIdOrBuilder(int index)
    repeated .yamcs.protobuf.NamedObjectId id = 1;
    List<? extends Yamcs.NamedObjectIdOrBuilder>
    getIdOrBuilderList()
    repeated .yamcs.protobuf.NamedObjectId id = 1;
    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
    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
    boolean
    getUpdateOnExpiration()
    if set to true, send parameter updates when parameters expire.
    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
    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
    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
    boolean
    hasUpdateOnExpiration()
    if set to true, send parameter updates when parameters expire.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • getIdList

      List<Yamcs.NamedObjectId> getIdList()
      repeated .yamcs.protobuf.NamedObjectId id = 1;

    • getId

      Yamcs.NamedObjectId getId(int index)
      repeated .yamcs.protobuf.NamedObjectId id = 1;

    • getIdCount

      int getIdCount()
      repeated .yamcs.protobuf.NamedObjectId id = 1;

    • getIdOrBuilderList

      List<? extends Yamcs.NamedObjectIdOrBuilder> getIdOrBuilderList()
      repeated .yamcs.protobuf.NamedObjectId id = 1;

    • getIdOrBuilder

      Yamcs.NamedObjectIdOrBuilder getIdOrBuilder(int index)
      repeated .yamcs.protobuf.NamedObjectId id = 1;

    • hasAbortOnInvalid

      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;

    • getAbortOnInvalid

      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;

    • hasUpdateOnExpiration

      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;

    • getUpdateOnExpiration

      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;

    • hasSendFromCache

      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;

    • getSendFromCache

      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;

    • hasSubscriptionId

      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;

    • getSubscriptionId

      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;