Module org.yamcs.api
Package org.yamcs.protobuf.activities

Interface ActivityDefinitionInfoOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
ActivityDefinitionInfo, ActivityDefinitionInfo.Builder
public interface ActivityDefinitionInfoOrBuilder 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
    getDescription()
    Human-readable description of the essence of this activity.
    com.google.protobuf.ByteString
    getDescriptionBytes()
    Human-readable description of the essence of this activity.
    String
    getLabel()
    Optional label.
    com.google.protobuf.ByteString
    getLabelBytes()
    Optional label.
    String
    getType()
    Activity type.
    com.google.protobuf.ByteString
    getTypeBytes()
    Activity type.
    boolean
    hasArgs()
    Activity arguments.
    boolean
    hasDescription()
    Human-readable description of the essence of this activity.
    boolean
    hasLabel()
    Optional label.
    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

    • hasType

      boolean hasType()
       Activity type.
 Common types: MANUAL, SCRIPT, COMMAND, STACK
      optional string type = 1;
      Returns:
      Whether the type field is set.

    • getType

      String getType()
       Activity type.
 Common types: MANUAL, SCRIPT, COMMAND, STACK
      optional string type = 1;
      Returns:
      The type.

    • getTypeBytes

      com.google.protobuf.ByteString getTypeBytes()
       Activity type.
 Common types: MANUAL, SCRIPT, COMMAND, STACK
      optional string type = 1;
      Returns:
      The bytes for type.

    • hasArgs

      boolean hasArgs()
       Activity arguments. The expected arguments
 are different for each activity type
      optional .google.protobuf.Struct args = 2;
      Returns:
      Whether the args field is set.

    • getArgs

      com.google.protobuf.Struct getArgs()
       Activity arguments. The expected arguments
 are different for each activity type
      optional .google.protobuf.Struct args = 2;
      Returns:
      The args.

    • getArgsOrBuilder

      com.google.protobuf.StructOrBuilder getArgsOrBuilder()
       Activity arguments. The expected arguments
 are different for each activity type
      optional .google.protobuf.Struct args = 2;

    • hasLabel

      boolean hasLabel()
       Optional label.
 Keep short. Used in Yamcs Timeline charts.
      optional string label = 3;
      Returns:
      Whether the label field is set.

    • getLabel

      String getLabel()
       Optional label.
 Keep short. Used in Yamcs Timeline charts.
      optional string label = 3;
      Returns:
      The label.

    • getLabelBytes

      com.google.protobuf.ByteString getLabelBytes()
       Optional label.
 Keep short. Used in Yamcs Timeline charts.
      optional string label = 3;
      Returns:
      The bytes for label.

    • hasDescription

      boolean hasDescription()
       Human-readable description of the essence of this activity.
 For example, for a script this would be the name of the script.
 This is an output field only.
      optional string description = 4;
      Returns:
      Whether the description field is set.

    • getDescription

      String getDescription()
       Human-readable description of the essence of this activity.
 For example, for a script this would be the name of the script.
 This is an output field only.
      optional string description = 4;
      Returns:
      The description.

    • getDescriptionBytes

      com.google.protobuf.ByteString getDescriptionBytes()
       Human-readable description of the essence of this activity.
 For example, for a script this would be the name of the script.
 This is an output field only.
      optional string description = 4;
      Returns:
      The bytes for description.