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 Summary

    Modifier and Type
    Method
    Description
    boolean
    containsProperties(String key)
    Additional properties used by yamcs-web to render this item
    ActivityDefinitionInfo
    getActivityDefinition()
    Activity definition associated to this item.
    ActivityDefinitionInfoOrBuilder
    getActivityDefinitionOrBuilder()
    Activity definition associated to this item.
    String
    getDescription()
    Item description
    com.google.protobuf.ByteString
    getDescriptionBytes()
    Item description
    com.google.protobuf.Duration
    getDuration()
    optional .google.protobuf.Duration duration = 5;
    com.google.protobuf.DurationOrBuilder
    getDurationOrBuilder()
    optional .google.protobuf.Duration duration = 5;
    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
    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
    String
    getGroupId()
    If this item is part of a group, this is the group identifier
    com.google.protobuf.ByteString
    getGroupIdBytes()
    If this item is part of a group, this is the group identifier
    String
    getId()
    Item identifier.
    com.google.protobuf.ByteString
    getIdBytes()
    Item identifier.
    String
    getName()
    Item name
    com.google.protobuf.ByteString
    getNameBytes()
    Item name
    Map<String,String>
    getProperties()
    Deprecated.
    int
    getPropertiesCount()
    Additional properties used by yamcs-web to render this item
    Map<String,String>
    getPropertiesMap()
    Additional properties used by yamcs-web to render this item
    String
    getPropertiesOrDefault(String key, String defaultValue)
    Additional properties used by yamcs-web to render this item
    String
    getPropertiesOrThrow(String key)
    Additional properties used by yamcs-web to render this item
    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 given by the duration above) note that start of the item will be computed by the server based on the relativeTime before sending the item to the client
    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 given by the duration above) note that start of the item will be computed by the server based on the relativeTime before sending the item to the client
    String
    getRuns(int index)
    Identifiers of activity runs matching this item.
    com.google.protobuf.ByteString
    getRunsBytes(int index)
    Identifiers of activity runs matching this item.
    int
    getRunsCount()
    Identifiers of activity runs matching this item.
    List<String>
    getRunsList()
    Identifiers of activity runs matching this item.
    com.google.protobuf.Timestamp
    getStart()
    optional .google.protobuf.Timestamp start = 4;
    com.google.protobuf.TimestampOrBuilder
    getStartOrBuilder()
    optional .google.protobuf.Timestamp start = 4;
    ExecutionStatus
    getStatus()
    For activities: execution status
    String
    getTags(int index)
    repeated string tags = 6;
    com.google.protobuf.ByteString
    getTagsBytes(int index)
    repeated string tags = 6;
    int
    getTagsCount()
    repeated string tags = 6;
    List<String>
    getTagsList()
    repeated string tags = 6;
    TimelineItemType
    getType()
    optional .yamcs.protobuf.timeline.TimelineItemType type = 3;
    boolean
    hasActivityDefinition()
    Activity definition associated to this item.
    boolean
    hasDescription()
    Item description
    boolean
    hasDuration()
    optional .google.protobuf.Duration duration = 5;
    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
    boolean
    hasGroupId()
    If this item is part of a group, this is the group identifier
    boolean
    hasId()
    Item identifier.
    boolean
    hasName()
    Item name
    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 given by the duration above) note that start of the item will be computed by the server based on the relativeTime before sending the item to the client
    boolean
    hasStart()
    optional .google.protobuf.Timestamp start = 4;
    boolean
    hasStatus()
    For activities: execution status
    boolean
    hasType()
    optional .yamcs.protobuf.timeline.TimelineItemType type = 3;

    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()
       Item identifier.
 The identifier is set and recognized by the source.
 It is possible but unlikely that two items coming from two different sources will have the same id.
 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 set and recognized by the source.
 It is possible but unlikely that two items coming from two different sources will have the same id.
 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 set and recognized by the source.
 It is possible but unlikely that two items coming from two different sources will have the same id.
 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()
       Item name
      optional string name = 2;
      Returns:
      Whether the name field is set.

    • getName

      String getName()
       Item name
      optional string name = 2;
      Returns:
      The name.

    • getNameBytes

      com.google.protobuf.ByteString getNameBytes()
       Item name
      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()
      optional .google.protobuf.Timestamp start = 4;
      Returns:
      Whether the start field is set.

    • getStart

      com.google.protobuf.Timestamp getStart()
      optional .google.protobuf.Timestamp start = 4;
      Returns:
      The start.

    • getStartOrBuilder

      com.google.protobuf.TimestampOrBuilder getStartOrBuilder()
      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 is part of a group, this is the group identifier
      optional string groupId = 7;
      Returns:
      Whether the groupId field is set.

    • getGroupId

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

    • getGroupIdBytes

      com.google.protobuf.ByteString getGroupIdBytes()
       If this item is part of 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 given by the duration above)
note that start of the item will be 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 given by the duration above)
note that start of the item will be 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 given by the duration above)
note that start of the item will be 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()
       Item description
      optional string description = 9;
      Returns:
      Whether the description field is set.

    • getDescription

      String getDescription()
       Item description
      optional string description = 9;
      Returns:
      The description.

    • getDescriptionBytes

      com.google.protobuf.ByteString getDescriptionBytes()
       Item description
      optional string description = 9;
      Returns:
      The bytes for description.

    • getPropertiesCount

      int getPropertiesCount()
       Additional properties used by yamcs-web to render this item
      map<string, string> properties = 14;

    • containsProperties

      boolean containsProperties(String key)
       Additional properties used by yamcs-web to render this item
      map<string, string> properties = 14;

    • getProperties

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

    • getPropertiesMap

      Map<String,String> getPropertiesMap()
       Additional properties used by yamcs-web to render this item
      map<string, string> properties = 14;

    • getPropertiesOrDefault

      String getPropertiesOrDefault(String key, String defaultValue)
       Additional properties used by yamcs-web to render this item
      map<string, string> properties = 14;

    • getPropertiesOrThrow

      String getPropertiesOrThrow(String key)
       Additional properties used by yamcs-web to render this item
      map<string, string> properties = 14;

    • 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.
 Set if ``type`` is ACTIVITY.
      optional .yamcs.protobuf.activities.ActivityDefinitionInfo activityDefinition = 13;
      Returns:
      Whether the activityDefinition field is set.

    • getActivityDefinition

      ActivityDefinitionInfo getActivityDefinition()
       Activity definition associated to this item.
 Set if ``type`` is ACTIVITY.
      optional .yamcs.protobuf.activities.ActivityDefinitionInfo activityDefinition = 13;
      Returns:
      The activityDefinition.

    • getActivityDefinitionOrBuilder

      ActivityDefinitionInfoOrBuilder getActivityDefinitionOrBuilder()
       Activity definition associated to this item.
 Set if ``type`` is ACTIVITY.
      optional .yamcs.protobuf.activities.ActivityDefinitionInfo activityDefinition = 13;

    • getRunsList

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

    • getRunsCount

      int getRunsCount()
       Identifiers of activity runs matching this item.
 Set if ``type`` is ACTIVITY.
      repeated string runs = 15;
      Returns:
      The count of runs.

    • getRuns

      String getRuns(int index)
       Identifiers of activity runs matching this item.
 Set if ``type`` is 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.
 Set if ``type`` is ACTIVITY.
      repeated string runs = 15;
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the runs at the given index.