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

Class YamcsInstance

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
org.yamcs.protobuf.YamcsInstance
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable, YamcsInstanceOrBuilder
@Generated public final class YamcsInstance extends com.google.protobuf.GeneratedMessage implements YamcsInstanceOrBuilder
Protobuf type yamcs.protobuf.instances.YamcsInstance
See Also:

  • Field Details

    • NAME_FIELD_NUMBER

      public static final int NAME_FIELD_NUMBER
      See Also:

    • MISSIONDATABASE_FIELD_NUMBER

      public static final int MISSIONDATABASE_FIELD_NUMBER
      See Also:

    • PROCESSORS_FIELD_NUMBER

      public static final int PROCESSORS_FIELD_NUMBER
      See Also:

    • STATE_FIELD_NUMBER

      public static final int STATE_FIELD_NUMBER
      See Also:

    • FAILURECAUSE_FIELD_NUMBER

      public static final int FAILURECAUSE_FIELD_NUMBER
      See Also:

    • MISSIONTIME_FIELD_NUMBER

      public static final int MISSIONTIME_FIELD_NUMBER
      See Also:

    • LABELS_FIELD_NUMBER

      public static final int LABELS_FIELD_NUMBER
      See Also:

    • CAPABILITIES_FIELD_NUMBER

      public static final int CAPABILITIES_FIELD_NUMBER
      See Also:

    • TEMPLATE_FIELD_NUMBER

      public static final int TEMPLATE_FIELD_NUMBER
      See Also:

    • TEMPLATEARGS_FIELD_NUMBER

      public static final int TEMPLATEARGS_FIELD_NUMBER
      See Also:

    • TEMPLATEAVAILABLE_FIELD_NUMBER

      public static final int TEMPLATEAVAILABLE_FIELD_NUMBER
      See Also:

    • TEMPLATECHANGED_FIELD_NUMBER

      public static final int TEMPLATECHANGED_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage

    • internalGetMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
      Overrides:
      internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessage

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • hasName

      public boolean hasName()
       Instance name.
      optional string name = 1;
      Specified by:
      hasName in interface YamcsInstanceOrBuilder
      Returns:
      Whether the name field is set.

    • getName

      public String getName()
       Instance name.
      optional string name = 1;
      Specified by:
      getName in interface YamcsInstanceOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
       Instance name.
      optional string name = 1;
      Specified by:
      getNameBytes in interface YamcsInstanceOrBuilder
      Returns:
      The bytes for name.

    • hasMissionDatabase

      public boolean hasMissionDatabase()
      optional .yamcs.protobuf.mdb.MissionDatabase missionDatabase = 3;
      Specified by:
      hasMissionDatabase in interface YamcsInstanceOrBuilder
      Returns:
      Whether the missionDatabase field is set.

    • getMissionDatabase

      public Mdb.MissionDatabase getMissionDatabase()
      optional .yamcs.protobuf.mdb.MissionDatabase missionDatabase = 3;
      Specified by:
      getMissionDatabase in interface YamcsInstanceOrBuilder
      Returns:
      The missionDatabase.

    • getMissionDatabaseOrBuilder

      public Mdb.MissionDatabaseOrBuilder getMissionDatabaseOrBuilder()
      optional .yamcs.protobuf.mdb.MissionDatabase missionDatabase = 3;
      Specified by:
      getMissionDatabaseOrBuilder in interface YamcsInstanceOrBuilder

    • getProcessorsList

      public List<ProcessorInfo> getProcessorsList()
      repeated .yamcs.protobuf.yamcsManagement.ProcessorInfo processors = 4;
      Specified by:
      getProcessorsList in interface YamcsInstanceOrBuilder

    • getProcessorsOrBuilderList

      public List<? extends ProcessorInfoOrBuilder> getProcessorsOrBuilderList()
      repeated .yamcs.protobuf.yamcsManagement.ProcessorInfo processors = 4;
      Specified by:
      getProcessorsOrBuilderList in interface YamcsInstanceOrBuilder

    • getProcessorsCount

      public int getProcessorsCount()
      repeated .yamcs.protobuf.yamcsManagement.ProcessorInfo processors = 4;
      Specified by:
      getProcessorsCount in interface YamcsInstanceOrBuilder

    • getProcessors

      public ProcessorInfo getProcessors(int index)
      repeated .yamcs.protobuf.yamcsManagement.ProcessorInfo processors = 4;
      Specified by:
      getProcessors in interface YamcsInstanceOrBuilder

    • getProcessorsOrBuilder

      public ProcessorInfoOrBuilder getProcessorsOrBuilder(int index)
      repeated .yamcs.protobuf.yamcsManagement.ProcessorInfo processors = 4;
      Specified by:
      getProcessorsOrBuilder in interface YamcsInstanceOrBuilder

    • hasState

      public boolean hasState()
      optional .yamcs.protobuf.instances.YamcsInstance.InstanceState state = 11;
      Specified by:
      hasState in interface YamcsInstanceOrBuilder
      Returns:
      Whether the state field is set.

    • getState

      public YamcsInstance.InstanceState getState()
      optional .yamcs.protobuf.instances.YamcsInstance.InstanceState state = 11;
      Specified by:
      getState in interface YamcsInstanceOrBuilder
      Returns:
      The state.

    • hasFailureCause

      public 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;
      Specified by:
      hasFailureCause in interface YamcsInstanceOrBuilder
      Returns:
      Whether the failureCause field is set.

    • getFailureCause

      public 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;
      Specified by:
      getFailureCause in interface YamcsInstanceOrBuilder
      Returns:
      The failureCause.

    • getFailureCauseBytes

      public 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;
      Specified by:
      getFailureCauseBytes in interface YamcsInstanceOrBuilder
      Returns:
      The bytes for failureCause.

    • hasMissionTime

      public boolean hasMissionTime()
      optional .google.protobuf.Timestamp missionTime = 10;
      Specified by:
      hasMissionTime in interface YamcsInstanceOrBuilder
      Returns:
      Whether the missionTime field is set.

    • getMissionTime

      public com.google.protobuf.Timestamp getMissionTime()
      optional .google.protobuf.Timestamp missionTime = 10;
      Specified by:
      getMissionTime in interface YamcsInstanceOrBuilder
      Returns:
      The missionTime.

    • getMissionTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getMissionTimeOrBuilder()
      optional .google.protobuf.Timestamp missionTime = 10;
      Specified by:
      getMissionTimeOrBuilder in interface YamcsInstanceOrBuilder

    • getLabelsCount

      public int getLabelsCount()
      Description copied from interface: YamcsInstanceOrBuilder
       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;
      Specified by:
      getLabelsCount in interface YamcsInstanceOrBuilder

    • containsLabels

      public 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;
      Specified by:
      containsLabels in interface YamcsInstanceOrBuilder

    • getLabels

      @Deprecated public Map<String,String> getLabels()
      Deprecated.
      Use getLabelsMap() instead.
      Specified by:
      getLabels in interface YamcsInstanceOrBuilder

    • getLabelsMap

      public 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;
      Specified by:
      getLabelsMap in interface YamcsInstanceOrBuilder

    • getLabelsOrDefault

      public 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;
      Specified by:
      getLabelsOrDefault in interface YamcsInstanceOrBuilder

    • getLabelsOrThrow

      public 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;
      Specified by:
      getLabelsOrThrow in interface YamcsInstanceOrBuilder

    • getCapabilitiesList

      public com.google.protobuf.ProtocolStringList getCapabilitiesList()
       Feature capability hints for client use
      repeated string capabilities = 13;
      Specified by:
      getCapabilitiesList in interface YamcsInstanceOrBuilder
      Returns:
      A list containing the capabilities.

    • getCapabilitiesCount

      public int getCapabilitiesCount()
       Feature capability hints for client use
      repeated string capabilities = 13;
      Specified by:
      getCapabilitiesCount in interface YamcsInstanceOrBuilder
      Returns:
      The count of capabilities.

    • getCapabilities

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

    • getCapabilitiesBytes

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

    • hasTemplate

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

    • getTemplate

      public String getTemplate()
       Name of the template, if this instance was generated
      optional string template = 14;
      Specified by:
      getTemplate in interface YamcsInstanceOrBuilder
      Returns:
      The template.

    • getTemplateBytes

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

    • getTemplateArgsCount

      public int getTemplateArgsCount()
      Description copied from interface: YamcsInstanceOrBuilder
       Arguments used during template processing, if this instance
 was generated
      map<string, string> templateArgs = 15;
      Specified by:
      getTemplateArgsCount in interface YamcsInstanceOrBuilder

    • containsTemplateArgs

      public boolean containsTemplateArgs(String key)
       Arguments used during template processing, if this instance
 was generated
      map<string, string> templateArgs = 15;
      Specified by:
      containsTemplateArgs in interface YamcsInstanceOrBuilder

    • getTemplateArgs

      @Deprecated public Map<String,String> getTemplateArgs()
      Deprecated.
      Use getTemplateArgsMap() instead.
      Specified by:
      getTemplateArgs in interface YamcsInstanceOrBuilder

    • getTemplateArgsMap

      public Map<String,String> getTemplateArgsMap()
       Arguments used during template processing, if this instance
 was generated
      map<string, string> templateArgs = 15;
      Specified by:
      getTemplateArgsMap in interface YamcsInstanceOrBuilder

    • getTemplateArgsOrDefault

      public String getTemplateArgsOrDefault(String key, String defaultValue)
       Arguments used during template processing, if this instance
 was generated
      map<string, string> templateArgs = 15;
      Specified by:
      getTemplateArgsOrDefault in interface YamcsInstanceOrBuilder

    • getTemplateArgsOrThrow

      public String getTemplateArgsOrThrow(String key)
       Arguments used during template processing, if this instance
 was generated
      map<string, string> templateArgs = 15;
      Specified by:
      getTemplateArgsOrThrow in interface YamcsInstanceOrBuilder

    • hasTemplateAvailable

      public boolean hasTemplateAvailable()
       Whether the template is stil available
      optional bool templateAvailable = 16;
      Specified by:
      hasTemplateAvailable in interface YamcsInstanceOrBuilder
      Returns:
      Whether the templateAvailable field is set.

    • getTemplateAvailable

      public boolean getTemplateAvailable()
       Whether the template is stil available
      optional bool templateAvailable = 16;
      Specified by:
      getTemplateAvailable in interface YamcsInstanceOrBuilder
      Returns:
      The templateAvailable.

    • hasTemplateChanged

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

    • getTemplateChanged

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

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static YamcsInstance parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static YamcsInstance parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static YamcsInstance parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static YamcsInstance parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static YamcsInstance parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static YamcsInstance parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static YamcsInstance parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static YamcsInstance parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static YamcsInstance parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static YamcsInstance parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static YamcsInstance parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static YamcsInstance parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public YamcsInstance.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static YamcsInstance.Builder newBuilder()

    • newBuilder

      public static YamcsInstance.Builder newBuilder(YamcsInstance prototype)

    • toBuilder

      public YamcsInstance.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected YamcsInstance.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static YamcsInstance getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<YamcsInstance> parser()

    • getParserForType

      public com.google.protobuf.Parser<YamcsInstance> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public YamcsInstance getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder