Package org.yamcs.protobuf.alarms

Class ListAlarmsRequest

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable, ListAlarmsRequestOrBuilder
    public final class ListAlarmsRequest
extends com.google.protobuf.GeneratedMessageV3
implements ListAlarmsRequestOrBuilder
    Protobuf type yamcs.protobuf.alarms.ListAlarmsRequest
    See Also:
    Serialized Form

    • Nested Class Summary

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

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

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,​BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,​BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, 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

    • Method Detail

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

      • getInstanceBytes

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

      • hasPos

        public boolean hasPos()
         The zero-based row number at which to start outputting results.
 Default: ``0``
        optional int64 pos = 2;
        Specified by:
        hasPos in interface ListAlarmsRequestOrBuilder
        Returns:
        Whether the pos field is set.

      • getPos

        public long getPos()
         The zero-based row number at which to start outputting results.
 Default: ``0``
        optional int64 pos = 2;
        Specified by:
        getPos in interface ListAlarmsRequestOrBuilder
        Returns:
        The pos.

      • hasLimit

        public boolean hasLimit()
         The maximum number of returned records per page. Choose this value
 too high and you risk hitting the maximum response size limit
 enforced by the server. Default: ``100``
        optional int32 limit = 3;
        Specified by:
        hasLimit in interface ListAlarmsRequestOrBuilder
        Returns:
        Whether the limit field is set.

      • getLimit

        public int getLimit()
         The maximum number of returned records per page. Choose this value
 too high and you risk hitting the maximum response size limit
 enforced by the server. Default: ``100``
        optional int32 limit = 3;
        Specified by:
        getLimit in interface ListAlarmsRequestOrBuilder
        Returns:
        The limit.

      • hasStart

        public boolean hasStart()
         Filter the lower bound of the alarm's trigger time. Specify a date
 string in ISO 8601 format. This bound is inclusive.
        optional .google.protobuf.Timestamp start = 4;
        Specified by:
        hasStart in interface ListAlarmsRequestOrBuilder
        Returns:
        Whether the start field is set.

      • getStart

        public com.google.protobuf.Timestamp getStart()
         Filter the lower bound of the alarm's trigger time. Specify a date
 string in ISO 8601 format. This bound is inclusive.
        optional .google.protobuf.Timestamp start = 4;
        Specified by:
        getStart in interface ListAlarmsRequestOrBuilder
        Returns:
        The start.

      • getStartOrBuilder

        public com.google.protobuf.TimestampOrBuilder getStartOrBuilder()
         Filter the lower bound of the alarm's trigger time. Specify a date
 string in ISO 8601 format. This bound is inclusive.
        optional .google.protobuf.Timestamp start = 4;
        Specified by:
        getStartOrBuilder in interface ListAlarmsRequestOrBuilder

      • hasStop

        public boolean hasStop()
         Filter the upper bound of the alarm's trigger time. Specify a date
 string in ISO 8601 format. This bound is exclusive.
        optional .google.protobuf.Timestamp stop = 5;
        Specified by:
        hasStop in interface ListAlarmsRequestOrBuilder
        Returns:
        Whether the stop field is set.

      • getStop

        public com.google.protobuf.Timestamp getStop()
         Filter the upper bound of the alarm's trigger time. Specify a date
 string in ISO 8601 format. This bound is exclusive.
        optional .google.protobuf.Timestamp stop = 5;
        Specified by:
        getStop in interface ListAlarmsRequestOrBuilder
        Returns:
        The stop.

      • getStopOrBuilder

        public com.google.protobuf.TimestampOrBuilder getStopOrBuilder()
         Filter the upper bound of the alarm's trigger time. Specify a date
 string in ISO 8601 format. This bound is exclusive.
        optional .google.protobuf.Timestamp stop = 5;
        Specified by:
        getStopOrBuilder in interface ListAlarmsRequestOrBuilder

      • hasOrder

        public boolean hasOrder()
         The order of the returned results. Can be either ``asc`` or
 ``desc``. The sorting is always by trigger time (i.e. the
 generation time of the trigger value). Default: ``desc``
        optional string order = 6;
        Specified by:
        hasOrder in interface ListAlarmsRequestOrBuilder
        Returns:
        Whether the order field is set.

      • getOrder

        public String getOrder()
         The order of the returned results. Can be either ``asc`` or
 ``desc``. The sorting is always by trigger time (i.e. the
 generation time of the trigger value). Default: ``desc``
        optional string order = 6;
        Specified by:
        getOrder in interface ListAlarmsRequestOrBuilder
        Returns:
        The order.

      • getOrderBytes

        public com.google.protobuf.ByteString getOrderBytes()
         The order of the returned results. Can be either ``asc`` or
 ``desc``. The sorting is always by trigger time (i.e. the
 generation time of the trigger value). Default: ``desc``
        optional string order = 6;
        Specified by:
        getOrderBytes in interface ListAlarmsRequestOrBuilder
        Returns:
        The bytes for order.

      • hasName

        public boolean hasName()
         Filter alarm instances on a specific alarm name (for example:
 parameter name)
        optional string name = 7;
        Specified by:
        hasName in interface ListAlarmsRequestOrBuilder
        Returns:
        Whether the name field is set.

      • getName

        public String getName()
         Filter alarm instances on a specific alarm name (for example:
 parameter name)
        optional string name = 7;
        Specified by:
        getName in interface ListAlarmsRequestOrBuilder
        Returns:
        The name.

      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         Filter alarm instances on a specific alarm name (for example:
 parameter name)
        optional string name = 7;
        Specified by:
        getNameBytes in interface ListAlarmsRequestOrBuilder
        Returns:
        The bytes for name.

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getParserForType

        public com.google.protobuf.Parser<ListAlarmsRequest> 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 ListAlarmsRequest getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder