Package org.yamcs.protobuf

Interface Table.GetTableDataRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Table.GetTableDataRequest, Table.GetTableDataRequest.Builder
Enclosing class:
Table
public static interface Table.GetTableDataRequestOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getCols(int index)
    The columns to be included in the result.
    com.google.protobuf.ByteString
    getColsBytes(int index)
    The columns to be included in the result.
    int
    getColsCount()
    The columns to be included in the result.
    List<String>
    getColsList()
    The columns to be included in the result.
    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()
    Table name.
    com.google.protobuf.ByteString
    getNameBytes()
    Table name.
    String
    getOrder()
    The direction of the sort.
    com.google.protobuf.ByteString
    getOrderBytes()
    The direction of the sort.
    long
    getPos()
    The zero-based row number at which to start outputting results.
    boolean
    hasInstance()
    Yamcs instance name.
    boolean
    hasLimit()
    The maximum number of returned records per page.
    boolean
    hasName()
    Table name.
    boolean
    hasOrder()
    The direction of the sort.
    boolean
    hasPos()
    The zero-based row number at which to start outputting results.

    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.

    • hasName

      boolean hasName()
       Table name.
      optional string name = 2;
      Returns:
      Whether the name field is set.

    • getName

      String getName()
       Table name.
      optional string name = 2;
      Returns:
      The name.

    • getNameBytes

      com.google.protobuf.ByteString getNameBytes()
       Table name.
      optional string name = 2;
      Returns:
      The bytes for name.

    • getColsList

      List<String> getColsList()
       The columns to be included in the result. If unspecified, all table
 and/or additional tuple columns will be included.
      repeated string cols = 3;
      Returns:
      A list containing the cols.

    • getColsCount

      int getColsCount()
       The columns to be included in the result. If unspecified, all table
 and/or additional tuple columns will be included.
      repeated string cols = 3;
      Returns:
      The count of cols.

    • getCols

      String getCols(int index)
       The columns to be included in the result. If unspecified, all table
 and/or additional tuple columns will be included.
      repeated string cols = 3;
      Parameters:
      index - The index of the element to return.
      Returns:
      The cols at the given index.

    • getColsBytes

      com.google.protobuf.ByteString getColsBytes(int index)
       The columns to be included in the result. If unspecified, all table
 and/or additional tuple columns will be included.
      repeated string cols = 3;
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the cols at the given index.

    • hasPos

      boolean hasPos()
       The zero-based row number at which to start outputting results. Default: ``0``
 Note that in the current rocksdb storage engine there is no way to jump to a row by its number. 
 This is why such a request will do a table scan and can be slow for large values of pos.
      optional int64 pos = 4;
      Returns:
      Whether the pos field is set.

    • getPos

      long getPos()
       The zero-based row number at which to start outputting results. Default: ``0``
 Note that in the current rocksdb storage engine there is no way to jump to a row by its number. 
 This is why such a request will do a table scan and can be slow for large values of pos.
      optional int64 pos = 4;
      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 = 5;
      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 = 5;
      Returns:
      The limit.

    • hasOrder

      boolean hasOrder()
       The direction of the sort. Sorting is always done on the key of the
 table. Can be either ``asc`` or ``desc``. Default: ``desc``
      optional string order = 6;
      Returns:
      Whether the order field is set.

    • getOrder

      String getOrder()
       The direction of the sort. Sorting is always done on the key of the
 table. Can be either ``asc`` or ``desc``. Default: ``desc``
      optional string order = 6;
      Returns:
      The order.

    • getOrderBytes

      com.google.protobuf.ByteString getOrderBytes()
       The direction of the sort. Sorting is always done on the key of the
 table. Can be either ``asc`` or ``desc``. Default: ``desc``
      optional string order = 6;
      Returns:
      The bytes for order.