Module org.yamcs.api
Package org.yamcs.protobuf

Interface SubscribeParametersRequestOrBuilder

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

  • Method Details

    • hasInstance

      boolean hasInstance()
       Yamcs instance name.
      optional string instance = 1;
      Returns:
      Whether the instance field is set.

    • getInstance

      String getInstance()
       Yamcs instance name.
      optional string instance = 1;
      Returns:
      The instance.

    • getInstanceBytes

      com.google.protobuf.ByteString getInstanceBytes()
       Yamcs instance name.
      optional string instance = 1;
      Returns:
      The bytes for instance.

    • hasProcessor

      boolean hasProcessor()
       Processor name.
      optional string processor = 2;
      Returns:
      Whether the processor field is set.

    • getProcessor

      String getProcessor()
       Processor name.
      optional string processor = 2;
      Returns:
      The processor.

    • getProcessorBytes

      com.google.protobuf.ByteString getProcessorBytes()
       Processor name.
      optional string processor = 2;
      Returns:
      The bytes for processor.

    • getIdList

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

    • getId

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

    • getIdCount

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

    • getIdOrBuilderList

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

    • getIdOrBuilder

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

    • hasAbortOnInvalid

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

    • getAbortOnInvalid

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

    • hasUpdateOnExpiration

      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;
      Returns:
      Whether the updateOnExpiration field is set.

    • getUpdateOnExpiration

      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;
      Returns:
      The updateOnExpiration.

    • hasSendFromCache

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

    • getSendFromCache

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

    • hasAction

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

    • getAction

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