Package org.yamcs.protobuf.activities

Interface ActivityInfoOrBuilder

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

  • Method Summary

    Modifier and Type
    Method
    Description
    com.google.protobuf.Struct
    getArgs()
    Activity arguments
    com.google.protobuf.StructOrBuilder
    getArgsOrBuilder()
    Activity arguments
    String
    getDetail()
    Activity detail (short descriptive)
    com.google.protobuf.ByteString
    getDetailBytes()
    Activity detail (short descriptive)
    String
    getFailureReason()
    If set, the activity is stopped, but failed
    com.google.protobuf.ByteString
    getFailureReasonBytes()
    If set, the activity is stopped, but failed
    String
    getId()
    Activity identifier
    com.google.protobuf.ByteString
    getIdBytes()
    Activity identifier
    String
    getLabel()
    Label for display in Yamcs Timeline charts
    com.google.protobuf.ByteString
    getLabelBytes()
    Label for display in Yamcs Timeline charts
    int
    getSeq()
    Differentiator in case of multiple activities with the same start time
    com.google.protobuf.Timestamp
    getStart()
    Start time of the activity
    String
    getStartedBy()
    User who started the run
    com.google.protobuf.ByteString
    getStartedByBytes()
    User who started the run
    com.google.protobuf.TimestampOrBuilder
    getStartOrBuilder()
    Start time of the activity
    ActivityStatus
    getStatus()
    Activity status
    com.google.protobuf.Timestamp
    getStop()
    Stop time of the activity run
    com.google.protobuf.TimestampOrBuilder
    getStopOrBuilder()
    Stop time of the activity run
    String
    getStoppedBy()
    User who stopped the run.
    com.google.protobuf.ByteString
    getStoppedByBytes()
    User who stopped the run.
    String
    getType()
    Activity type
    com.google.protobuf.ByteString
    getTypeBytes()
    Activity type
    boolean
    hasArgs()
    Activity arguments
    boolean
    hasDetail()
    Activity detail (short descriptive)
    boolean
    hasFailureReason()
    If set, the activity is stopped, but failed
    boolean
    hasId()
    Activity identifier
    boolean
    hasLabel()
    Label for display in Yamcs Timeline charts
    boolean
    hasSeq()
    Differentiator in case of multiple activities with the same start time
    boolean
    hasStart()
    Start time of the activity
    boolean
    hasStartedBy()
    User who started the run
    boolean
    hasStatus()
    Activity status
    boolean
    hasStop()
    Stop time of the activity run
    boolean
    hasStoppedBy()
    User who stopped the run.
    boolean
    hasType()
    Activity type

    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

    • hasId

      boolean hasId()
       Activity identifier
      optional string id = 1;
      Returns:
      Whether the id field is set.

    • getId

      String getId()
       Activity identifier
      optional string id = 1;
      Returns:
      The id.

    • getIdBytes

      com.google.protobuf.ByteString getIdBytes()
       Activity identifier
      optional string id = 1;
      Returns:
      The bytes for id.

    • hasStart

      boolean hasStart()
       Start time of the activity
      optional .google.protobuf.Timestamp start = 2;
      Returns:
      Whether the start field is set.

    • getStart

      com.google.protobuf.Timestamp getStart()
       Start time of the activity
      optional .google.protobuf.Timestamp start = 2;
      Returns:
      The start.

    • getStartOrBuilder

      com.google.protobuf.TimestampOrBuilder getStartOrBuilder()
       Start time of the activity
      optional .google.protobuf.Timestamp start = 2;

    • hasSeq

      boolean hasSeq()
       Differentiator in case of multiple activities
 with the same start time
      optional uint32 seq = 3;
      Returns:
      Whether the seq field is set.

    • getSeq

      int getSeq()
       Differentiator in case of multiple activities
 with the same start time
      optional uint32 seq = 3;
      Returns:
      The seq.

    • hasStatus

      boolean hasStatus()
       Activity status
      optional .yamcs.protobuf.activities.ActivityStatus status = 4;
      Returns:
      Whether the status field is set.

    • getStatus

      ActivityStatus getStatus()
       Activity status
      optional .yamcs.protobuf.activities.ActivityStatus status = 4;
      Returns:
      The status.

    • hasStartedBy

      boolean hasStartedBy()
       User who started the run
      optional string startedBy = 5;
      Returns:
      Whether the startedBy field is set.

    • getStartedBy

      String getStartedBy()
       User who started the run
      optional string startedBy = 5;
      Returns:
      The startedBy.

    • getStartedByBytes

      com.google.protobuf.ByteString getStartedByBytes()
       User who started the run
      optional string startedBy = 5;
      Returns:
      The bytes for startedBy.

    • hasType

      boolean hasType()
       Activity type
      optional string type = 6;
      Returns:
      Whether the type field is set.

    • getType

      String getType()
       Activity type
      optional string type = 6;
      Returns:
      The type.

    • getTypeBytes

      com.google.protobuf.ByteString getTypeBytes()
       Activity type
      optional string type = 6;
      Returns:
      The bytes for type.

    • hasArgs

      boolean hasArgs()
       Activity arguments
      optional .google.protobuf.Struct args = 7;
      Returns:
      Whether the args field is set.

    • getArgs

      com.google.protobuf.Struct getArgs()
       Activity arguments
      optional .google.protobuf.Struct args = 7;
      Returns:
      The args.

    • getArgsOrBuilder

      com.google.protobuf.StructOrBuilder getArgsOrBuilder()
       Activity arguments
      optional .google.protobuf.Struct args = 7;

    • hasLabel

      boolean hasLabel()
       Label for display in Yamcs Timeline charts
      optional string label = 12;
      Returns:
      Whether the label field is set.

    • getLabel

      String getLabel()
       Label for display in Yamcs Timeline charts
      optional string label = 12;
      Returns:
      The label.

    • getLabelBytes

      com.google.protobuf.ByteString getLabelBytes()
       Label for display in Yamcs Timeline charts
      optional string label = 12;
      Returns:
      The bytes for label.

    • hasDetail

      boolean hasDetail()
       Activity detail (short descriptive)
      optional string detail = 8;
      Returns:
      Whether the detail field is set.

    • getDetail

      String getDetail()
       Activity detail (short descriptive)
      optional string detail = 8;
      Returns:
      The detail.

    • getDetailBytes

      com.google.protobuf.ByteString getDetailBytes()
       Activity detail (short descriptive)
      optional string detail = 8;
      Returns:
      The bytes for detail.

    • hasStop

      boolean hasStop()
       Stop time of the activity run
      optional .google.protobuf.Timestamp stop = 9;
      Returns:
      Whether the stop field is set.

    • getStop

      com.google.protobuf.Timestamp getStop()
       Stop time of the activity run
      optional .google.protobuf.Timestamp stop = 9;
      Returns:
      The stop.

    • getStopOrBuilder

      com.google.protobuf.TimestampOrBuilder getStopOrBuilder()
       Stop time of the activity run
      optional .google.protobuf.Timestamp stop = 9;

    • hasStoppedBy

      boolean hasStoppedBy()
       User who stopped the run. Only set if the activity
 was manually stopped
      optional string stoppedBy = 10;
      Returns:
      Whether the stoppedBy field is set.

    • getStoppedBy

      String getStoppedBy()
       User who stopped the run. Only set if the activity
 was manually stopped
      optional string stoppedBy = 10;
      Returns:
      The stoppedBy.

    • getStoppedByBytes

      com.google.protobuf.ByteString getStoppedByBytes()
       User who stopped the run. Only set if the activity
 was manually stopped
      optional string stoppedBy = 10;
      Returns:
      The bytes for stoppedBy.

    • hasFailureReason

      boolean hasFailureReason()
       If set, the activity is stopped, but failed
      optional string failureReason = 11;
      Returns:
      Whether the failureReason field is set.

    • getFailureReason

      String getFailureReason()
       If set, the activity is stopped, but failed
      optional string failureReason = 11;
      Returns:
      The failureReason.

    • getFailureReasonBytes

      com.google.protobuf.ByteString getFailureReasonBytes()
       If set, the activity is stopped, but failed
      optional string failureReason = 11;
      Returns:
      The bytes for failureReason.