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

Class EditAlarmRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
org.yamcs.protobuf.alarms.EditAlarmRequest
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable, EditAlarmRequestOrBuilder
public final class EditAlarmRequest extends com.google.protobuf.GeneratedMessageV3 implements EditAlarmRequestOrBuilder
Protobuf type yamcs.protobuf.alarms.EditAlarmRequest
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    EditAlarmRequest.Builder
    Protobuf type yamcs.protobuf.alarms.EditAlarmRequest

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

    com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    COMMENT_FIELD_NUMBER
     
    static final int
    INSTANCE_FIELD_NUMBER
     
    static final int
    NAME_FIELD_NUMBER
     
    static final com.google.protobuf.Parser<EditAlarmRequest>
    PARSER
    Deprecated.
    static final int
    PROCESSOR_FIELD_NUMBER
     
    static final int
    SEQNUM_FIELD_NUMBER
     
    static final int
    SHELVEDURATION_FIELD_NUMBER
     
    static final int
    STATE_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessageV3

    alwaysUseFieldBuilders, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    String
    getComment()
    Message documenting the alarm change.
    com.google.protobuf.ByteString
    getCommentBytes()
    Message documenting the alarm change.
    static EditAlarmRequest
    getDefaultInstance()
     
    EditAlarmRequest
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    String
    getInstance()
    Yamcs instance name
    com.google.protobuf.ByteString
    getInstanceBytes()
    Yamcs instance name
    String
    getName()
    Alarm name
    com.google.protobuf.ByteString
    getNameBytes()
    Alarm name
    com.google.protobuf.Parser<EditAlarmRequest>
    getParserForType()
     
    String
    getProcessor()
    Processor name
    com.google.protobuf.ByteString
    getProcessorBytes()
    Processor name
    int
    getSeqnum()
    Alarm sequence number
    int
    getSerializedSize()
     
    long
    getShelveDuration()
    When `state` is `shelved`, this indicates the shelve time in milliseconds.
    String
    getState()
    **Required.** The state of the alarm.
    com.google.protobuf.ByteString
    getStateBytes()
    **Required.** The state of the alarm.
    final com.google.protobuf.UnknownFieldSet
    getUnknownFields()
     
    boolean
    hasComment()
    Message documenting the alarm change.
    int
    hashCode()
     
    boolean
    hasInstance()
    Yamcs instance name
    boolean
    hasName()
    Alarm name
    boolean
    hasProcessor()
    Processor name
    boolean
    hasSeqnum()
    Alarm sequence number
    boolean
    hasShelveDuration()
    When `state` is `shelved`, this indicates the shelve time in milliseconds.
    boolean
    hasState()
    **Required.** The state of the alarm.
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static EditAlarmRequest.Builder
    newBuilder()
     
    static EditAlarmRequest.Builder
    newBuilder(EditAlarmRequest prototype)
     
    EditAlarmRequest.Builder
    newBuilderForType()
     
    protected EditAlarmRequest.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static EditAlarmRequest
    parseDelimitedFrom(InputStream input)
     
    static EditAlarmRequest
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static EditAlarmRequest
    parseFrom(byte[] data)
     
    static EditAlarmRequest
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static EditAlarmRequest
    parseFrom(com.google.protobuf.ByteString data)
     
    static EditAlarmRequest
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static EditAlarmRequest
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static EditAlarmRequest
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static EditAlarmRequest
    parseFrom(InputStream input)
     
    static EditAlarmRequest
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static EditAlarmRequest
    parseFrom(ByteBuffer data)
     
    static EditAlarmRequest
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<EditAlarmRequest>
    parser()
     
    EditAlarmRequest.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessageV3

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Field Details

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3

    • getUnknownFields

      public final com.google.protobuf.UnknownFieldSet getUnknownFields()
      Specified by:
      getUnknownFields in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getUnknownFields in class com.google.protobuf.GeneratedMessageV3

    • getDescriptor

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

    • internalGetFieldAccessorTable

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

    • hasInstance

      public boolean hasInstance()
       Yamcs instance name
      optional string instance = 1;
      Specified by:
      hasInstance in interface EditAlarmRequestOrBuilder
      Returns:
      Whether the instance field is set.

    • getInstance

      public String getInstance()
       Yamcs instance name
      optional string instance = 1;
      Specified by:
      getInstance in interface EditAlarmRequestOrBuilder
      Returns:
      The instance.

    • getInstanceBytes

      public com.google.protobuf.ByteString getInstanceBytes()
       Yamcs instance name
      optional string instance = 1;
      Specified by:
      getInstanceBytes in interface EditAlarmRequestOrBuilder
      Returns:
      The bytes for instance.

    • hasProcessor

      public boolean hasProcessor()
       Processor name
      optional string processor = 2;
      Specified by:
      hasProcessor in interface EditAlarmRequestOrBuilder
      Returns:
      Whether the processor field is set.

    • getProcessor

      public String getProcessor()
       Processor name
      optional string processor = 2;
      Specified by:
      getProcessor in interface EditAlarmRequestOrBuilder
      Returns:
      The processor.

    • getProcessorBytes

      public com.google.protobuf.ByteString getProcessorBytes()
       Processor name
      optional string processor = 2;
      Specified by:
      getProcessorBytes in interface EditAlarmRequestOrBuilder
      Returns:
      The bytes for processor.

    • hasName

      public boolean hasName()
       Alarm name
      optional string name = 3;
      Specified by:
      hasName in interface EditAlarmRequestOrBuilder
      Returns:
      Whether the name field is set.

    • getName

      public String getName()
       Alarm name
      optional string name = 3;
      Specified by:
      getName in interface EditAlarmRequestOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
       Alarm name
      optional string name = 3;
      Specified by:
      getNameBytes in interface EditAlarmRequestOrBuilder
      Returns:
      The bytes for name.

    • hasSeqnum

      public boolean hasSeqnum()
       Alarm sequence number
      optional uint32 seqnum = 4;
      Specified by:
      hasSeqnum in interface EditAlarmRequestOrBuilder
      Returns:
      Whether the seqnum field is set.

    • getSeqnum

      public int getSeqnum()
       Alarm sequence number
      optional uint32 seqnum = 4;
      Specified by:
      getSeqnum in interface EditAlarmRequestOrBuilder
      Returns:
      The seqnum.

    • hasState

      public boolean hasState()
       **Required.** The state of the alarm. 
 Either `acknowledged`, `shelved`, `unshelved` or `cleared`.
      optional string state = 5;
      Specified by:
      hasState in interface EditAlarmRequestOrBuilder
      Returns:
      Whether the state field is set.

    • getState

      public String getState()
       **Required.** The state of the alarm. 
 Either `acknowledged`, `shelved`, `unshelved` or `cleared`.
      optional string state = 5;
      Specified by:
      getState in interface EditAlarmRequestOrBuilder
      Returns:
      The state.

    • getStateBytes

      public com.google.protobuf.ByteString getStateBytes()
       **Required.** The state of the alarm. 
 Either `acknowledged`, `shelved`, `unshelved` or `cleared`.
      optional string state = 5;
      Specified by:
      getStateBytes in interface EditAlarmRequestOrBuilder
      Returns:
      The bytes for state.

    • hasComment

      public boolean hasComment()
       Message documenting the alarm change.
      optional string comment = 6;
      Specified by:
      hasComment in interface EditAlarmRequestOrBuilder
      Returns:
      Whether the comment field is set.

    • getComment

      public String getComment()
       Message documenting the alarm change.
      optional string comment = 6;
      Specified by:
      getComment in interface EditAlarmRequestOrBuilder
      Returns:
      The comment.

    • getCommentBytes

      public com.google.protobuf.ByteString getCommentBytes()
       Message documenting the alarm change.
      optional string comment = 6;
      Specified by:
      getCommentBytes in interface EditAlarmRequestOrBuilder
      Returns:
      The bytes for comment.

    • hasShelveDuration

      public boolean hasShelveDuration()
       When `state` is `shelved`, this indicates the shelve time in
 milliseconds. If unset, it will be shelved indefinitely.
      optional uint64 shelveDuration = 7;
      Specified by:
      hasShelveDuration in interface EditAlarmRequestOrBuilder
      Returns:
      Whether the shelveDuration field is set.

    • getShelveDuration

      public long getShelveDuration()
       When `state` is `shelved`, this indicates the shelve time in
 milliseconds. If unset, it will be shelved indefinitely.
      optional uint64 shelveDuration = 7;
      Specified by:
      getShelveDuration in interface EditAlarmRequestOrBuilder
      Returns:
      The shelveDuration.

    • isInitialized

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

    • 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.GeneratedMessageV3
      Throws:
      IOException

    • getSerializedSize

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

    • 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 EditAlarmRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static EditAlarmRequest.Builder newBuilder()

    • newBuilder

      public static EditAlarmRequest.Builder newBuilder(EditAlarmRequest prototype)

    • toBuilder

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

    • newBuilderForType

      protected EditAlarmRequest.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static EditAlarmRequest getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<EditAlarmRequest> 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.GeneratedMessageV3

    • getDefaultInstanceForType

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