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

Interface ListAlarmsRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
ListAlarmsRequest, ListAlarmsRequest.Builder
public interface ListAlarmsRequestOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    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
    getOrder()
    The order of the returned results.
    com.google.protobuf.ByteString
    getOrderBytes()
    The order of the returned results.
    long
    getPos()
    The zero-based row number at which to start outputting results.
    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.
    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
    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.

    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 Details

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

    • hasPos

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

    • getPos

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

    • hasLimit

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

    • getLimit

      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;
      Returns:
      The limit.

    • hasStart

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

    • getStart

      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;
      Returns:
      The start.

    • getStartOrBuilder

      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;

    • hasStop

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

    • getStop

      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;
      Returns:
      The stop.

    • getStopOrBuilder

      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;

    • hasOrder

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

    • getOrder

      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;
      Returns:
      The order.

    • getOrderBytes

      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;
      Returns:
      The bytes for order.

    • hasName

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

    • getName

      String getName()
       Filter alarm instances on a specific alarm name (for example:
 parameter name)
      optional string name = 7;
      Returns:
      The name.

    • getNameBytes

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