Package org.yamcs.protobuf

Interface AlgorithmStatusOrBuilder

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

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    getActive()
    true if the algorithm is active
    int
    getErrorCount()
    how many times the algorithm ran with errors
    String
    getErrorMessage()
    Error message in case the algorithm produced an error.
    com.google.protobuf.ByteString
    getErrorMessageBytes()
    Error message in case the algorithm produced an error.
    com.google.protobuf.Timestamp
    getErrorTime()
    Error time in case the algorithm produced an error.
    com.google.protobuf.TimestampOrBuilder
    getErrorTimeOrBuilder()
    Error time in case the algorithm produced an error.
    long
    getExecTimeNs()
    total execution time in nanoseconds
    com.google.protobuf.Timestamp
    getLastRun()
    when the algorithm was last run
    com.google.protobuf.TimestampOrBuilder
    getLastRunOrBuilder()
    when the algorithm was last run
    int
    getRunCount()
    how many times the algorithm ran (successfully or with error)
    boolean
    getTraceEnabled()
    true if the tracing has been enabled
    boolean
    hasActive()
    true if the algorithm is active
    boolean
    hasErrorCount()
    how many times the algorithm ran with errors
    boolean
    hasErrorMessage()
    Error message in case the algorithm produced an error.
    boolean
    hasErrorTime()
    Error time in case the algorithm produced an error.
    boolean
    hasExecTimeNs()
    total execution time in nanoseconds
    boolean
    hasLastRun()
    when the algorithm was last run
    boolean
    hasRunCount()
    how many times the algorithm ran (successfully or with error)
    boolean
    hasTraceEnabled()
    true if the tracing has been enabled

    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

    • hasActive

      boolean hasActive()
      true if the algorithm is active
      optional bool active = 1;
      Returns:
      Whether the active field is set.

    • getActive

      boolean getActive()
      true if the algorithm is active
      optional bool active = 1;
      Returns:
      The active.

    • hasTraceEnabled

      boolean hasTraceEnabled()
      true if the tracing has been enabled
      optional bool traceEnabled = 2;
      Returns:
      Whether the traceEnabled field is set.

    • getTraceEnabled

      boolean getTraceEnabled()
      true if the tracing has been enabled
      optional bool traceEnabled = 2;
      Returns:
      The traceEnabled.

    • hasRunCount

      boolean hasRunCount()
       how many times the algorithm ran (successfully or with error)
      optional uint32 runCount = 3;
      Returns:
      Whether the runCount field is set.

    • getRunCount

      int getRunCount()
       how many times the algorithm ran (successfully or with error)
      optional uint32 runCount = 3;
      Returns:
      The runCount.

    • hasLastRun

      boolean hasLastRun()
       when the algorithm was last run
      optional .google.protobuf.Timestamp lastRun = 4;
      Returns:
      Whether the lastRun field is set.

    • getLastRun

      com.google.protobuf.Timestamp getLastRun()
       when the algorithm was last run
      optional .google.protobuf.Timestamp lastRun = 4;
      Returns:
      The lastRun.

    • getLastRunOrBuilder

      com.google.protobuf.TimestampOrBuilder getLastRunOrBuilder()
       when the algorithm was last run
      optional .google.protobuf.Timestamp lastRun = 4;

    • hasErrorCount

      boolean hasErrorCount()
       how many times the algorithm ran with errors
      optional uint32 errorCount = 5;
      Returns:
      Whether the errorCount field is set.

    • getErrorCount

      int getErrorCount()
       how many times the algorithm ran with errors
      optional uint32 errorCount = 5;
      Returns:
      The errorCount.

    • hasErrorMessage

      boolean hasErrorMessage()
       Error message in case the algorithm produced an error.
      optional string errorMessage = 6;
      Returns:
      Whether the errorMessage field is set.

    • getErrorMessage

      String getErrorMessage()
       Error message in case the algorithm produced an error.
      optional string errorMessage = 6;
      Returns:
      The errorMessage.

    • getErrorMessageBytes

      com.google.protobuf.ByteString getErrorMessageBytes()
       Error message in case the algorithm produced an error.
      optional string errorMessage = 6;
      Returns:
      The bytes for errorMessage.

    • hasErrorTime

      boolean hasErrorTime()
       Error time in case the algorithm produced an error.
      optional .google.protobuf.Timestamp errorTime = 7;
      Returns:
      Whether the errorTime field is set.

    • getErrorTime

      com.google.protobuf.Timestamp getErrorTime()
       Error time in case the algorithm produced an error.
      optional .google.protobuf.Timestamp errorTime = 7;
      Returns:
      The errorTime.

    • getErrorTimeOrBuilder

      com.google.protobuf.TimestampOrBuilder getErrorTimeOrBuilder()
       Error time in case the algorithm produced an error.
      optional .google.protobuf.Timestamp errorTime = 7;

    • hasExecTimeNs

      boolean hasExecTimeNs()
      total execution time in nanoseconds
      optional uint64 execTimeNs = 8;
      Returns:
      Whether the execTimeNs field is set.

    • getExecTimeNs

      long getExecTimeNs()
      total execution time in nanoseconds
      optional uint64 execTimeNs = 8;
      Returns:
      The execTimeNs.