org.yamcs.protobuf.SubscribeParametersRequestOrBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of yamcs-api Show documentation
Used by external clients to communicate with Yamcs
There is a newer version: 5.10.9
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: yamcs/protobuf/processing/processing.proto

package org.yamcs.protobuf;

public interface SubscribeParametersRequestOrBuilder extends
    // @@protoc_insertion_point(interface_extends:yamcs.protobuf.processing.SubscribeParametersRequest)
    com.google.protobuf.MessageOrBuilder {

  /**
   *    * Yamcs instance name
   * 
   *
   * optional string instance = 1;
   * @return Whether the instance field is set.
   */
  boolean hasInstance();
  /**
   *    * Yamcs instance name
   * 
   *
   * optional string instance = 1;
   * @return The instance.
   */
  java.lang.String getInstance();
  /**
   *    * Yamcs instance name
   * 
   *
   * optional string instance = 1;
   * @return The bytes for instance.
   */
  com.google.protobuf.ByteString
      getInstanceBytes();

  /**
   *    * Processor name
   * 
   *
   * optional string processor = 2;
   * @return Whether the processor field is set.
   */
  boolean hasProcessor();
  /**
   *    * Processor name
   * 
   *
   * optional string processor = 2;
   * @return The processor.
   */
  java.lang.String getProcessor();
  /**
   *    * Processor name
   * 
   *
   * optional string processor = 2;
   * @return The bytes for processor.
   */
  com.google.protobuf.ByteString
      getProcessorBytes();

  /**
   *    * 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;
   */
  java.util.List 
      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;
   */
  org.yamcs.protobuf.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;
   */
  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;
   */
  java.util.List 
      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;
   */
  org.yamcs.protobuf.Yamcs.NamedObjectIdOrBuilder getIdOrBuilder(
      int index);

  /**
   *    * Send an error message if any parameter is invalid.
   * Default: true
   * 
   *
   * optional bool abortOnInvalid = 4;
   * @return Whether the abortOnInvalid field is set.
   */
  boolean hasAbortOnInvalid();
  /**
   *    * Send an error message if any parameter is invalid.
   * Default: true
   * 
   *
   * optional bool abortOnInvalid = 4;
   * @return The abortOnInvalid.
   */
  boolean getAbortOnInvalid();

  /**
   *    * 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;
   * @return Whether the updateOnExpiration field is set.
   */
  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;
   * @return The updateOnExpiration.
   */
  boolean getUpdateOnExpiration();

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

  /**
   *    * 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;
   * @return Whether the action field is set.
   */
  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;
   * @return The action.
   */
  org.yamcs.protobuf.SubscribeParametersRequest.Action getAction();

  /**
   *    * 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;
   * @return Whether the maxBytes field is set.
   */
  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;
   * @return The maxBytes.
   */
  int getMaxBytes();
}