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

Interface YamcsInstanceOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
YamcsInstance, YamcsInstance.Builder
public interface YamcsInstanceOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • hasName

      boolean hasName()
       Instance name.
      optional string name = 1;
      Returns:
      Whether the name field is set.

    • getName

      String getName()
       Instance name.
      optional string name = 1;
      Returns:
      The name.

    • getNameBytes

      com.google.protobuf.ByteString getNameBytes()
       Instance name.
      optional string name = 1;
      Returns:
      The bytes for name.

    • hasMissionDatabase

      boolean hasMissionDatabase()
      optional .yamcs.protobuf.mdb.MissionDatabase missionDatabase = 3;
      Returns:
      Whether the missionDatabase field is set.

    • getMissionDatabase

      Mdb.MissionDatabase getMissionDatabase()
      optional .yamcs.protobuf.mdb.MissionDatabase missionDatabase = 3;
      Returns:
      The missionDatabase.

    • getMissionDatabaseOrBuilder

      Mdb.MissionDatabaseOrBuilder getMissionDatabaseOrBuilder()
      optional .yamcs.protobuf.mdb.MissionDatabase missionDatabase = 3;

    • getProcessorsList

      List<ProcessorInfo> getProcessorsList()
      repeated .yamcs.protobuf.yamcsManagement.ProcessorInfo processors = 4;

    • getProcessors

      ProcessorInfo getProcessors(int index)
      repeated .yamcs.protobuf.yamcsManagement.ProcessorInfo processors = 4;

    • getProcessorsCount

      int getProcessorsCount()
      repeated .yamcs.protobuf.yamcsManagement.ProcessorInfo processors = 4;

    • getProcessorsOrBuilderList

      List<? extends ProcessorInfoOrBuilder> getProcessorsOrBuilderList()
      repeated .yamcs.protobuf.yamcsManagement.ProcessorInfo processors = 4;

    • getProcessorsOrBuilder

      ProcessorInfoOrBuilder getProcessorsOrBuilder(int index)
      repeated .yamcs.protobuf.yamcsManagement.ProcessorInfo processors = 4;

    • hasState

      boolean hasState()
      optional .yamcs.protobuf.instances.YamcsInstance.InstanceState state = 11;
      Returns:
      Whether the state field is set.

    • getState

      YamcsInstance.InstanceState getState()
      optional .yamcs.protobuf.instances.YamcsInstance.InstanceState state = 11;
      Returns:
      The state.

    • hasFailureCause

      boolean hasFailureCause()
      in case the state=FAILED, this field will indicate the cause of the failure
 the missionDatabase and other fields may not be filled when this happens
      optional string failureCause = 9;
      Returns:
      Whether the failureCause field is set.

    • getFailureCause

      String getFailureCause()
      in case the state=FAILED, this field will indicate the cause of the failure
 the missionDatabase and other fields may not be filled when this happens
      optional string failureCause = 9;
      Returns:
      The failureCause.

    • getFailureCauseBytes

      com.google.protobuf.ByteString getFailureCauseBytes()
      in case the state=FAILED, this field will indicate the cause of the failure
 the missionDatabase and other fields may not be filled when this happens
      optional string failureCause = 9;
      Returns:
      The bytes for failureCause.

    • hasMissionTime

      boolean hasMissionTime()
      optional .google.protobuf.Timestamp missionTime = 10;
      Returns:
      Whether the missionTime field is set.

    • getMissionTime

      com.google.protobuf.Timestamp getMissionTime()
      optional .google.protobuf.Timestamp missionTime = 10;
      Returns:
      The missionTime.

    • getMissionTimeOrBuilder

      com.google.protobuf.TimestampOrBuilder getMissionTimeOrBuilder()
      optional .google.protobuf.Timestamp missionTime = 10;

    • getLabelsCount

      int getLabelsCount()
       Labels assigned to this instance. Each entry is keyed by the tag name
 of the label. The value represent the label value for that tag.
      map<string, string> labels = 12;

    • containsLabels

      boolean containsLabels(String key)
       Labels assigned to this instance. Each entry is keyed by the tag name
 of the label. The value represent the label value for that tag.
      map<string, string> labels = 12;

    • getLabels

      @Deprecated Map<String,String> getLabels()
      Deprecated.
      Use getLabelsMap() instead.

    • getLabelsMap

      Map<String,String> getLabelsMap()
       Labels assigned to this instance. Each entry is keyed by the tag name
 of the label. The value represent the label value for that tag.
      map<string, string> labels = 12;

    • getLabelsOrDefault

      String getLabelsOrDefault(String key, String defaultValue)
       Labels assigned to this instance. Each entry is keyed by the tag name
 of the label. The value represent the label value for that tag.
      map<string, string> labels = 12;

    • getLabelsOrThrow

      String getLabelsOrThrow(String key)
       Labels assigned to this instance. Each entry is keyed by the tag name
 of the label. The value represent the label value for that tag.
      map<string, string> labels = 12;

    • getCapabilitiesList

      List<String> getCapabilitiesList()
       Feature capability hints for client use
      repeated string capabilities = 13;
      Returns:
      A list containing the capabilities.

    • getCapabilitiesCount

      int getCapabilitiesCount()
       Feature capability hints for client use
      repeated string capabilities = 13;
      Returns:
      The count of capabilities.

    • getCapabilities

      String getCapabilities(int index)
       Feature capability hints for client use
      repeated string capabilities = 13;
      Parameters:
      index - The index of the element to return.
      Returns:
      The capabilities at the given index.

    • getCapabilitiesBytes

      com.google.protobuf.ByteString getCapabilitiesBytes(int index)
       Feature capability hints for client use
      repeated string capabilities = 13;
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the capabilities at the given index.

    • hasTemplate

      boolean hasTemplate()
       Name of the template, if this instance was generated
      optional string template = 14;
      Returns:
      Whether the template field is set.

    • getTemplate

      String getTemplate()
       Name of the template, if this instance was generated
      optional string template = 14;
      Returns:
      The template.

    • getTemplateBytes

      com.google.protobuf.ByteString getTemplateBytes()
       Name of the template, if this instance was generated
      optional string template = 14;
      Returns:
      The bytes for template.

    • getTemplateArgsCount

      int getTemplateArgsCount()
       Arguments used during template processing, if this instance
 was generated
      map<string, string> templateArgs = 15;

    • containsTemplateArgs

      boolean containsTemplateArgs(String key)
       Arguments used during template processing, if this instance
 was generated
      map<string, string> templateArgs = 15;

    • getTemplateArgs

      @Deprecated Map<String,String> getTemplateArgs()
      Deprecated.
      Use getTemplateArgsMap() instead.

    • getTemplateArgsMap

      Map<String,String> getTemplateArgsMap()
       Arguments used during template processing, if this instance
 was generated
      map<string, string> templateArgs = 15;

    • getTemplateArgsOrDefault

      String getTemplateArgsOrDefault(String key, String defaultValue)
       Arguments used during template processing, if this instance
 was generated
      map<string, string> templateArgs = 15;

    • getTemplateArgsOrThrow

      String getTemplateArgsOrThrow(String key)
       Arguments used during template processing, if this instance
 was generated
      map<string, string> templateArgs = 15;

    • hasTemplateAvailable

      boolean hasTemplateAvailable()
       Whether the template is stil available
      optional bool templateAvailable = 16;
      Returns:
      Whether the templateAvailable field is set.

    • getTemplateAvailable

      boolean getTemplateAvailable()
       Whether the template is stil available
      optional bool templateAvailable = 16;
      Returns:
      The templateAvailable.

    • hasTemplateChanged

      boolean hasTemplateChanged()
       Whether the template has changed since this instance was
 generated
      optional bool templateChanged = 17;
      Returns:
      Whether the templateChanged field is set.

    • getTemplateChanged

      boolean getTemplateChanged()
       Whether the template has changed since this instance was
 generated
      optional bool templateChanged = 17;
      Returns:
      The templateChanged.