org.yamcs.protobuf.TimelineItemOrBuilder 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
Show all versions of yamcs-api Show documentation
Used by external clients to communicate with Yamcs
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: yamcs/protobuf/timeline/timeline.proto
package org.yamcs.protobuf;
public interface TimelineItemOrBuilder extends
// @@protoc_insertion_point(interface_extends:yamcs.protobuf.timeline.TimelineItem)
com.google.protobuf.MessageOrBuilder {
/**
*
* 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;
* @return Whether the id field is set.
*/
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;
* @return The id.
*/
java.lang.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;
* @return The bytes for id.
*/
com.google.protobuf.ByteString
getIdBytes();
/**
*
* Item name
*
*
* optional string name = 2;
* @return Whether the name field is set.
*/
boolean hasName();
/**
*
* Item name
*
*
* optional string name = 2;
* @return The name.
*/
java.lang.String getName();
/**
*
* Item name
*
*
* optional string name = 2;
* @return The bytes for name.
*/
com.google.protobuf.ByteString
getNameBytes();
/**
* optional .yamcs.protobuf.timeline.TimelineItemType type = 3;
* @return Whether the type field is set.
*/
boolean hasType();
/**
* optional .yamcs.protobuf.timeline.TimelineItemType type = 3;
* @return The type.
*/
org.yamcs.protobuf.TimelineItemType getType();
/**
* optional .google.protobuf.Timestamp start = 4;
* @return Whether the start field is set.
*/
boolean hasStart();
/**
* optional .google.protobuf.Timestamp start = 4;
* @return The start.
*/
com.google.protobuf.Timestamp getStart();
/**
* optional .google.protobuf.Timestamp start = 4;
*/
com.google.protobuf.TimestampOrBuilder getStartOrBuilder();
/**
* optional .google.protobuf.Duration duration = 5;
* @return Whether the duration field is set.
*/
boolean hasDuration();
/**
* optional .google.protobuf.Duration duration = 5;
* @return The duration.
*/
com.google.protobuf.Duration getDuration();
/**
* optional .google.protobuf.Duration duration = 5;
*/
com.google.protobuf.DurationOrBuilder getDurationOrBuilder();
/**
* repeated string tags = 6;
* @return A list containing the tags.
*/
java.util.List
getTagsList();
/**
* repeated string tags = 6;
* @return The count of tags.
*/
int getTagsCount();
/**
* repeated string tags = 6;
* @param index The index of the element to return.
* @return The tags at the given index.
*/
java.lang.String getTags(int index);
/**
* repeated string tags = 6;
* @param index The index of the value to return.
* @return The bytes of the tags at the given index.
*/
com.google.protobuf.ByteString
getTagsBytes(int index);
/**
*
* If this item is part of a group, this is the group identifier
*
*
* optional string groupId = 7;
* @return Whether the groupId field is set.
*/
boolean hasGroupId();
/**
*
* If this item is part of a group, this is the group identifier
*
*
* optional string groupId = 7;
* @return The groupId.
*/
java.lang.String getGroupId();
/**
*
* If this item is part of a group, this is the group identifier
*
*
* optional string groupId = 7;
* @return The bytes for groupId.
*/
com.google.protobuf.ByteString
getGroupIdBytes();
/**
*
* 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;
* @return Whether the relativeTime field is set.
*/
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;
* @return The relativeTime.
*/
org.yamcs.protobuf.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;
*/
org.yamcs.protobuf.RelativeTimeOrBuilder getRelativeTimeOrBuilder();
/**
*
* Item description
*
*
* optional string description = 9;
* @return Whether the description field is set.
*/
boolean hasDescription();
/**
*
* Item description
*
*
* optional string description = 9;
* @return The description.
*/
java.lang.String getDescription();
/**
*
* Item description
*
*
* optional string description = 9;
* @return The bytes for description.
*/
com.google.protobuf.ByteString
getDescriptionBytes();
/**
*
* Additional properties used by yamcs-web to render this item
*
*
* map<string, string> properties = 14;
*/
int getPropertiesCount();
/**
*
* Additional properties used by yamcs-web to render this item
*
*
* map<string, string> properties = 14;
*/
boolean containsProperties(
java.lang.String key);
/**
* Use {@link #getPropertiesMap()} instead.
*/
@java.lang.Deprecated
java.util.Map
getProperties();
/**
*
* Additional properties used by yamcs-web to render this item
*
*
* map<string, string> properties = 14;
*/
java.util.Map
getPropertiesMap();
/**
*
* Additional properties used by yamcs-web to render this item
*
*
* map<string, string> properties = 14;
*/
java.lang.String getPropertiesOrDefault(
java.lang.String key,
java.lang.String defaultValue);
/**
*
* Additional properties used by yamcs-web to render this item
*
*
* map<string, string> properties = 14;
*/
java.lang.String getPropertiesOrThrow(
java.lang.String key);
/**
*
* For activities: execution status
*
*
* optional .yamcs.protobuf.timeline.ExecutionStatus status = 10;
* @return Whether the status field is set.
*/
boolean hasStatus();
/**
*
* For activities: execution status
*
*
* optional .yamcs.protobuf.timeline.ExecutionStatus status = 10;
* @return The status.
*/
org.yamcs.protobuf.ExecutionStatus getStatus();
/**
*
* 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;
* @return Whether the failureReason field is set.
*/
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;
* @return The failureReason.
*/
java.lang.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;
* @return The bytes for failureReason.
*/
com.google.protobuf.ByteString
getFailureReasonBytes();
/**
*
* Activity definition associated to this item.
* Set if ``type`` is ACTIVITY.
*
*
* optional .yamcs.protobuf.activities.ActivityDefinitionInfo activityDefinition = 13;
* @return Whether the activityDefinition field is set.
*/
boolean hasActivityDefinition();
/**
*
* Activity definition associated to this item.
* Set if ``type`` is ACTIVITY.
*
*
* optional .yamcs.protobuf.activities.ActivityDefinitionInfo activityDefinition = 13;
* @return The activityDefinition.
*/
org.yamcs.protobuf.activities.ActivityDefinitionInfo getActivityDefinition();
/**
*
* Activity definition associated to this item.
* Set if ``type`` is ACTIVITY.
*
*
* optional .yamcs.protobuf.activities.ActivityDefinitionInfo activityDefinition = 13;
*/
org.yamcs.protobuf.activities.ActivityDefinitionInfoOrBuilder getActivityDefinitionOrBuilder();
/**
*
* Identifiers of activity runs matching this item.
* Set if ``type`` is ACTIVITY.
*
*
* repeated string runs = 15;
* @return A list containing the runs.
*/
java.util.List
getRunsList();
/**
*
* Identifiers of activity runs matching this item.
* Set if ``type`` is ACTIVITY.
*
*
* repeated string runs = 15;
* @return The count of runs.
*/
int getRunsCount();
/**
*
* Identifiers of activity runs matching this item.
* Set if ``type`` is ACTIVITY.
*
*
* repeated string runs = 15;
* @param index The index of the element to return.
* @return The runs at the given index.
*/
java.lang.String getRuns(int index);
/**
*
* Identifiers of activity runs matching this item.
* Set if ``type`` is ACTIVITY.
*
*
* repeated string runs = 15;
* @param index The index of the value to return.
* @return The bytes of the runs at the given index.
*/
com.google.protobuf.ByteString
getRunsBytes(int index);
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy