org.yamcs.protobuf.TimelineBandOrBuilder Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of yamcs-api Show documentation
Show all versions of yamcs-api Show documentation
Used by external clients to communicate with Yamcs
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: yamcs/protobuf/timeline/timeline.proto
package org.yamcs.protobuf;
public interface TimelineBandOrBuilder extends
// @@protoc_insertion_point(interface_extends:yamcs.protobuf.timeline.TimelineBand)
com.google.protobuf.MessageOrBuilder {
/**
*
* Yamcs instance name
*
*
* optional string instance = 1;
* @return Whether the instance field is set.
*/
boolean hasInstance();
/**
*
* Yamcs instance name
*
*
* optional string instance = 1;
* @return The instance.
*/
java.lang.String getInstance();
/**
*
* Yamcs instance name
*
*
* optional string instance = 1;
* @return The bytes for instance.
*/
com.google.protobuf.ByteString
getInstanceBytes();
/**
*
* Band identifier (UUID)
*
*
* optional string id = 2;
* @return Whether the id field is set.
*/
boolean hasId();
/**
*
* Band identifier (UUID)
*
*
* optional string id = 2;
* @return The id.
*/
java.lang.String getId();
/**
*
* Band identifier (UUID)
*
*
* optional string id = 2;
* @return The bytes for id.
*/
com.google.protobuf.ByteString
getIdBytes();
/**
*
* Band name
*
*
* optional string name = 3;
* @return Whether the name field is set.
*/
boolean hasName();
/**
*
* Band name
*
*
* optional string name = 3;
* @return The name.
*/
java.lang.String getName();
/**
*
* Band name
*
*
* optional string name = 3;
* @return The bytes for name.
*/
com.google.protobuf.ByteString
getNameBytes();
/**
*
* User who has created the band
*
*
* optional string username = 4;
* @return Whether the username field is set.
*/
boolean hasUsername();
/**
*
* User who has created the band
*
*
* optional string username = 4;
* @return The username.
*/
java.lang.String getUsername();
/**
*
* User who has created the band
*
*
* optional string username = 4;
* @return The bytes for username.
*/
com.google.protobuf.ByteString
getUsernameBytes();
/**
*
* If true, all users have access to this band, otherwise only the user who has created it
*
*
* optional bool shared = 5;
* @return Whether the shared field is set.
*/
boolean hasShared();
/**
*
* If true, all users have access to this band, otherwise only the user who has created it
*
*
* optional bool shared = 5;
* @return The shared.
*/
boolean getShared();
/**
*
* The band contains only items from this source
*
*
* optional string source = 6;
* @return Whether the source field is set.
*/
boolean hasSource();
/**
*
* The band contains only items from this source
*
*
* optional string source = 6;
* @return The source.
*/
java.lang.String getSource();
/**
*
* The band contains only items from this source
*
*
* optional string source = 6;
* @return The bytes for source.
*/
com.google.protobuf.ByteString
getSourceBytes();
/**
*
*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];
* @deprecated
* @return A list containing the tags.
*/
@java.lang.Deprecated java.util.List
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
*this is deprecated, the filters below should be used to select the items
*
*
* repeated string tags = 7 [deprecated = true];
* @deprecated
* @return The count of tags.
*/
@java.lang.Deprecated 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
*this is deprecated, the filters below should be used to select the items
*
*
* repeated string tags = 7 [deprecated = true];
* @deprecated
* @param index The index of the element to return.
* @return The tags at the given index.
*/
@java.lang.Deprecated java.lang.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
*this is deprecated, the filters below should be used to select the items
*
*
* repeated string tags = 7 [deprecated = true];
* @deprecated
* @param index The index of the value to return.
* @return The bytes of the tags at the given index.
*/
@java.lang.Deprecated com.google.protobuf.ByteString
getTagsBytes(int index);
/**
*
* The filters are to be considered in an AND manner.
* An item is part of the band if it matches all 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;
*/
java.util.List
getFiltersList();
/**
*
* The filters are to be considered in an AND manner.
* An item is part of the band if it matches all 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;
*/
org.yamcs.protobuf.ItemFilter getFilters(int index);
/**
*
* The filters are to be considered in an AND manner.
* An item is part of the band if it matches all 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;
*/
int getFiltersCount();
/**
*
* The filters are to be considered in an AND manner.
* An item is part of the band if it matches all 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;
*/
java.util.List
getFiltersOrBuilderList();
/**
*
* The filters are to be considered in an AND manner.
* An item is part of the band if it matches all 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;
*/
org.yamcs.protobuf.ItemFilterOrBuilder getFiltersOrBuilder(
int index);
/**
*
* Type of band
*
*
* optional .yamcs.protobuf.timeline.TimelineBandType type = 9;
* @return Whether the type field is set.
*/
boolean hasType();
/**
*
* Type of band
*
*
* optional .yamcs.protobuf.timeline.TimelineBandType type = 9;
* @return The type.
*/
org.yamcs.protobuf.TimelineBandType getType();
/**
*
* Band description
*
*
* optional string description = 10;
* @return Whether the description field is set.
*/
boolean hasDescription();
/**
*
* Band description
*
*
* optional string description = 10;
* @return The description.
*/
java.lang.String getDescription();
/**
*
* Band description
*
*
* optional string description = 10;
* @return The bytes for description.
*/
com.google.protobuf.ByteString
getDescriptionBytes();
/**
*
* Additional properties used by yamcs-web to render this band
*
*
* map<string, string> properties = 11;
*/
int getPropertiesCount();
/**
*
* Additional properties used by yamcs-web to render this band
*
*
* map<string, string> properties = 11;
*/
boolean containsProperties(
java.lang.String key);
/**
* Use {@link #getPropertiesMap()} instead.
*/
@java.lang.Deprecated
java.util.Map
getProperties();
/**
*
* Additional properties used by yamcs-web to render this band
*
*
* map<string, string> properties = 11;
*/
java.util.Map
getPropertiesMap();
/**
*
* Additional properties used by yamcs-web to render this band
*
*
* map<string, string> properties = 11;
*/
java.lang.String getPropertiesOrDefault(
java.lang.String key,
java.lang.String defaultValue);
/**
*
* Additional properties used by yamcs-web to render this band
*
*
* map<string, string> properties = 11;
*/
java.lang.String getPropertiesOrThrow(
java.lang.String key);
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy