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

Interface ListPacketsRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
ListPacketsRequest, ListPacketsRequest.Builder
public interface ListPacketsRequestOrBuilder 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(int index)
    The archived name of the packets.
    com.google.protobuf.ByteString
    getNameBytes(int index)
    The archived name of the packets.
    int
    getNameCount()
    The archived name of the packets.
    List<String>
    getNameList()
    The archived name of the packets.
    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.
    long
    getPos()
    The zero-based row number at which to start outputting results.
    com.google.protobuf.Timestamp
    getStart()
    Filter the lower bound of the packet's generation time.
    com.google.protobuf.TimestampOrBuilder
    getStartOrBuilder()
    Filter the lower bound of the packet's generation time.
    com.google.protobuf.Timestamp
    getStop()
    Filter the upper bound of the packet's generation time.
    com.google.protobuf.TimestampOrBuilder
    getStopOrBuilder()
    Filter the upper bound of the packet's generation time.
    boolean
    hasInstance()
    Yamcs instance name.
    boolean
    hasLimit()
    The maximum number of returned records per page.
    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 packet's generation time.
    boolean
    hasStop()
    Filter the upper bound of the packet's generation 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.

    • hasOrder

      boolean hasOrder()
       The order of the returned results. Can be either ``asc`` or ``desc``. Default: ``desc``
      optional string order = 4;
      Returns:
      Whether the order field is set.

    • getOrder

      String getOrder()
       The order of the returned results. Can be either ``asc`` or ``desc``. Default: ``desc``
      optional string order = 4;
      Returns:
      The order.

    • getOrderBytes

      com.google.protobuf.ByteString getOrderBytes()
       The order of the returned results. Can be either ``asc`` or ``desc``. Default: ``desc``
      optional string order = 4;
      Returns:
      The bytes for order.

    • getNameList

      List<String> getNameList()
       The archived name of the packets. Names must match exactly.
      repeated string name = 5;
      Returns:
      A list containing the name.

    • getNameCount

      int getNameCount()
       The archived name of the packets. Names must match exactly.
      repeated string name = 5;
      Returns:
      The count of name.

    • getName

      String getName(int index)
       The archived name of the packets. Names must match exactly.
      repeated string name = 5;
      Parameters:
      index - The index of the element to return.
      Returns:
      The name at the given index.

    • getNameBytes

      com.google.protobuf.ByteString getNameBytes(int index)
       The archived name of the packets. Names must match exactly.
      repeated string name = 5;
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the name at the given index.

    • hasNext

      boolean hasNext()
       Continuation token returned by a previous page response.
      optional string next = 6;
      Returns:
      Whether the next field is set.

    • getNext

      String getNext()
       Continuation token returned by a previous page response.
      optional string next = 6;
      Returns:
      The next.

    • getNextBytes

      com.google.protobuf.ByteString getNextBytes()
       Continuation token returned by a previous page response.
      optional string next = 6;
      Returns:
      The bytes for next.

    • hasStart

      boolean hasStart()
       Filter the lower bound of the packet's generation time. Specify a date
 string in ISO 8601 format. This bound is inclusive.
      optional .google.protobuf.Timestamp start = 7;
      Returns:
      Whether the start field is set.

    • getStart

      com.google.protobuf.Timestamp getStart()
       Filter the lower bound of the packet's generation time. Specify a date
 string in ISO 8601 format. This bound is inclusive.
      optional .google.protobuf.Timestamp start = 7;
      Returns:
      The start.

    • getStartOrBuilder

      com.google.protobuf.TimestampOrBuilder getStartOrBuilder()
       Filter the lower bound of the packet's generation time. Specify a date
 string in ISO 8601 format. This bound is inclusive.
      optional .google.protobuf.Timestamp start = 7;

    • hasStop

      boolean hasStop()
       Filter the upper bound of the packet's generation time. Specify a date
 string in ISO 8601 format. This bound is exclusive.
      optional .google.protobuf.Timestamp stop = 8;
      Returns:
      Whether the stop field is set.

    • getStop

      com.google.protobuf.Timestamp getStop()
       Filter the upper bound of the packet's generation time. Specify a date
 string in ISO 8601 format. This bound is exclusive.
      optional .google.protobuf.Timestamp stop = 8;
      Returns:
      The stop.

    • getStopOrBuilder

      com.google.protobuf.TimestampOrBuilder getStopOrBuilder()
       Filter the upper bound of the packet's generation time. Specify a date
 string in ISO 8601 format. This bound is exclusive.
      optional .google.protobuf.Timestamp stop = 8;