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

Interface SaveBandRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
SaveBandRequest, SaveBandRequest.Builder
public interface SaveBandRequestOrBuilder 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()
       Where the items shown on this band come from
      optional string source = 4;
      Returns:
      Whether the source field is set.

    • getSource

      String getSource()
       Where the items shown on this band come from
      optional string source = 4;
      Returns:
      The source.

    • getSourceBytes

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

    • getTagsList

      List<String> getTagsList()
       Items containing these tags will be part of the timeline
      repeated string tags = 5;
      Returns:
      A list containing the tags.

    • getTagsCount

      int getTagsCount()
       Items containing these tags will be part of the timeline
      repeated string tags = 5;
      Returns:
      The count of tags.

    • getTags

      String getTags(int index)
       Items containing these tags will be part of the timeline
      repeated string tags = 5;
      Parameters:
      index - The index of the element to return.
      Returns:
      The tags at the given index.

    • getTagsBytes

      com.google.protobuf.ByteString getTagsBytes(int index)
       Items containing these tags will be part of the timeline
      repeated string tags = 5;
      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 = 12;
      Returns:
      Whether the filter field is set.

    • getFilter

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

    • getFilterBytes

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

    • 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 the Yamcs Web UI for rendering purposes.
      map<string, string> properties = 9;

    • containsProperties

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

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

    • getPropertiesOrDefault

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

    • getPropertiesOrThrow

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

    • getExtraCount

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

    • containsExtra

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

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

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

    • getExtraOrThrow

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