Package org.yamcs.protobuf.alarms

Interface EditAlarmRequestOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    EditAlarmRequest, EditAlarmRequest.Builder
    public interface EditAlarmRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      String getComment()
      Message documenting the alarm change.
      com.google.protobuf.ByteString getCommentBytes()
      Message documenting the alarm change.
      String getInstance()
      Yamcs instance name.
      com.google.protobuf.ByteString getInstanceBytes()
      Yamcs instance name.
      String getName()
      Alarm name.
      com.google.protobuf.ByteString getNameBytes()
      Alarm name.
      String getProcessor()
      Processor name.
      com.google.protobuf.ByteString getProcessorBytes()
      Processor name.
      int getSeqnum()
      optional uint32 seqnum = 4;
      long getShelveDuration()
      shelve time in milliseconds (if the state = shelved) can be left out which means it is shelved indefinitely
      String getState()
      **Required.** The state of the alarm.
      com.google.protobuf.ByteString getStateBytes()
      **Required.** The state of the alarm.
      boolean hasComment()
      Message documenting the alarm change.
      boolean hasInstance()
      Yamcs instance name.
      boolean hasName()
      Alarm name.
      boolean hasProcessor()
      Processor name.
      boolean hasSeqnum()
      optional uint32 seqnum = 4;
      boolean hasShelveDuration()
      shelve time in milliseconds (if the state = shelved) can be left out which means it is shelved indefinitely
      boolean hasState()
      **Required.** The state of the alarm.

      • Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

        isInitialized

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

    • Method Detail

      • hasInstance

        boolean hasInstance()
         Yamcs instance name.
        optional string instance = 1;

      • getInstance

        String getInstance()
         Yamcs instance name.
        optional string instance = 1;

      • getInstanceBytes

        com.google.protobuf.ByteString getInstanceBytes()
         Yamcs instance name.
        optional string instance = 1;

      • hasProcessor

        boolean hasProcessor()
         Processor name.
        optional string processor = 2;

      • getProcessor

        String getProcessor()
         Processor name.
        optional string processor = 2;

      • getProcessorBytes

        com.google.protobuf.ByteString getProcessorBytes()
         Processor name.
        optional string processor = 2;

      • hasName

        boolean hasName()
         Alarm name.
        optional string name = 3;

      • getName

        String getName()
         Alarm name.
        optional string name = 3;

      • getNameBytes

        com.google.protobuf.ByteString getNameBytes()
         Alarm name.
        optional string name = 3;

      • hasSeqnum

        boolean hasSeqnum()
        optional uint32 seqnum = 4;

      • getSeqnum

        int getSeqnum()
        optional uint32 seqnum = 4;

      • hasState

        boolean hasState()
         **Required.** The state of the alarm. 
 Either ``acknowledged``, ``shelved``, ``unshelved`` or ``cleared``.
        optional string state = 5;

      • getState

        String getState()
         **Required.** The state of the alarm. 
 Either ``acknowledged``, ``shelved``, ``unshelved`` or ``cleared``.
        optional string state = 5;

      • getStateBytes

        com.google.protobuf.ByteString getStateBytes()
         **Required.** The state of the alarm. 
 Either ``acknowledged``, ``shelved``, ``unshelved`` or ``cleared``.
        optional string state = 5;

      • hasComment

        boolean hasComment()
         Message documenting the alarm change.
        optional string comment = 6;

      • getComment

        String getComment()
         Message documenting the alarm change.
        optional string comment = 6;

      • getCommentBytes

        com.google.protobuf.ByteString getCommentBytes()
         Message documenting the alarm change.
        optional string comment = 6;

      • hasShelveDuration

        boolean hasShelveDuration()
        shelve time in milliseconds (if the state = shelved)
can be left out which means it is shelved indefinitely
        optional uint64 shelveDuration = 7;

      • getShelveDuration

        long getShelveDuration()
        shelve time in milliseconds (if the state = shelved)
can be left out which means it is shelved indefinitely
        optional uint64 shelveDuration = 7;