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

Interface TimelineItemOrBuilder

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

  • Method Details

    • hasId

      boolean hasId()
       Item identifier.
 The identifier is assigned by the source that created the item.
 It is possible but unlikely for two items coming from two different
 sources to have the same identifier.
 - The "rdb" source sets the id to a UUID. 
 ` The "commands" source sets the id to the command id
      optional string id = 1;
      Returns:
      Whether the id field is set.

    • getId

      String getId()
       Item identifier.
 The identifier is assigned by the source that created the item.
 It is possible but unlikely for two items coming from two different
 sources to have the same identifier.
 - The "rdb" source sets the id to a UUID. 
 ` The "commands" source sets the id to the command id
      optional string id = 1;
      Returns:
      The id.

    • getIdBytes

      com.google.protobuf.ByteString getIdBytes()
       Item identifier.
 The identifier is assigned by the source that created the item.
 It is possible but unlikely for two items coming from two different
 sources to have the same identifier.
 - The "rdb" source sets the id to a UUID. 
 ` The "commands" source sets the id to the command id
      optional string id = 1;
      Returns:
      The bytes for id.

    • hasName

      boolean hasName()
       Human-readable name of this item
      optional string name = 2;
      Returns:
      Whether the name field is set.

    • getName

      String getName()
       Human-readable name of this item
      optional string name = 2;
      Returns:
      The name.

    • getNameBytes

      com.google.protobuf.ByteString getNameBytes()
       Human-readable name of this item
      optional string name = 2;
      Returns:
      The bytes for name.

    • hasType

      boolean hasType()
      optional .yamcs.protobuf.timeline.TimelineItemType type = 3;
      Returns:
      Whether the type field is set.

    • getType

      TimelineItemType getType()
      optional .yamcs.protobuf.timeline.TimelineItemType type = 3;
      Returns:
      The type.

    • hasStart

      boolean hasStart()
       Absolute start time of the item (computed by the server when
 `relativeTime` is used).
      optional .google.protobuf.Timestamp start = 4;
      Returns:
      Whether the start field is set.

    • getStart

      com.google.protobuf.Timestamp getStart()
       Absolute start time of the item (computed by the server when
 `relativeTime` is used).
      optional .google.protobuf.Timestamp start = 4;
      Returns:
      The start.

    • getStartOrBuilder

      com.google.protobuf.TimestampOrBuilder getStartOrBuilder()
       Absolute start time of the item (computed by the server when
 `relativeTime` is used).
      optional .google.protobuf.Timestamp start = 4;

    • hasDuration

      boolean hasDuration()
      optional .google.protobuf.Duration duration = 5;
      Returns:
      Whether the duration field is set.

    • getDuration

      com.google.protobuf.Duration getDuration()
      optional .google.protobuf.Duration duration = 5;
      Returns:
      The duration.

    • getDurationOrBuilder

      com.google.protobuf.DurationOrBuilder getDurationOrBuilder()
      optional .google.protobuf.Duration duration = 5;

    • getTagsList

      List<String> getTagsList()
      repeated string tags = 6;
      Returns:
      A list containing the tags.

    • getTagsCount

      int getTagsCount()
      repeated string tags = 6;
      Returns:
      The count of tags.

    • getTags

      String getTags(int index)
      repeated string tags = 6;
      Parameters:
      index - The index of the element to return.
      Returns:
      The tags at the given index.

    • getTagsBytes

      com.google.protobuf.ByteString getTagsBytes(int index)
      repeated string tags = 6;
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the tags at the given index.

    • hasGroupId

      boolean hasGroupId()
       If this item belongs to a group, this is the group identifier
      optional string groupId = 7;
      Returns:
      Whether the groupId field is set.

    • getGroupId

      String getGroupId()
       If this item belongs to a group, this is the group identifier
      optional string groupId = 7;
      Returns:
      The groupId.

    • getGroupIdBytes

      com.google.protobuf.ByteString getGroupIdBytes()
       If this item belongs to a group, this is the group identifier
      optional string groupId = 7;
      Returns:
      The bytes for groupId.

    • hasRelativeTime

      boolean hasRelativeTime()
       If this item time specification is relative to another item, `relativeTime`
 contains a reference to that item as well as the relative start (the duration
 is the same as the `duration` field).
 Note that start of the item is computed by the server based on the
 `relativeTime` before sending the item to the client.
      optional .yamcs.protobuf.timeline.RelativeTime relativeTime = 8;
      Returns:
      Whether the relativeTime field is set.

    • getRelativeTime

      RelativeTime getRelativeTime()
       If this item time specification is relative to another item, `relativeTime`
 contains a reference to that item as well as the relative start (the duration
 is the same as the `duration` field).
 Note that start of the item is computed by the server based on the
 `relativeTime` before sending the item to the client.
      optional .yamcs.protobuf.timeline.RelativeTime relativeTime = 8;
      Returns:
      The relativeTime.

    • getRelativeTimeOrBuilder

      RelativeTimeOrBuilder getRelativeTimeOrBuilder()
       If this item time specification is relative to another item, `relativeTime`
 contains a reference to that item as well as the relative start (the duration
 is the same as the `duration` field).
 Note that start of the item is computed by the server based on the
 `relativeTime` before sending the item to the client.
      optional .yamcs.protobuf.timeline.RelativeTime relativeTime = 8;

    • hasDescription

      boolean hasDescription()
       Detailed description of the item
      optional string description = 9;
      Returns:
      Whether the description field is set.

    • getDescription

      String getDescription()
       Detailed description of the item
      optional string description = 9;
      Returns:
      The description.

    • getDescriptionBytes

      com.google.protobuf.ByteString getDescriptionBytes()
       Detailed description of the item
      optional string description = 9;
      Returns:
      The bytes for description.

    • getPropertiesCount

      int getPropertiesCount()
       Additional properties used by the Yamcs Web UI for rendering purposes.
      map<string, string> properties = 14;

    • containsProperties

      boolean containsProperties(String key)
       Additional properties used by the Yamcs Web UI for rendering purposes.
      map<string, string> properties = 14;

    • getProperties

      @Deprecated Map<String,String> getProperties()
      Deprecated.
      Use getPropertiesMap() instead.

    • getPropertiesMap

      Map<String,String> getPropertiesMap()
       Additional properties used by the Yamcs Web UI for rendering purposes.
      map<string, string> properties = 14;

    • getPropertiesOrDefault

      String getPropertiesOrDefault(String key, String defaultValue)
       Additional properties used by the Yamcs Web UI for rendering purposes.
      map<string, string> properties = 14;

    • getPropertiesOrThrow

      String getPropertiesOrThrow(String key)
       Additional properties used by the Yamcs Web UI for rendering purposes.
      map<string, string> properties = 14;

    • getExtraCount

      int getExtraCount()
       Mission-specific custom data. Unlike `properties`, this field is ignored
 by the Yamcs Web UI.
      map<string, string> extra = 18;

    • containsExtra

      boolean containsExtra(String key)
       Mission-specific custom data. Unlike `properties`, this field is ignored
 by the Yamcs Web UI.
      map<string, string> extra = 18;

    • getExtra

      @Deprecated Map<String,String> getExtra()
      Deprecated.
      Use getExtraMap() instead.

    • getExtraMap

      Map<String,String> getExtraMap()
       Mission-specific custom data. Unlike `properties`, this field is ignored
 by the Yamcs Web UI.
      map<string, string> extra = 18;

    • getExtraOrDefault

      String getExtraOrDefault(String key, String defaultValue)
       Mission-specific custom data. Unlike `properties`, this field is ignored
 by the Yamcs Web UI.
      map<string, string> extra = 18;

    • getExtraOrThrow

      String getExtraOrThrow(String key)
       Mission-specific custom data. Unlike `properties`, this field is ignored
 by the Yamcs Web UI.
      map<string, string> extra = 18;

    • hasStatus

      boolean hasStatus()
       For activities: execution status
      optional .yamcs.protobuf.timeline.ExecutionStatus status = 10;
      Returns:
      Whether the status field is set.

    • getStatus

      ExecutionStatus getStatus()
       For activities: execution status
      optional .yamcs.protobuf.timeline.ExecutionStatus status = 10;
      Returns:
      The status.

    • hasFailureReason

      boolean hasFailureReason()
       For activities: if the status is FAILED or ABORTED, this may indicate the reason
 some information may also be available in the item log
      optional string failureReason = 11;
      Returns:
      Whether the failureReason field is set.

    • getFailureReason

      String getFailureReason()
       For activities: if the status is FAILED or ABORTED, this may indicate the reason
 some information may also be available in the item log
      optional string failureReason = 11;
      Returns:
      The failureReason.

    • getFailureReasonBytes

      com.google.protobuf.ByteString getFailureReasonBytes()
       For activities: if the status is FAILED or ABORTED, this may indicate the reason
 some information may also be available in the item log
      optional string failureReason = 11;
      Returns:
      The bytes for failureReason.

    • hasActivityDefinition

      boolean hasActivityDefinition()
       Activity definition associated to this item.
 Only set when `type` equals ACTIVITY.
      optional .yamcs.protobuf.activities.ActivityDefinitionInfo activityDefinition = 13;
      Returns:
      Whether the activityDefinition field is set.

    • getActivityDefinition

      ActivityDefinitionInfo getActivityDefinition()
       Activity definition associated to this item.
 Only set when `type` equals ACTIVITY.
      optional .yamcs.protobuf.activities.ActivityDefinitionInfo activityDefinition = 13;
      Returns:
      The activityDefinition.

    • getActivityDefinitionOrBuilder

      ActivityDefinitionInfoOrBuilder getActivityDefinitionOrBuilder()
       Activity definition associated to this item.
 Only set when `type` equals ACTIVITY.
      optional .yamcs.protobuf.activities.ActivityDefinitionInfo activityDefinition = 13;

    • getRunsList

      List<String> getRunsList()
       Identifiers of activity runs matching this item.
 Only set when `type` equals ACTIVITY.
      repeated string runs = 15;
      Returns:
      A list containing the runs.

    • getRunsCount

      int getRunsCount()
       Identifiers of activity runs matching this item.
 Only set when `type` equals ACTIVITY.
      repeated string runs = 15;
      Returns:
      The count of runs.

    • getRuns

      String getRuns(int index)
       Identifiers of activity runs matching this item.
 Only set when `type` equals ACTIVITY.
      repeated string runs = 15;
      Parameters:
      index - The index of the element to return.
      Returns:
      The runs at the given index.

    • getRunsBytes

      com.google.protobuf.ByteString getRunsBytes(int index)
       Identifiers of activity runs matching this item.
 Only set when `type` equals ACTIVITY.
      repeated string runs = 15;
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the runs at the given index.

    • getActivityRunsList

      List<ActivityInfo> getActivityRunsList()
       Activity runs for this item
 Only set when `type` equals ACTIVITY.
      repeated .yamcs.protobuf.activities.ActivityInfo activityRuns = 19;

    • getActivityRuns

      ActivityInfo getActivityRuns(int index)
       Activity runs for this item
 Only set when `type` equals ACTIVITY.
      repeated .yamcs.protobuf.activities.ActivityInfo activityRuns = 19;

    • getActivityRunsCount

      int getActivityRunsCount()
       Activity runs for this item
 Only set when `type` equals ACTIVITY.
      repeated .yamcs.protobuf.activities.ActivityInfo activityRuns = 19;

    • getActivityRunsOrBuilderList

      List<? extends ActivityInfoOrBuilder> getActivityRunsOrBuilderList()
       Activity runs for this item
 Only set when `type` equals ACTIVITY.
      repeated .yamcs.protobuf.activities.ActivityInfo activityRuns = 19;

    • getActivityRunsOrBuilder

      ActivityInfoOrBuilder getActivityRunsOrBuilder(int index)
       Activity runs for this item
 Only set when `type` equals ACTIVITY.
      repeated .yamcs.protobuf.activities.ActivityInfo activityRuns = 19;

    • getPredecessorsList

      List<PredecessorInfo> getPredecessorsList()
       Dependencies on other activities/events.
 Only applicable when `type` equals ACTIVITY.
 Start time of this activity is derived by looking at each predecessor's
 start condition and among them establishing the latest start time.
      repeated .yamcs.protobuf.timeline.PredecessorInfo predecessors = 16;

    • getPredecessors

      PredecessorInfo getPredecessors(int index)
       Dependencies on other activities/events.
 Only applicable when `type` equals ACTIVITY.
 Start time of this activity is derived by looking at each predecessor's
 start condition and among them establishing the latest start time.
      repeated .yamcs.protobuf.timeline.PredecessorInfo predecessors = 16;

    • getPredecessorsCount

      int getPredecessorsCount()
       Dependencies on other activities/events.
 Only applicable when `type` equals ACTIVITY.
 Start time of this activity is derived by looking at each predecessor's
 start condition and among them establishing the latest start time.
      repeated .yamcs.protobuf.timeline.PredecessorInfo predecessors = 16;

    • getPredecessorsOrBuilderList

      List<? extends PredecessorInfoOrBuilder> getPredecessorsOrBuilderList()
       Dependencies on other activities/events.
 Only applicable when `type` equals ACTIVITY.
 Start time of this activity is derived by looking at each predecessor's
 start condition and among them establishing the latest start time.
      repeated .yamcs.protobuf.timeline.PredecessorInfo predecessors = 16;

    • getPredecessorsOrBuilder

      PredecessorInfoOrBuilder getPredecessorsOrBuilder(int index)
       Dependencies on other activities/events.
 Only applicable when `type` equals ACTIVITY.
 Start time of this activity is derived by looking at each predecessor's
 start condition and among them establishing the latest start time.
      repeated .yamcs.protobuf.timeline.PredecessorInfo predecessors = 16;

    • hasAutoStart

      boolean hasAutoStart()
       Indicates if the activity should start automatically. If false,
 the activity goes into READY state and must be started manually.
 Only applicable when `type` equals ACTIVITY.
      optional bool autoStart = 17;
      Returns:
      Whether the autoStart field is set.

    • getAutoStart

      boolean getAutoStart()
       Indicates if the activity should start automatically. If false,
 the activity goes into READY state and must be started manually.
 Only applicable when `type` equals ACTIVITY.
      optional bool autoStart = 17;
      Returns:
      The autoStart.