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

Class ListAlarmsRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
org.yamcs.protobuf.alarms.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:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final 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<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
    INSTANCE_FIELD_NUMBER
     
    static final int
    LIMIT_FIELD_NUMBER
     
    static final int
    NAME_FIELD_NUMBER
     
    static final int
    NEXT_FIELD_NUMBER
     
    static final int
    ORDER_FIELD_NUMBER
     
    static final com.google.protobuf.Parser<ListAlarmsRequest>
    PARSER
    Deprecated.
    static final int
    POS_FIELD_NUMBER
     
    static final int
    START_FIELD_NUMBER
     
    static final int
    STOP_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)
     
    static ListAlarmsRequest
    getDefaultInstance()
     
    ListAlarmsRequest
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    String
    getInstance()
    Yamcs instance name
    com.google.protobuf.ByteString
    getInstanceBytes()
    Yamcs instance name
    int
    getLimit()
    The maximum number of returned records per page.
    String
    getName()
    Filter alarm instances on a specific alarm name (for example: parameter name)
    com.google.protobuf.ByteString
    getNameBytes()
    Filter alarm instances on a specific alarm name (for example: parameter name)
    String
    getNext()
    Continuation token returned by a previous page response.
    com.google.protobuf.ByteString
    getNextBytes()
    Continuation token returned by a previous page response.
    String
    getOrder()
    The order of the returned results.
    com.google.protobuf.ByteString
    getOrderBytes()
    The order of the returned results.
    com.google.protobuf.Parser<ListAlarmsRequest>
    getParserForType()
     
    long
    getPos()
    The zero-based row number at which to start outputting results.
    int
    getSerializedSize()
     
    com.google.protobuf.Timestamp
    getStart()
    Filter the lower bound of the alarm's trigger time.
    com.google.protobuf.TimestampOrBuilder
    getStartOrBuilder()
    Filter the lower bound of the alarm's trigger time.
    com.google.protobuf.Timestamp
    getStop()
    Filter the upper bound of the alarm's trigger time.
    com.google.protobuf.TimestampOrBuilder
    getStopOrBuilder()
    Filter the upper bound of the alarm's trigger time.
    final com.google.protobuf.UnknownFieldSet
    getUnknownFields()
     
    int
    hashCode()
     
    boolean
    hasInstance()
    Yamcs instance name
    boolean
    hasLimit()
    The maximum number of returned records per page.
    boolean
    hasName()
    Filter alarm instances on a specific alarm name (for example: parameter name)
    boolean
    hasNext()
    Continuation token returned by a previous page response.
    boolean
    hasOrder()
    The order of the returned results.
    boolean
    hasPos()
    The zero-based row number at which to start outputting results.
    boolean
    hasStart()
    Filter the lower bound of the alarm's trigger time.
    boolean
    hasStop()
    Filter the upper bound of the alarm's trigger time.
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static ListAlarmsRequest.Builder
    newBuilder()
     
    static ListAlarmsRequest.Builder
    newBuilder(ListAlarmsRequest prototype)
     
    ListAlarmsRequest.Builder
    newBuilderForType()
     
    protected ListAlarmsRequest.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static ListAlarmsRequest
    parseDelimitedFrom(InputStream input)
     
    static ListAlarmsRequest
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ListAlarmsRequest
    parseFrom(byte[] data)
     
    static ListAlarmsRequest
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ListAlarmsRequest
    parseFrom(com.google.protobuf.ByteString data)
     
    static ListAlarmsRequest
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ListAlarmsRequest
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static ListAlarmsRequest
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ListAlarmsRequest
    parseFrom(InputStream input)
     
    static ListAlarmsRequest
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static ListAlarmsRequest
    parseFrom(ByteBuffer data)
     
    static ListAlarmsRequest
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<ListAlarmsRequest>
    parser()
     
    ListAlarmsRequest.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 ListAlarmsRequestOrBuilder
      Returns:
      Whether the instance field is set.

    • getInstance

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

    • 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.

    • hasNext

      public boolean hasNext()
       Continuation token returned by a previous page response.
      optional string next = 8;
      Specified by:
      hasNext in interface ListAlarmsRequestOrBuilder
      Returns:
      Whether the next field is set.

    • getNext

      public String getNext()
       Continuation token returned by a previous page response.
      optional string next = 8;
      Specified by:
      getNext in interface ListAlarmsRequestOrBuilder
      Returns:
      The next.

    • getNextBytes

      public com.google.protobuf.ByteString getNextBytes()
       Continuation token returned by a previous page response.
      optional string next = 8;
      Specified by:
      getNextBytes in interface ListAlarmsRequestOrBuilder
      Returns:
      The bytes for next.

    • 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(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • 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

    • newBuilder

      public static ListAlarmsRequest.Builder newBuilder()

    • newBuilder

      public static ListAlarmsRequest.Builder newBuilder(ListAlarmsRequest prototype)

    • 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

    • getDefaultInstance

      public static ListAlarmsRequest getDefaultInstance()

    • parser

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

    • 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