Package org.yamcs.protobuf

Interface TimelineBandOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
TimelineBand, TimelineBand.Builder
public interface TimelineBandOrBuilder 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.

    • hasId

      boolean hasId()
       Band identifier (UUID)
      optional string id = 2;
      Returns:
      Whether the id field is set.

    • getId

      String getId()
       Band identifier (UUID)
      optional string id = 2;
      Returns:
      The id.

    • getIdBytes

      com.google.protobuf.ByteString getIdBytes()
       Band identifier (UUID)
      optional string id = 2;
      Returns:
      The bytes for id.

    • hasName

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

    • getName

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

    • getNameBytes

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

    • hasUsername

      boolean hasUsername()
       User who has created the band
      optional string username = 4;
      Returns:
      Whether the username field is set.

    • getUsername

      String getUsername()
       User who has created the band
      optional string username = 4;
      Returns:
      The username.

    • getUsernameBytes

      com.google.protobuf.ByteString getUsernameBytes()
       User who has created the band
      optional string username = 4;
      Returns:
      The bytes for username.

    • hasShared

      boolean hasShared()
      if true, all users have access to this band, otherwise only the user who has created it
      optional bool shared = 5;
      Returns:
      Whether the shared field is set.

    • getShared

      boolean getShared()
      if true, all users have access to this band, otherwise only the user who has created it
      optional bool shared = 5;
      Returns:
      The shared.

    • hasSource

      boolean hasSource()
      the band contains only items from this source
      optional string source = 6;
      Returns:
      Whether the source field is set.

    • getSource

      String getSource()
      the band contains only items from this source
      optional string source = 6;
      Returns:
      The source.

    • getSourceBytes

      com.google.protobuf.ByteString getSourceBytes()
      the band contains only items from this source
      optional string source = 6;
      Returns:
      The bytes for source.

    • getTagsList

      @Deprecated List<String> getTagsList()
      Deprecated.
      the band contains only items with these tags; if the list is empty, then all items from the given source are part of the band
this is deprecated, the filters below should be used to select the items
      repeated string tags = 7 [deprecated = true];
      Returns:
      A list containing the tags.

    • getTagsCount

      @Deprecated int getTagsCount()
      Deprecated.
      the band contains only items with these tags; if the list is empty, then all items from the given source are part of the band
this is deprecated, the filters below should be used to select the items
      repeated string tags = 7 [deprecated = true];
      Returns:
      The count of tags.

    • getTags

      @Deprecated String getTags(int index)
      Deprecated.
      the band contains only items with these tags; if the list is empty, then all items from the given source are part of the band
this is deprecated, the filters below should be used to select the items
      repeated string tags = 7 [deprecated = true];
      Parameters:
      index - The index of the element to return.
      Returns:
      The tags at the given index.

    • getTagsBytes

      @Deprecated com.google.protobuf.ByteString getTagsBytes(int index)
      Deprecated.
      the band contains only items with these tags; if the list is empty, then all items from the given source are part of the band
this is deprecated, the filters below should be used to select the items
      repeated string tags = 7 [deprecated = true];
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the tags at the given index.

    • getFiltersList

      List<ItemFilter> getFiltersList()
      The filters are to be considered in an AND manner.
 An item will be part of the band if it matches all the filters.
 If the list is empty, then all items from the given source are part of the band
      repeated .yamcs.protobuf.timeline.ItemFilter filters = 8;

    • getFilters

      ItemFilter getFilters(int index)
      The filters are to be considered in an AND manner.
 An item will be part of the band if it matches all the filters.
 If the list is empty, then all items from the given source are part of the band
      repeated .yamcs.protobuf.timeline.ItemFilter filters = 8;

    • getFiltersCount

      int getFiltersCount()
      The filters are to be considered in an AND manner.
 An item will be part of the band if it matches all the filters.
 If the list is empty, then all items from the given source are part of the band
      repeated .yamcs.protobuf.timeline.ItemFilter filters = 8;

    • getFiltersOrBuilderList

      List<? extends ItemFilterOrBuilder> getFiltersOrBuilderList()
      The filters are to be considered in an AND manner.
 An item will be part of the band if it matches all the filters.
 If the list is empty, then all items from the given source are part of the band
      repeated .yamcs.protobuf.timeline.ItemFilter filters = 8;

    • getFiltersOrBuilder

      ItemFilterOrBuilder getFiltersOrBuilder(int index)
      The filters are to be considered in an AND manner.
 An item will be part of the band if it matches all the filters.
 If the list is empty, then all items from the given source are part of the band
      repeated .yamcs.protobuf.timeline.ItemFilter filters = 8;

    • hasType

      boolean hasType()
       Type of band
      optional .yamcs.protobuf.timeline.TimelineBandType type = 9;
      Returns:
      Whether the type field is set.

    • getType

      TimelineBandType getType()
       Type of band
      optional .yamcs.protobuf.timeline.TimelineBandType type = 9;
      Returns:
      The type.

    • hasDescription

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

    • getDescription

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

    • getDescriptionBytes

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

    • getPropertiesCount

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

    • containsProperties

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

    • getProperties

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

    • getPropertiesMap

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

    • getPropertiesOrDefault

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

    • getPropertiesOrThrow

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