Package com.google.bigtable.v2

Interface ReadRowsRequestOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    ReadRowsRequest, ReadRowsRequest.Builder
    public interface ReadRowsRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      String getAppProfileId()
      This value specifies routing for replication.
      com.google.protobuf.ByteString getAppProfileIdBytes()
      This value specifies routing for replication.
      RowFilter getFilter()
      The filter to apply to the contents of the specified row(s).
      RowFilterOrBuilder getFilterOrBuilder()
      The filter to apply to the contents of the specified row(s).
      ReadRowsRequest.RequestStatsView getRequestStatsView()
      The view into RequestStats, as described above.
      int getRequestStatsViewValue()
      The view into RequestStats, as described above.
      boolean getReversed()
      Experimental API - Please note that this API is currently experimental and can change in the future.
      RowSet getRows()
      The row keys and/or ranges to read sequentially.
      long getRowsLimit()
      The read will stop after committing to N rows' worth of results.
      RowSetOrBuilder getRowsOrBuilder()
      The row keys and/or ranges to read sequentially.
      String getTableName()
      Required.
      com.google.protobuf.ByteString getTableNameBytes()
      Required.
      boolean hasFilter()
      The filter to apply to the contents of the specified row(s).
      boolean hasRows()
      The row keys and/or ranges to read sequentially.

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

      • getTableName

        String getTableName()
         Required. The unique name of the table from which to read.
 Values are of the form
 `projects/<project>/instances/<instance>/tables/<table>`.
        string table_name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Returns:
        The tableName.

      • getTableNameBytes

        com.google.protobuf.ByteString getTableNameBytes()
         Required. The unique name of the table from which to read.
 Values are of the form
 `projects/<project>/instances/<instance>/tables/<table>`.
        string table_name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Returns:
        The bytes for tableName.

      • getAppProfileId

        String getAppProfileId()
         This value specifies routing for replication. If not specified, the
 "default" application profile will be used.
        string app_profile_id = 5;
        Returns:
        The appProfileId.

      • getAppProfileIdBytes

        com.google.protobuf.ByteString getAppProfileIdBytes()
         This value specifies routing for replication. If not specified, the
 "default" application profile will be used.
        string app_profile_id = 5;
        Returns:
        The bytes for appProfileId.

      • hasRows

        boolean hasRows()
         The row keys and/or ranges to read sequentially. If not specified, reads
 from all rows.
        .google.bigtable.v2.RowSet rows = 2;
        Returns:
        Whether the rows field is set.

      • getRows

        RowSet getRows()
         The row keys and/or ranges to read sequentially. If not specified, reads
 from all rows.
        .google.bigtable.v2.RowSet rows = 2;
        Returns:
        The rows.

      • getRowsOrBuilder

        RowSetOrBuilder getRowsOrBuilder()
         The row keys and/or ranges to read sequentially. If not specified, reads
 from all rows.
        .google.bigtable.v2.RowSet rows = 2;

      • hasFilter

        boolean hasFilter()
         The filter to apply to the contents of the specified row(s). If unset,
 reads the entirety of each row.
        .google.bigtable.v2.RowFilter filter = 3;
        Returns:
        Whether the filter field is set.

      • getFilter

        RowFilter getFilter()
         The filter to apply to the contents of the specified row(s). If unset,
 reads the entirety of each row.
        .google.bigtable.v2.RowFilter filter = 3;
        Returns:
        The filter.

      • getFilterOrBuilder

        RowFilterOrBuilder getFilterOrBuilder()
         The filter to apply to the contents of the specified row(s). If unset,
 reads the entirety of each row.
        .google.bigtable.v2.RowFilter filter = 3;

      • getRowsLimit

        long getRowsLimit()
         The read will stop after committing to N rows' worth of results. The
 default (zero) is to return all results.
        int64 rows_limit = 4;
        Returns:
        The rowsLimit.

      • getRequestStatsViewValue

        int getRequestStatsViewValue()
         The view into RequestStats, as described above.
        .google.bigtable.v2.ReadRowsRequest.RequestStatsView request_stats_view = 6;
        Returns:
        The enum numeric value on the wire for requestStatsView.

      • getRequestStatsView

        ReadRowsRequest.RequestStatsView getRequestStatsView()
         The view into RequestStats, as described above.
        .google.bigtable.v2.ReadRowsRequest.RequestStatsView request_stats_view = 6;
        Returns:
        The requestStatsView.

      • getReversed

        boolean getReversed()
         Experimental API - Please note that this API is currently experimental
 and can change in the future.

 Return rows in lexiographical descending order of the row keys. The row
 contents will not be affected by this flag.

 Example result set:

     [
       {key: "k2", "f:col1": "v1", "f:col2": "v1"},
       {key: "k1", "f:col1": "v2", "f:col2": "v2"}
     ]
        bool reversed = 7;
        Returns:
        The reversed.