Cloud Bigtable V2 API - Class Google::Cloud::Bigtable::V2::ReadRowsRequest (v0.21.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.

#authorized_view_name

def authorized_view_name() -> ::String

Returns

(::String) — Optional. The unique name of the AuthorizedView from which to read.

Values are of the form projects/<project>/instances/<instance>/tables/<table>/authorizedViews/<authorized_view>.

#authorized_view_name=

def authorized_view_name=(value) -> ::String

Parameter

value (::String) — Optional. The unique name of the AuthorizedView from which to read.

Values are of the form projects/<project>/instances/<instance>/tables/<table>/authorizedViews/<authorized_view>.

Returns

(::String) — Optional. The unique name of the AuthorizedView from which to read.

Values are of the form projects/<project>/instances/<instance>/tables/<table>/authorizedViews/<authorized_view>.

#filter

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

Returns

(::Google::Cloud::Bigtable::V2::RowFilter) — The filter to apply to the contents of the specified row(s). If unset, reads the entirety of each row.

#filter=

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

Parameter

value (::Google::Cloud::Bigtable::V2::RowFilter) — The filter to apply to the contents of the specified row(s). If unset, reads the entirety of each row.

Returns

(::Google::Cloud::Bigtable::V2::RowFilter) — The filter to apply to the contents of the specified row(s). If unset, reads the entirety of each row.

#request_stats_view

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

Returns

(::Google::Cloud::Bigtable::V2::ReadRowsRequest::RequestStatsView) — The view into RequestStats, as described above.

#request_stats_view=

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

Parameter

value (::Google::Cloud::Bigtable::V2::ReadRowsRequest::RequestStatsView) — The view into RequestStats, as described above.

Returns

(::Google::Cloud::Bigtable::V2::ReadRowsRequest::RequestStatsView) — The view into RequestStats, as described above.

#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

(::Google::Cloud::Bigtable::V2::RowSet) — The row keys and/or ranges to read sequentially. If not specified, reads from all rows.

#rows=

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

Parameter

value (::Google::Cloud::Bigtable::V2::RowSet) — The row keys and/or ranges to read sequentially. If not specified, reads from all rows.

Returns

(::Google::Cloud::Bigtable::V2::RowSet) — The row keys and/or ranges to read sequentially. If not specified, reads from all rows.

#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) — Optional. 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) — Optional. The unique name of the table from which to read.

Values are of the form projects/<project>/instances/<instance>/tables/<table>.

Returns

(::String) — Optional. The unique name of the table from which to read.

Values are of the form projects/<project>/instances/<instance>/tables/<table>.