org.yamcs.protobuf.UpdateBandRequestOrBuilder 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
Used by external clients to communicate with Yamcs
There is a newer version: 5.10.9
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: yamcs/protobuf/timeline/timeline.proto

package org.yamcs.protobuf;

public interface UpdateBandRequestOrBuilder extends
    // @@protoc_insertion_point(interface_extends:yamcs.protobuf.timeline.UpdateBandRequest)
    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
   * 
   *
   * optional string id = 2;
   * @return Whether the id field is set.
   */
  boolean hasId();
  /**
   *    * Band identifier
   * 
   *
   * optional string id = 2;
   * @return The id.
   */
  java.lang.String getId();
  /**
   *    * Band identifier
   * 
   *
   * 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();

  /**
   *    * Band description
   * 
   *
   * optional string description = 4;
   * @return Whether the description field is set.
   */
  boolean hasDescription();
  /**
   *    * Band description
   * 
   *
   * optional string description = 4;
   * @return The description.
   */
  java.lang.String getDescription();
  /**
   *    * Band description
   * 
   *
   * optional string description = 4;
   * @return The bytes for description.
   */
  com.google.protobuf.ByteString
      getDescriptionBytes();

  /**
   *    * 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();

  /**
   *    * Items containing these tags will be part of the timeline
   * 
   *
   * repeated string tags = 6;
   * @return A list containing the tags.
   */
  java.util.List
      getTagsList();
  /**
   *    * Items containing these tags will be part of the timeline
   * 
   *
   * repeated string tags = 6;
   * @return The count of tags.
   */
  int getTagsCount();
  /**
   *    * Items containing these tags will be part of the timeline
   * 
   *
   * repeated string tags = 6;
   * @param index The index of the element to return.
   * @return The tags at the given index.
   */
  java.lang.String getTags(int index);
  /**
   *    * Items containing these tags will be part of the timeline
   * 
   *
   * repeated string tags = 6;
   * @param index The index of the value to return.
   * @return The bytes of the tags at the given index.
   */
  com.google.protobuf.ByteString
      getTagsBytes(int index);

  /**
   *    * Additional properties used by yamcs-web to render this band
   * 
   *
   * map<string, string> properties = 7;
   */
  int getPropertiesCount();
  /**
   *    * Additional properties used by yamcs-web to render this band
   * 
   *
   * map<string, string> properties = 7;
   */
  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 = 7;
   */
  java.util.Map
  getPropertiesMap();
  /**
   *    * Additional properties used by yamcs-web to render this band
   * 
   *
   * map<string, string> properties = 7;
   */

  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 = 7;
   */

  java.lang.String getPropertiesOrThrow(
      java.lang.String key);

  /**
   *    * Where the items shown on this band come from
   * 
   *
   * optional string source = 8;
   * @return Whether the source field is set.
   */
  boolean hasSource();
  /**
   *    * Where the items shown on this band come from
   * 
   *
   * optional string source = 8;
   * @return The source.
   */
  java.lang.String getSource();
  /**
   *    * Where the items shown on this band come from
   * 
   *
   * optional string source = 8;
   * @return The bytes for source.
   */
  com.google.protobuf.ByteString
      getSourceBytes();

  /**
   *    * Filters to apply when retrieving items
   * 
   *
   * repeated .yamcs.protobuf.timeline.ItemFilter filters = 9;
   */
  java.util.List 
      getFiltersList();
  /**
   *    * Filters to apply when retrieving items
   * 
   *
   * repeated .yamcs.protobuf.timeline.ItemFilter filters = 9;
   */
  org.yamcs.protobuf.ItemFilter getFilters(int index);
  /**
   *    * Filters to apply when retrieving items
   * 
   *
   * repeated .yamcs.protobuf.timeline.ItemFilter filters = 9;
   */
  int getFiltersCount();
  /**
   *    * Filters to apply when retrieving items
   * 
   *
   * repeated .yamcs.protobuf.timeline.ItemFilter filters = 9;
   */
  java.util.List 
      getFiltersOrBuilderList();
  /**
   *    * Filters to apply when retrieving items
   * 
   *
   * repeated .yamcs.protobuf.timeline.ItemFilter filters = 9;
   */
  org.yamcs.protobuf.ItemFilterOrBuilder getFiltersOrBuilder(
      int index);
}