Cloud Bigtable V2 API - Class Google::Cloud::Bigtable::V2::ReadRowsRequest (v0.18.0)

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

Request message for Bigtable.ReadRows.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#app_profile_id

def app_profile_id() -> ::String
Returns
  • (::String) — This value specifies routing for replication. If not specified, the "default" application profile will be used.

#app_profile_id=

def app_profile_id=(value) -> ::String
Parameter
  • value (::String) — This value specifies routing for replication. If not specified, the "default" application profile will be used.
Returns
  • (::String) — This value specifies routing for replication. If not specified, the "default" application profile will be used.

#filter

def filter() -> ::Google::Cloud::Bigtable::V2::RowFilter
Returns

#filter=

def filter=(value) -> ::Google::Cloud::Bigtable::V2::RowFilter
Parameter
Returns

#request_stats_view

def request_stats_view() -> ::Google::Cloud::Bigtable::V2::ReadRowsRequest::RequestStatsView
Returns

#request_stats_view=

def request_stats_view=(value) -> ::Google::Cloud::Bigtable::V2::ReadRowsRequest::RequestStatsView
Parameter
Returns

#reversed

def reversed() -> ::Boolean
Returns
  • (::Boolean) —

    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"}
]

#reversed=

def reversed=(value) -> ::Boolean
Parameter
  • value (::Boolean) —

    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"}
]
Returns
  • (::Boolean) —

    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"}
]

#rows

def rows() -> ::Google::Cloud::Bigtable::V2::RowSet
Returns

#rows=

def rows=(value) -> ::Google::Cloud::Bigtable::V2::RowSet
Parameter
Returns

#rows_limit

def rows_limit() -> ::Integer
Returns
  • (::Integer) — The read will stop after committing to N rows' worth of results. The default (zero) is to return all results.

#rows_limit=

def rows_limit=(value) -> ::Integer
Parameter
  • value (::Integer) — The read will stop after committing to N rows' worth of results. The default (zero) is to return all results.
Returns
  • (::Integer) — The read will stop after committing to N rows' worth of results. The default (zero) is to return all results.

#table_name

def table_name() -> ::String
Returns
  • (::String) — Required. The unique name of the table from which to read. Values are of the form projects/<project>/instances/<instance>/tables/<table>.

#table_name=

def table_name=(value) -> ::String
Parameter
  • value (::String) — Required. The unique name of the table from which to read. Values are of the form projects/<project>/instances/<instance>/tables/<table>.
Returns
  • (::String) — Required. The unique name of the table from which to read. Values are of the form projects/<project>/instances/<instance>/tables/<table>.