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 Summary
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description booleancontainsProperties(String key)Additional properties used by yamcs-web to render this bandStringgetDescription()Band descriptioncom.google.protobuf.ByteStringgetDescriptionBytes()Band descriptionStringgetId()Band identifiercom.google.protobuf.ByteStringgetIdBytes()Band identifierStringgetInstance()Yamcs instance namecom.google.protobuf.ByteStringgetInstanceBytes()Yamcs instance nameStringgetName()Band namecom.google.protobuf.ByteStringgetNameBytes()Band nameMap<String,String>getProperties()Deprecated.intgetPropertiesCount()Additional properties used by yamcs-web to render this bandMap<String,String>getPropertiesMap()Additional properties used by yamcs-web to render this bandStringgetPropertiesOrDefault(String key, String defaultValue)Additional properties used by yamcs-web to render this bandStringgetPropertiesOrThrow(String key)Additional properties used by yamcs-web to render this bandbooleangetShared()if true, all users have access to this band, otherwise only the user who has created itStringgetSource()the band contains only items from this sourcecom.google.protobuf.ByteStringgetSourceBytes()the band contains only items from this sourceStringgetTags(int index)the band contains only items with these tags; if the list is empty, then all items from the given source are part of the bandcom.google.protobuf.ByteStringgetTagsBytes(int index)the band contains only items with these tags; if the list is empty, then all items from the given source are part of the bandintgetTagsCount()the band contains only items with these tags; if the list is empty, then all items from the given source are part of the bandList<String>getTagsList()the band contains only items with these tags; if the list is empty, then all items from the given source are part of the bandTimelineBandTypegetType()Type of bandStringgetUsername()user who has created the bandcom.google.protobuf.ByteStringgetUsernameBytes()user who has created the bandbooleanhasDescription()Band descriptionbooleanhasId()Band identifierbooleanhasInstance()Yamcs instance namebooleanhasName()Band namebooleanhasShared()if true, all users have access to this band, otherwise only the user who has created itbooleanhasSource()the band contains only items from this sourcebooleanhasType()Type of bandbooleanhasUsername()user who has created the band-
Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
-
-
-
Method Detail
-
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
optional string id = 2;- Returns:
- Whether the id field is set.
-
getId
String getId()
Band identifier
optional string id = 2;- Returns:
- The id.
-
getIdBytes
com.google.protobuf.ByteString getIdBytes()
Band identifier
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, then 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, then 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, then 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, then 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.
-
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.UsegetPropertiesMap()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;
-
-