Package org.yamcs.protobuf

Interface TimelineBandOrBuilder

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

      List<String> getTagsList()
       The band contains only items with these tags. If the list is empty,
 all items from the given source are part of the band.
      repeated string tags = 7;
      Returns:
      A list containing the tags.

    • getTagsCount

      int getTagsCount()
       The band contains only items with these tags. If the list is empty,
 all items from the given source are part of the band.
      repeated string tags = 7;
      Returns:
      The count of tags.

    • getTags

      String getTags(int index)
       The band contains only items with these tags. If the list is empty,
 all items from the given source are part of the band.
      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)
       The band contains only items with these tags. If the list is empty,
 all items from the given source are part of the band.
      repeated string tags = 7;
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the tags at the given index.

    • hasFilter

      boolean hasFilter()
       If specified, the band shows only items matching this filter
      optional string filter = 13;
      Returns:
      Whether the filter field is set.

    • getFilter

      String getFilter()
       If specified, the band shows only items matching this filter
      optional string filter = 13;
      Returns:
      The filter.

    • getFilterBytes

      com.google.protobuf.ByteString getFilterBytes()
       If specified, the band shows only items matching this filter
      optional string filter = 13;
      Returns:
      The bytes for filter.

    • 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()
       Detailed description of this band
      optional string description = 10;
      Returns:
      Whether the description field is set.

    • getDescription

      String getDescription()
       Detailed description of this band
      optional string description = 10;
      Returns:
      The description.

    • getDescriptionBytes

      com.google.protobuf.ByteString getDescriptionBytes()
       Detailed description of this band
      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 = 12;

    • containsExtra

      boolean containsExtra(String key)
       Mission-specific custom data. Unlike `properties`, this field is ignored
 by the Yamcs Web UI.
      map<string, string> extra = 12;

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

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

    • getExtraOrThrow

      String getExtraOrThrow(String key)
       Mission-specific custom data. Unlike `properties`, this field is ignored
 by the Yamcs Web UI.
      map<string, string> extra = 12;