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

Interface SaveItemRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
SaveItemRequest, SaveItemRequest.Builder
@Generated public interface SaveItemRequestOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • hasInstance

      boolean hasInstance()
       Yamcs instance name
      optional string instance = 1;
      Returns:
      Whether the instance field is set.

    • getInstance

      String getInstance()
       Yamcs instance name
      optional string instance = 1;
      Returns:
      The instance.

    • getInstanceBytes

      com.google.protobuf.ByteString getInstanceBytes()
       Yamcs instance name
      optional string instance = 1;
      Returns:
      The bytes for instance.

    • hasSource

      boolean hasSource()
       Item source
      optional string source = 2;
      Returns:
      Whether the source field is set.

    • getSource

      String getSource()
       Item source
      optional string source = 2;
      Returns:
      The source.

    • getSourceBytes

      com.google.protobuf.ByteString getSourceBytes()
       Item source
      optional string source = 2;
      Returns:
      The bytes for source.

    • hasId

      boolean hasId()
       Optional item identifier.

 If not set, an ID will be assigned by the server.

 If set, it should be a valid UUID.
      optional string id = 13;
      Returns:
      Whether the id field is set.

    • getId

      String getId()
       Optional item identifier.

 If not set, an ID will be assigned by the server.

 If set, it should be a valid UUID.
      optional string id = 13;
      Returns:
      The id.

    • getIdBytes

      com.google.protobuf.ByteString getIdBytes()
       Optional item identifier.

 If not set, an ID will be assigned by the server.

 If set, it should be a valid UUID.
      optional string id = 13;
      Returns:
      The bytes for id.

    • hasName

      boolean hasName()
       Item name
      optional string name = 3;
      Returns:
      Whether the name field is set.

    • getName

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

    • getNameBytes

      com.google.protobuf.ByteString getNameBytes()
       Item name
      optional string name = 3;
      Returns:
      The bytes for name.

    • hasType

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

    • getType

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

    • hasStart

      boolean hasStart()
       Item start. The fields `start`, `relativeTime` and `dependsOn`
 are mutually exclusive
      optional .google.protobuf.Timestamp start = 5;
      Returns:
      Whether the start field is set.

    • getStart

      com.google.protobuf.Timestamp getStart()
       Item start. The fields `start`, `relativeTime` and `dependsOn`
 are mutually exclusive
      optional .google.protobuf.Timestamp start = 5;
      Returns:
      The start.

    • getStartOrBuilder

      com.google.protobuf.TimestampOrBuilder getStartOrBuilder()
       Item start. The fields `start`, `relativeTime` and `dependsOn`
 are mutually exclusive
      optional .google.protobuf.Timestamp start = 5;

    • hasDuration

      boolean hasDuration()
       Item duration. Applies also if `relativeTime` is specified
      optional .google.protobuf.Duration duration = 6;
      Returns:
      Whether the duration field is set.

    • getDuration

      com.google.protobuf.Duration getDuration()
       Item duration. Applies also if `relativeTime` is specified
      optional .google.protobuf.Duration duration = 6;
      Returns:
      The duration.

    • getDurationOrBuilder

      com.google.protobuf.DurationOrBuilder getDurationOrBuilder()
       Item duration. Applies also if `relativeTime` is specified
      optional .google.protobuf.Duration duration = 6;

    • getTagsList

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

    • getTagsCount

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

    • getTags

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

    • getTagsBytes

      com.google.protobuf.ByteString getTagsBytes(int index)
       Tags
      repeated string tags = 7;
      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 = 8;
      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 = 8;
      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 = 8;
      Returns:
      The bytes for groupId.

    • hasRelativeTime

      boolean hasRelativeTime()
       If the 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` field).
      optional .yamcs.protobuf.timeline.RelativeTime relativeTime = 9;
      Returns:
      Whether the relativeTime field is set.

    • getRelativeTime

      RelativeTime getRelativeTime()
       If the 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` field).
      optional .yamcs.protobuf.timeline.RelativeTime relativeTime = 9;
      Returns:
      The relativeTime.

    • getRelativeTimeOrBuilder

      RelativeTimeOrBuilder getRelativeTimeOrBuilder()
       If the 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` field).
      optional .yamcs.protobuf.timeline.RelativeTime relativeTime = 9;

    • hasDescription

      boolean hasDescription()
       Item description
      optional string description = 10;
      Returns:
      Whether the description field is set.

    • getDescription

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

    • getDescriptionBytes

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

    • getPropertiesCount

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

    • containsProperties

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

    • 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 = 11;

    • getPropertiesOrDefault

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

    • getPropertiesOrThrow

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

    • 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;

    • hasActivityDefinition

      boolean hasActivityDefinition()
       Activity definition associated to this item.

 Required if `type` is ACTIVITY.
      optional .yamcs.protobuf.activities.ActivityDefinitionInfo activityDefinition = 12;
      Returns:
      Whether the activityDefinition field is set.

    • getActivityDefinition

      ActivityDefinitionInfo getActivityDefinition()
       Activity definition associated to this item.

 Required if `type` is ACTIVITY.
      optional .yamcs.protobuf.activities.ActivityDefinitionInfo activityDefinition = 12;
      Returns:
      The activityDefinition.

    • getActivityDefinitionOrBuilder

      ActivityDefinitionInfoOrBuilder getActivityDefinitionOrBuilder()
       Activity definition associated to this item.

 Required if `type` is ACTIVITY.
      optional .yamcs.protobuf.activities.ActivityDefinitionInfo activityDefinition = 12;

    • getPredecessorsList

      List<PredecessorInfo> getPredecessorsList()
       Can be used only if `type` is ACTIVITY.

 Specifies which other activities/items this activity depends on.

 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 = 14;

    • getPredecessors

      PredecessorInfo getPredecessors(int index)
       Can be used only if `type` is ACTIVITY.

 Specifies which other activities/items this activity depends on.

 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 = 14;

    • getPredecessorsCount

      int getPredecessorsCount()
       Can be used only if `type` is ACTIVITY.

 Specifies which other activities/items this activity depends on.

 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 = 14;

    • getPredecessorsOrBuilderList

      List<? extends PredecessorInfoOrBuilder> getPredecessorsOrBuilderList()
       Can be used only if `type` is ACTIVITY.

 Specifies which other activities/items this activity depends on.

 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 = 14;

    • getPredecessorsOrBuilder

      PredecessorInfoOrBuilder getPredecessorsOrBuilder(int index)
       Can be used only if `type` is ACTIVITY.

 Specifies which other activities/items this activity depends on.

 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 = 14;

    • hasAutoStart

      boolean hasAutoStart()
       Can be used only if `type` is ACTIVITY

 Indicates if the activity should start automatically.

 When `false`, the activity will be moved to `READY` state waiting to be
 started manually.

 Defaults to `false` for manual activities, and `true` otherwise.
      optional bool autoStart = 17;
      Returns:
      Whether the autoStart field is set.

    • getAutoStart

      boolean getAutoStart()
       Can be used only if `type` is ACTIVITY

 Indicates if the activity should start automatically.

 When `false`, the activity will be moved to `READY` state waiting to be
 started manually.

 Defaults to `false` for manual activities, and `true` otherwise.
      optional bool autoStart = 17;
      Returns:
      The autoStart.