org.yamcs.protobuf.links.LinkInfoOrBuilder 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/links/links.proto

package org.yamcs.protobuf.links;

public interface LinkInfoOrBuilder extends
    // @@protoc_insertion_point(interface_extends:yamcs.protobuf.links.LinkInfo)
    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();

  /**
   *    * Link name
   * 
   *
   * optional string name = 2;
   * @return Whether the name field is set.
   */
  boolean hasName();
  /**
   *    * Link name
   * 
   *
   * optional string name = 2;
   * @return The name.
   */
  java.lang.String getName();
  /**
   *    * Link name
   * 
   *
   * optional string name = 2;
   * @return The bytes for name.
   */
  com.google.protobuf.ByteString
      getNameBytes();

  /**
   *    * Java class name
   * 
   *
   * optional string type = 3;
   * @return Whether the type field is set.
   */
  boolean hasType();
  /**
   *    * Java class name
   * 
   *
   * optional string type = 3;
   * @return The type.
   */
  java.lang.String getType();
  /**
   *    * Java class name
   * 
   *
   * optional string type = 3;
   * @return The bytes for type.
   */
  com.google.protobuf.ByteString
      getTypeBytes();

  /**
   *    * Configuration
   * 
   *
   * optional string spec = 4;
   * @return Whether the spec field is set.
   */
  boolean hasSpec();
  /**
   *    * Configuration
   * 
   *
   * optional string spec = 4;
   * @return The spec.
   */
  java.lang.String getSpec();
  /**
   *    * Configuration
   * 
   *
   * optional string spec = 4;
   * @return The bytes for spec.
   */
  com.google.protobuf.ByteString
      getSpecBytes();

  /**
   *    * Whether this link is currently disabled.
   * 
   *
   * optional bool disabled = 6;
   * @return Whether the disabled field is set.
   */
  boolean hasDisabled();
  /**
   *    * Whether this link is currently disabled.
   * 
   *
   * optional bool disabled = 6;
   * @return The disabled.
   */
  boolean getDisabled();

  /**
   * optional string status = 7;
   * @return Whether the status field is set.
   */
  boolean hasStatus();
  /**
   * optional string status = 7;
   * @return The status.
   */
  java.lang.String getStatus();
  /**
   * optional string status = 7;
   * @return The bytes for status.
   */
  com.google.protobuf.ByteString
      getStatusBytes();

  /**
   *    * Counter of inbound (received) data.
   * The unit of this is specific to each link.
   * 
   *
   * optional int64 dataInCount = 10;
   * @return Whether the dataInCount field is set.
   */
  boolean hasDataInCount();
  /**
   *    * Counter of inbound (received) data.
   * The unit of this is specific to each link.
   * 
   *
   * optional int64 dataInCount = 10;
   * @return The dataInCount.
   */
  long getDataInCount();

  /**
   *    * Counter of outbound (transmitted) data.
   * The unit of this is specific to each link.
   * 
   *
   * optional int64 dataOutCount = 11;
   * @return Whether the dataOutCount field is set.
   */
  boolean hasDataOutCount();
  /**
   *    * Counter of outbound (transmitted) data.
   * The unit of this is specific to each link.
   * 
   *
   * optional int64 dataOutCount = 11;
   * @return The dataOutCount.
   */
  long getDataOutCount();

  /**
   *    * Short status information
   * 
   *
   * optional string detailedStatus = 9;
   * @return Whether the detailedStatus field is set.
   */
  boolean hasDetailedStatus();
  /**
   *    * Short status information
   * 
   *
   * optional string detailedStatus = 9;
   * @return The detailedStatus.
   */
  java.lang.String getDetailedStatus();
  /**
   *    * Short status information
   * 
   *
   * optional string detailedStatus = 9;
   * @return The bytes for detailedStatus.
   */
  com.google.protobuf.ByteString
      getDetailedStatusBytes();

  /**
   *    *if this is a sublink of an aggregated data link, this is the name of the parent
   * 
   *
   * optional string parentName = 12;
   * @return Whether the parentName field is set.
   */
  boolean hasParentName();
  /**
   *    *if this is a sublink of an aggregated data link, this is the name of the parent
   * 
   *
   * optional string parentName = 12;
   * @return The parentName.
   */
  java.lang.String getParentName();
  /**
   *    *if this is a sublink of an aggregated data link, this is the name of the parent
   * 
   *
   * optional string parentName = 12;
   * @return The bytes for parentName.
   */
  com.google.protobuf.ByteString
      getParentNameBytes();

  /**
   *    * Custom actions
   * 
   *
   * repeated .yamcs.protobuf.actions.ActionInfo actions = 13;
   */
  java.util.List 
      getActionsList();
  /**
   *    * Custom actions
   * 
   *
   * repeated .yamcs.protobuf.actions.ActionInfo actions = 13;
   */
  org.yamcs.protobuf.actions.ActionInfo getActions(int index);
  /**
   *    * Custom actions
   * 
   *
   * repeated .yamcs.protobuf.actions.ActionInfo actions = 13;
   */
  int getActionsCount();
  /**
   *    * Custom actions
   * 
   *
   * repeated .yamcs.protobuf.actions.ActionInfo actions = 13;
   */
  java.util.List 
      getActionsOrBuilderList();
  /**
   *    * Custom actions
   * 
   *
   * repeated .yamcs.protobuf.actions.ActionInfo actions = 13;
   */
  org.yamcs.protobuf.actions.ActionInfoOrBuilder getActionsOrBuilder(
      int index);

  /**
   *    * Custom info fields
   * 
   *
   * optional .google.protobuf.Struct extra = 14;
   * @return Whether the extra field is set.
   */
  boolean hasExtra();
  /**
   *    * Custom info fields
   * 
   *
   * optional .google.protobuf.Struct extra = 14;
   * @return The extra.
   */
  com.google.protobuf.Struct getExtra();
  /**
   *    * Custom info fields
   * 
   *
   * optional .google.protobuf.Struct extra = 14;
   */
  com.google.protobuf.StructOrBuilder getExtraOrBuilder();

  /**
   *    * System parameters generated by this link
   * 
   *
   * repeated string parameters = 15;
   * @return A list containing the parameters.
   */
  java.util.List
      getParametersList();
  /**
   *    * System parameters generated by this link
   * 
   *
   * repeated string parameters = 15;
   * @return The count of parameters.
   */
  int getParametersCount();
  /**
   *    * System parameters generated by this link
   * 
   *
   * repeated string parameters = 15;
   * @param index The index of the element to return.
   * @return The parameters at the given index.
   */
  java.lang.String getParameters(int index);
  /**
   *    * System parameters generated by this link
   * 
   *
   * repeated string parameters = 15;
   * @param index The index of the value to return.
   * @return The bytes of the parameters at the given index.
   */
  com.google.protobuf.ByteString
      getParametersBytes(int index);
}