Cloud Bigtable V2 API - Class Google::Cloud::Bigtable::V2::ReadRowsResponse (v0.21.0)

Reference documentation and code samples for the Cloud Bigtable V2 API class Google::Cloud::Bigtable::V2::ReadRowsResponse.

Response message for Bigtable.ReadRows.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#chunks

def chunks() -> ::Array<::Google::Cloud::Bigtable::V2::ReadRowsResponse::CellChunk>
Returns

#chunks=

def chunks=(value) -> ::Array<::Google::Cloud::Bigtable::V2::ReadRowsResponse::CellChunk>
Parameter
Returns

#last_scanned_row_key

def last_scanned_row_key() -> ::String
Returns
  • (::String) — Optionally the server might return the row key of the last row it has scanned. The client can use this to construct a more efficient retry request if needed: any row keys or portions of ranges less than this row key can be dropped from the request. This is primarily useful for cases where the server has read a lot of data that was filtered out since the last committed row key, allowing the client to skip that work on a retry.

#last_scanned_row_key=

def last_scanned_row_key=(value) -> ::String
Parameter
  • value (::String) — Optionally the server might return the row key of the last row it has scanned. The client can use this to construct a more efficient retry request if needed: any row keys or portions of ranges less than this row key can be dropped from the request. This is primarily useful for cases where the server has read a lot of data that was filtered out since the last committed row key, allowing the client to skip that work on a retry.
Returns
  • (::String) — Optionally the server might return the row key of the last row it has scanned. The client can use this to construct a more efficient retry request if needed: any row keys or portions of ranges less than this row key can be dropped from the request. This is primarily useful for cases where the server has read a lot of data that was filtered out since the last committed row key, allowing the client to skip that work on a retry.

#request_stats

def request_stats() -> ::Google::Cloud::Bigtable::V2::RequestStats
Returns
  • (::Google::Cloud::Bigtable::V2::RequestStats) — If requested, provide enhanced query performance statistics. The semantics dictate:

    • request_stats is empty on every (streamed) response, except
    • request_stats has non-empty information after all chunks have been streamed, where the ReadRowsResponse message only contains request_stats.
      • For example, if a read request would have returned an empty response instead a single ReadRowsResponse is streamed with empty chunks and request_stats filled.

    Visually, response messages will stream as follows: ... -> {chunks: [...]} -> {chunks: [], request_stats: \{...}} ___________________/ _____________________________/ Primary response Trailer of RequestStats info

    Or if the read did not return any values: {chunks: [], request_stats: \{...}} ________________________________/ Trailer of RequestStats info

#request_stats=

def request_stats=(value) -> ::Google::Cloud::Bigtable::V2::RequestStats
Parameter
  • value (::Google::Cloud::Bigtable::V2::RequestStats) — If requested, provide enhanced query performance statistics. The semantics dictate:

    • request_stats is empty on every (streamed) response, except
    • request_stats has non-empty information after all chunks have been streamed, where the ReadRowsResponse message only contains request_stats.
      • For example, if a read request would have returned an empty response instead a single ReadRowsResponse is streamed with empty chunks and request_stats filled.

    Visually, response messages will stream as follows: ... -> {chunks: [...]} -> {chunks: [], request_stats: \{...}} ___________________/ _____________________________/ Primary response Trailer of RequestStats info

    Or if the read did not return any values: {chunks: [], request_stats: \{...}} ________________________________/ Trailer of RequestStats info

Returns
  • (::Google::Cloud::Bigtable::V2::RequestStats) — If requested, provide enhanced query performance statistics. The semantics dictate:

    • request_stats is empty on every (streamed) response, except
    • request_stats has non-empty information after all chunks have been streamed, where the ReadRowsResponse message only contains request_stats.
      • For example, if a read request would have returned an empty response instead a single ReadRowsResponse is streamed with empty chunks and request_stats filled.

    Visually, response messages will stream as follows: ... -> {chunks: [...]} -> {chunks: [], request_stats: \{...}} ___________________/ _____________________________/ Primary response Trailer of RequestStats info

    Or if the read did not return any values: {chunks: [], request_stats: \{...}} ________________________________/ Trailer of RequestStats info