Package org.yamcs.protobuf.alarms

Interface ShelveAlarmRequestOrBuilder

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

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      String getAlarm()
      Alarm name.
      com.google.protobuf.ByteString getAlarmBytes()
      Alarm name.
      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 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
      boolean hasAlarm()
      Alarm name.
      boolean hasComment()
      Message documenting the alarm change.
      boolean hasInstance()
      Yamcs instance 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

      • 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;
        Returns:
        Whether the instance field is set.

      • getInstance

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

      • getInstanceBytes

        com.google.protobuf.ByteString getInstanceBytes()
         Yamcs instance name.
        optional string instance = 1;
        Returns:
        The bytes for instance.

      • hasProcessor

        boolean hasProcessor()
         Processor name.
        optional string processor = 2;
        Returns:
        Whether the processor field is set.

      • getProcessor

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

      • getProcessorBytes

        com.google.protobuf.ByteString getProcessorBytes()
         Processor name.
        optional string processor = 2;
        Returns:
        The bytes for processor.

      • hasAlarm

        boolean hasAlarm()
         Alarm name.
        optional string alarm = 3;
        Returns:
        Whether the alarm field is set.

      • getAlarm

        String getAlarm()
         Alarm name.
        optional string alarm = 3;
        Returns:
        The alarm.

      • getAlarmBytes

        com.google.protobuf.ByteString getAlarmBytes()
         Alarm name.
        optional string alarm = 3;
        Returns:
        The bytes for alarm.

      • hasSeqnum

        boolean hasSeqnum()
        optional uint32 seqnum = 4;
        Returns:
        Whether the seqnum field is set.

      • getSeqnum

        int getSeqnum()
        optional uint32 seqnum = 4;
        Returns:
        The seqnum.

      • hasComment

        boolean hasComment()
         Message documenting the alarm change.
        optional string comment = 5;
        Returns:
        Whether the comment field is set.

      • getComment

        String getComment()
         Message documenting the alarm change.
        optional string comment = 5;
        Returns:
        The comment.

      • getCommentBytes

        com.google.protobuf.ByteString getCommentBytes()
         Message documenting the alarm change.
        optional string comment = 5;
        Returns:
        The bytes for comment.

      • hasShelveDuration

        boolean hasShelveDuration()
        shelve time in milliseconds (if the state = shelved)
can be left out which means it is shelved indefinitely
        optional uint64 shelveDuration = 6;
        Returns:
        Whether the shelveDuration field is set.

      • getShelveDuration

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