org.yamcs.protobuf.alarms.EditAlarmRequestOrBuilder 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/alarms/alarms_service.proto

package org.yamcs.protobuf.alarms;

public interface EditAlarmRequestOrBuilder extends
    // @@protoc_insertion_point(interface_extends:yamcs.protobuf.alarms.EditAlarmRequest)
    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();

  /**
   *    * Processor name
   * 
   *
   * optional string processor = 2;
   * @return Whether the processor field is set.
   */
  boolean hasProcessor();
  /**
   *    * Processor name
   * 
   *
   * optional string processor = 2;
   * @return The processor.
   */
  java.lang.String getProcessor();
  /**
   *    * Processor name
   * 
   *
   * optional string processor = 2;
   * @return The bytes for processor.
   */
  com.google.protobuf.ByteString
      getProcessorBytes();

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

  /**
   * optional uint32 seqnum = 4;
   * @return Whether the seqnum field is set.
   */
  boolean hasSeqnum();
  /**
   * optional uint32 seqnum = 4;
   * @return The seqnum.
   */
  int getSeqnum();

  /**
   *    * **Required.** The state of the alarm. 
   * Either ``acknowledged``, ``shelved``, ``unshelved`` or ``cleared``.
   * 
   *
   * optional string state = 5;
   * @return Whether the state field is set.
   */
  boolean hasState();
  /**
   *    * **Required.** The state of the alarm. 
   * Either ``acknowledged``, ``shelved``, ``unshelved`` or ``cleared``.
   * 
   *
   * optional string state = 5;
   * @return The state.
   */
  java.lang.String getState();
  /**
   *    * **Required.** The state of the alarm. 
   * Either ``acknowledged``, ``shelved``, ``unshelved`` or ``cleared``.
   * 
   *
   * optional string state = 5;
   * @return The bytes for state.
   */
  com.google.protobuf.ByteString
      getStateBytes();

  /**
   *    * Message documenting the alarm change.
   * 
   *
   * optional string comment = 6;
   * @return Whether the comment field is set.
   */
  boolean hasComment();
  /**
   *    * Message documenting the alarm change.
   * 
   *
   * optional string comment = 6;
   * @return The comment.
   */
  java.lang.String getComment();
  /**
   *    * Message documenting the alarm change.
   * 
   *
   * optional string comment = 6;
   * @return The bytes for comment.
   */
  com.google.protobuf.ByteString
      getCommentBytes();

  /**
   *    *shelve time in milliseconds (if the state = shelved)
   *can be left out which means it is shelved indefinitely
   * 
   *
   * optional uint64 shelveDuration = 7;
   * @return Whether the shelveDuration field is set.
   */
  boolean hasShelveDuration();
  /**
   *    *shelve time in milliseconds (if the state = shelved)
   *can be left out which means it is shelved indefinitely
   * 
   *
   * optional uint64 shelveDuration = 7;
   * @return The shelveDuration.
   */
  long getShelveDuration();
}