Struct ReadRowsRequest

pub struct ReadRowsRequest {
    pub table_name: String,
    pub authorized_view_name: String,
    pub app_profile_id: String,
    pub rows: Option<RowSet>,
    pub filter: Option<RowFilter>,
    pub rows_limit: i64,
    pub request_stats_view: i32,
    pub reversed: bool,
}

Request message for Bigtable.ReadRows.

Fields

table_name: String

Optional. The unique name of the table from which to read.

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

authorized_view_name: 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>.

app_profile_id: String

This value specifies routing for replication. If not specified, the “default” application profile will be used.

rows: Option<RowSet>

The row keys and/or ranges to read sequentially. If not specified, reads from all rows.

filter: Option<RowFilter>

The filter to apply to the contents of the specified row(s). If unset, reads the entirety of each row.

rows_limit: i64

The read will stop after committing to N rows’ worth of results. The default (zero) is to return all results.

request_stats_view: i32

The view into RequestStats, as described above.

reversed: bool

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

Implementations

impl ReadRowsRequest

pub fn request_stats_view(&self) -> RequestStatsView

Returns the enum value of request_stats_view, or the default if the field is set to an invalid enum value.

pub fn set_request_stats_view(&mut self, value: RequestStatsView)

Sets request_stats_view to the provided enum value.

Trait Implementations

impl Clone for ReadRowsRequest

fn clone(&self) -> ReadRowsRequest

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ReadRowsRequest

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ReadRowsRequest

fn default() -> Self

Returns the “default value” for a type.

impl Message for ReadRowsRequest

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for ReadRowsRequest

fn eq(&self, other: &ReadRowsRequest) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ReadRowsRequest