org.yamcs.protobuf.activities.ActivityInfoOrBuilder 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/activities/activities.proto

package org.yamcs.protobuf.activities;

public interface ActivityInfoOrBuilder extends
    // @@protoc_insertion_point(interface_extends:yamcs.protobuf.activities.ActivityInfo)
    com.google.protobuf.MessageOrBuilder {

  /**
   *    * Activity identifier
   * 
   *
   * optional string id = 1;
   * @return Whether the id field is set.
   */
  boolean hasId();
  /**
   *    * Activity identifier
   * 
   *
   * optional string id = 1;
   * @return The id.
   */
  java.lang.String getId();
  /**
   *    * Activity identifier
   * 
   *
   * optional string id = 1;
   * @return The bytes for id.
   */
  com.google.protobuf.ByteString
      getIdBytes();

  /**
   *    * Start time of the activity
   * 
   *
   * optional .google.protobuf.Timestamp start = 2;
   * @return Whether the start field is set.
   */
  boolean hasStart();
  /**
   *    * Start time of the activity
   * 
   *
   * optional .google.protobuf.Timestamp start = 2;
   * @return The start.
   */
  com.google.protobuf.Timestamp getStart();
  /**
   *    * Start time of the activity
   * 
   *
   * optional .google.protobuf.Timestamp start = 2;
   */
  com.google.protobuf.TimestampOrBuilder getStartOrBuilder();

  /**
   *    * Differentiator in case of multiple activities
   * with the same start time
   * 
   *
   * optional uint32 seq = 3;
   * @return Whether the seq field is set.
   */
  boolean hasSeq();
  /**
   *    * Differentiator in case of multiple activities
   * with the same start time
   * 
   *
   * optional uint32 seq = 3;
   * @return The seq.
   */
  int getSeq();

  /**
   *    * Activity status
   * 
   *
   * optional .yamcs.protobuf.activities.ActivityStatus status = 4;
   * @return Whether the status field is set.
   */
  boolean hasStatus();
  /**
   *    * Activity status
   * 
   *
   * optional .yamcs.protobuf.activities.ActivityStatus status = 4;
   * @return The status.
   */
  org.yamcs.protobuf.activities.ActivityStatus getStatus();

  /**
   *    * User who started the run
   * 
   *
   * optional string startedBy = 5;
   * @return Whether the startedBy field is set.
   */
  boolean hasStartedBy();
  /**
   *    * User who started the run
   * 
   *
   * optional string startedBy = 5;
   * @return The startedBy.
   */
  java.lang.String getStartedBy();
  /**
   *    * User who started the run
   * 
   *
   * optional string startedBy = 5;
   * @return The bytes for startedBy.
   */
  com.google.protobuf.ByteString
      getStartedByBytes();

  /**
   *    * Activity type
   * 
   *
   * optional string type = 6;
   * @return Whether the type field is set.
   */
  boolean hasType();
  /**
   *    * Activity type
   * 
   *
   * optional string type = 6;
   * @return The type.
   */
  java.lang.String getType();
  /**
   *    * Activity type
   * 
   *
   * optional string type = 6;
   * @return The bytes for type.
   */
  com.google.protobuf.ByteString
      getTypeBytes();

  /**
   *    * Activity arguments
   * 
   *
   * optional .google.protobuf.Struct args = 7;
   * @return Whether the args field is set.
   */
  boolean hasArgs();
  /**
   *    * Activity arguments
   * 
   *
   * optional .google.protobuf.Struct args = 7;
   * @return The args.
   */
  com.google.protobuf.Struct getArgs();
  /**
   *    * Activity arguments
   * 
   *
   * optional .google.protobuf.Struct args = 7;
   */
  com.google.protobuf.StructOrBuilder getArgsOrBuilder();

  /**
   *    * Activity detail (short descriptive)
   * 
   *
   * optional string detail = 8;
   * @return Whether the detail field is set.
   */
  boolean hasDetail();
  /**
   *    * Activity detail (short descriptive)
   * 
   *
   * optional string detail = 8;
   * @return The detail.
   */
  java.lang.String getDetail();
  /**
   *    * Activity detail (short descriptive)
   * 
   *
   * optional string detail = 8;
   * @return The bytes for detail.
   */
  com.google.protobuf.ByteString
      getDetailBytes();

  /**
   *    * Stop time of the activity run
   * 
   *
   * optional .google.protobuf.Timestamp stop = 9;
   * @return Whether the stop field is set.
   */
  boolean hasStop();
  /**
   *    * Stop time of the activity run
   * 
   *
   * optional .google.protobuf.Timestamp stop = 9;
   * @return The stop.
   */
  com.google.protobuf.Timestamp getStop();
  /**
   *    * Stop time of the activity run
   * 
   *
   * optional .google.protobuf.Timestamp stop = 9;
   */
  com.google.protobuf.TimestampOrBuilder getStopOrBuilder();

  /**
   *    * User who stopped the run. Only set if the activity
   * was manually stopped
   * 
   *
   * optional string stoppedBy = 10;
   * @return Whether the stoppedBy field is set.
   */
  boolean hasStoppedBy();
  /**
   *    * User who stopped the run. Only set if the activity
   * was manually stopped
   * 
   *
   * optional string stoppedBy = 10;
   * @return The stoppedBy.
   */
  java.lang.String getStoppedBy();
  /**
   *    * User who stopped the run. Only set if the activity
   * was manually stopped
   * 
   *
   * optional string stoppedBy = 10;
   * @return The bytes for stoppedBy.
   */
  com.google.protobuf.ByteString
      getStoppedByBytes();

  /**
   *    * If set, the activity is stopped, but failed
   * 
   *
   * optional string failureReason = 11;
   * @return Whether the failureReason field is set.
   */
  boolean hasFailureReason();
  /**
   *    * If set, the activity is stopped, but failed
   * 
   *
   * optional string failureReason = 11;
   * @return The failureReason.
   */
  java.lang.String getFailureReason();
  /**
   *    * If set, the activity is stopped, but failed
   * 
   *
   * optional string failureReason = 11;
   * @return The bytes for failureReason.
   */
  com.google.protobuf.ByteString
      getFailureReasonBytes();
}