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

Interface AddBandRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
AddBandRequest, AddBandRequest.Builder
public interface AddBandRequestOrBuilder 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()
       Optional band identifier.
 If not set, an ID will be assigned by the server.
 If set, it should be a valid UUID.
      optional string id = 10;
      Returns:
      Whether the id field is set.

    • getId

      String getId()
       Optional band identifier.
 If not set, an ID will be assigned by the server.
 If set, it should be a valid UUID.
      optional string id = 10;
      Returns:
      The id.

    • getIdBytes

      com.google.protobuf.ByteString getIdBytes()
       Optional band identifier.
 If not set, an ID will be assigned by the server.
 If set, it should be a valid UUID.
      optional string id = 10;
      Returns:
      The bytes for id.

    • hasName

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

    • getName

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

    • getNameBytes

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

    • hasShared

      boolean hasShared()
      if true, all users have access to this band, otherwise only the user who has created it
      optional bool shared = 3;
      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 = 3;
      Returns:
      The shared.

    • hasSource

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

    • getSource

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

    • getSourceBytes

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

    • getTagsList

      @Deprecated List<String> getTagsList()
      Deprecated.
       Items containing these tags will be part of the timeline
 this is deprecated, the filters below should be used instead
      repeated string tags = 5 [deprecated = true];
      Returns:
      A list containing the tags.

    • getTagsCount

      @Deprecated int getTagsCount()
      Deprecated.
       Items containing these tags will be part of the timeline
 this is deprecated, the filters below should be used instead
      repeated string tags = 5 [deprecated = true];
      Returns:
      The count of tags.

    • getTags

      @Deprecated String getTags(int index)
      Deprecated.
       Items containing these tags will be part of the timeline
 this is deprecated, the filters below should be used instead
      repeated string tags = 5 [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.
       Items containing these tags will be part of the timeline
 this is deprecated, the filters below should be used instead
      repeated string tags = 5 [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()
       A query filter which can be used to limit additionally the items which are part of the band
      repeated .yamcs.protobuf.timeline.ItemFilter filters = 6;

    • getFilters

      ItemFilter getFilters(int index)
       A query filter which can be used to limit additionally the items which are part of the band
      repeated .yamcs.protobuf.timeline.ItemFilter filters = 6;

    • getFiltersCount

      int getFiltersCount()
       A query filter which can be used to limit additionally the items which are part of the band
      repeated .yamcs.protobuf.timeline.ItemFilter filters = 6;

    • getFiltersOrBuilderList

      List<? extends ItemFilterOrBuilder> getFiltersOrBuilderList()
       A query filter which can be used to limit additionally the items which are part of the band
      repeated .yamcs.protobuf.timeline.ItemFilter filters = 6;

    • getFiltersOrBuilder

      ItemFilterOrBuilder getFiltersOrBuilder(int index)
       A query filter which can be used to limit additionally the items which are part of the band
      repeated .yamcs.protobuf.timeline.ItemFilter filters = 6;

    • hasType

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

    • getType

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

    • hasDescription

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

    • getDescription

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

    • getDescriptionBytes

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

    • getPropertiesCount

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

    • containsProperties

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

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

    • getPropertiesOrDefault

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

    • getPropertiesOrThrow

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