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

Interface CreateItemRequestOrBuilder

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

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getDescription()
    item description
    com.google.protobuf.ByteString
    getDescriptionBytes()
    item description
    com.google.protobuf.Duration
    getDuration()
    item duration.
    com.google.protobuf.DurationOrBuilder
    getDurationOrBuilder()
    item duration.
    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
    getInstance()
    Yamcs instance name
    com.google.protobuf.ByteString
    getInstanceBytes()
    Yamcs instance name
    String
    getName()
    Item name
    com.google.protobuf.ByteString
    getNameBytes()
    Item name
    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)
    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)
    String
    getSource()
    Item source
    com.google.protobuf.ByteString
    getSourceBytes()
    Item source
    com.google.protobuf.Timestamp
    getStart()
    item start.
    com.google.protobuf.TimestampOrBuilder
    getStartOrBuilder()
    item start.
    String
    getTags(int index)
    tags
    com.google.protobuf.ByteString
    getTagsBytes(int index)
    tags
    int
    getTagsCount()
    tags
    List<String>
    getTagsList()
    tags
    TimelineItemType
    getType()
    Type of item
    boolean
    hasDescription()
    item description
    boolean
    hasDuration()
    item duration.
    boolean
    hasGroupId()
    if this item is part of a group, this is the group identifier
    boolean
    hasInstance()
    Yamcs instance name
    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)
    boolean
    hasSource()
    Item source
    boolean
    hasStart()
    item start.
    boolean
    hasType()
    Type of item

    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

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

    • 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()
       Type of item
      optional .yamcs.protobuf.timeline.TimelineItemType type = 4;
      Returns:
      Whether the type field is set.

    • getType

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

    • hasStart

      boolean hasStart()
      item start. The start and the relativeTime (below) 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 start and the relativeTime (below) are mutually exclusive
      optional .google.protobuf.Timestamp start = 5;
      Returns:
      The start.

    • getStartOrBuilder

      com.google.protobuf.TimestampOrBuilder getStartOrBuilder()
      item start. The start and the relativeTime (below) are mutually exclusive
      optional .google.protobuf.Timestamp start = 5;

    • hasDuration

      boolean hasDuration()
      item duration. Applies also if the 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 the relativeTime is specified
      optional .google.protobuf.Duration duration = 6;
      Returns:
      The duration.

    • getDurationOrBuilder

      com.google.protobuf.DurationOrBuilder getDurationOrBuilder()
      item duration. Applies also if the 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 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)
      optional .yamcs.protobuf.timeline.RelativeTime relativeTime = 9;
      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)
      optional .yamcs.protobuf.timeline.RelativeTime relativeTime = 9;
      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)
      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.