org.yamcs.protobuf.AlgorithmStatusOrBuilder 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 AlgorithmStatusOrBuilder extends
    // @@protoc_insertion_point(interface_extends:yamcs.protobuf.processing.AlgorithmStatus)
    com.google.protobuf.MessageOrBuilder {

  /**
   *    *true if the algorithm is active
   * 
   *
   * optional bool active = 1;
   * @return Whether the active field is set.
   */
  boolean hasActive();
  /**
   *    *true if the algorithm is active
   * 
   *
   * optional bool active = 1;
   * @return The active.
   */
  boolean getActive();

  /**
   *    *true if the tracing has been enabled 
   * 
   *
   * optional bool traceEnabled = 2;
   * @return Whether the traceEnabled field is set.
   */
  boolean hasTraceEnabled();
  /**
   *    *true if the tracing has been enabled 
   * 
   *
   * optional bool traceEnabled = 2;
   * @return The traceEnabled.
   */
  boolean getTraceEnabled();

  /**
   *    * how many times the algorithm ran (successfully or with error)
   * 
   *
   * optional uint32 runCount = 3;
   * @return Whether the runCount field is set.
   */
  boolean hasRunCount();
  /**
   *    * how many times the algorithm ran (successfully or with error)
   * 
   *
   * optional uint32 runCount = 3;
   * @return The runCount.
   */
  int getRunCount();

  /**
   *    * when the algorithm was last run
   * 
   *
   * optional .google.protobuf.Timestamp lastRun = 4;
   * @return Whether the lastRun field is set.
   */
  boolean hasLastRun();
  /**
   *    * when the algorithm was last run
   * 
   *
   * optional .google.protobuf.Timestamp lastRun = 4;
   * @return The lastRun.
   */
  com.google.protobuf.Timestamp getLastRun();
  /**
   *    * when the algorithm was last run
   * 
   *
   * optional .google.protobuf.Timestamp lastRun = 4;
   */
  com.google.protobuf.TimestampOrBuilder getLastRunOrBuilder();

  /**
   *    * how many times the algorithm ran with errors
   * 
   *
   * optional uint32 errorCount = 5;
   * @return Whether the errorCount field is set.
   */
  boolean hasErrorCount();
  /**
   *    * how many times the algorithm ran with errors
   * 
   *
   * optional uint32 errorCount = 5;
   * @return The errorCount.
   */
  int getErrorCount();

  /**
   *    * if the algorithm produced an error, 
   * the fields below contain the error message and the time when the error was raised 
   * 
   *
   * optional string errorMessage = 6;
   * @return Whether the errorMessage field is set.
   */
  boolean hasErrorMessage();
  /**
   *    * if the algorithm produced an error, 
   * the fields below contain the error message and the time when the error was raised 
   * 
   *
   * optional string errorMessage = 6;
   * @return The errorMessage.
   */
  java.lang.String getErrorMessage();
  /**
   *    * if the algorithm produced an error, 
   * the fields below contain the error message and the time when the error was raised 
   * 
   *
   * optional string errorMessage = 6;
   * @return The bytes for errorMessage.
   */
  com.google.protobuf.ByteString
      getErrorMessageBytes();

  /**
   * optional .google.protobuf.Timestamp errorTime = 7;
   * @return Whether the errorTime field is set.
   */
  boolean hasErrorTime();
  /**
   * optional .google.protobuf.Timestamp errorTime = 7;
   * @return The errorTime.
   */
  com.google.protobuf.Timestamp getErrorTime();
  /**
   * optional .google.protobuf.Timestamp errorTime = 7;
   */
  com.google.protobuf.TimestampOrBuilder getErrorTimeOrBuilder();

  /**
   *    *total execution time in nanoseconds
   * 
   *
   * optional uint64 execTimeNs = 8;
   * @return Whether the execTimeNs field is set.
   */
  boolean hasExecTimeNs();
  /**
   *    *total execution time in nanoseconds
   * 
   *
   * optional uint64 execTimeNs = 8;
   * @return The execTimeNs.
   */
  long getExecTimeNs();
}