Struct ReadRowsResponse 

#[non_exhaustive]
pub struct ReadRowsResponse {
    pub row_count: i64,
    pub stats: Option<StreamStats>,
    pub throttle_state: Option<ThrottleState>,
    pub uncompressed_byte_size: Option<i64>,
    pub total_estimated_row_count: Option<i64>,
    pub rows: Option<Rows>,
    pub schema: Option<Schema>,
    /* private fields */
}

Response from calling ReadRows may include row data, progress and throttling information.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

row_count: i64

Number of serialized rows in the rows block.

stats: Option<StreamStats>

Statistics for the stream.

throttle_state: Option<ThrottleState>

Throttling state. If unset, the latest response still describes the current throttling status.

uncompressed_byte_size: Option<i64>

Optional. If the row data in this ReadRowsResponse is compressed, then uncompressed byte size is the original size of the uncompressed row data. If it is set to a value greater than 0, then decompress into a buffer of size uncompressed_byte_size using the compression codec that was requested during session creation time and which is specified in TableReadOptions.response_compression_codec in ReadSession. This value is not set if no response_compression_codec was not requested and it is -1 if the requested compression would not have reduced the size of this ReadRowsResponse’s row data. This attempts to match Apache Arrow’s behavior described here https://github.com/apache/arrow/issues/15102 where the uncompressed length may be set to -1 to indicate that the data that follows is not compressed, which can be useful for cases where compression does not yield appreciable savings. When uncompressed_byte_size is not greater than 0, the client should skip decompression.

total_estimated_row_count: Option<i64>

Output only. The total estimated number of rows in the query results. Only populated when reading data from a BigQuery job.

This feature is not yet available.

rows: Option<Rows>

Row data is returned in format specified during session creation.

schema: Option<Schema>

The schema for the read. If read_options.selected_fields is set, the schema may be different from the table schema as it will only contain the selected fields. This schema is equivalent to the one returned by CreateSession. This field is only populated in the first ReadRowsResponse RPC.

Implementations

impl ReadRowsResponse

pub fn new() -> Self

Creates a new default instance.

pub fn set_row_count<T: Into<i64>>(self, v: T) -> Self

Sets the value of row_count.

Example

let x = ReadRowsResponse::new().set_row_count(42);

pub fn set_stats<T>(self, v: T) -> Self

where T: Into<StreamStats>,

Sets the value of stats.

Example

use google_cloud_bigquery::model::StreamStats;
let x = ReadRowsResponse::new().set_stats(StreamStats::default()/* use setters */);

pub fn set_or_clear_stats<T>(self, v: Option<T>) -> Self

where T: Into<StreamStats>,

Sets or clears the value of stats.

Example

use google_cloud_bigquery::model::StreamStats;
let x = ReadRowsResponse::new().set_or_clear_stats(Some(StreamStats::default()/* use setters */));
let x = ReadRowsResponse::new().set_or_clear_stats(None::<StreamStats>);

pub fn set_throttle_state<T>(self, v: T) -> Self

where T: Into<ThrottleState>,

Sets the value of throttle_state.

Example

use google_cloud_bigquery::model::ThrottleState;
let x = ReadRowsResponse::new().set_throttle_state(ThrottleState::default()/* use setters */);

pub fn set_or_clear_throttle_state<T>(self, v: Option<T>) -> Self

where T: Into<ThrottleState>,

Sets or clears the value of throttle_state.

Example

use google_cloud_bigquery::model::ThrottleState;
let x = ReadRowsResponse::new().set_or_clear_throttle_state(Some(ThrottleState::default()/* use setters */));
let x = ReadRowsResponse::new().set_or_clear_throttle_state(None::<ThrottleState>);

pub fn set_uncompressed_byte_size<T>(self, v: T) -> Self

where T: Into<i64>,

Sets the value of uncompressed_byte_size.

Example

let x = ReadRowsResponse::new().set_uncompressed_byte_size(42);

pub fn set_or_clear_uncompressed_byte_size<T>(self, v: Option<T>) -> Self

where T: Into<i64>,

Sets or clears the value of uncompressed_byte_size.

Example

let x = ReadRowsResponse::new().set_or_clear_uncompressed_byte_size(Some(42));
let x = ReadRowsResponse::new().set_or_clear_uncompressed_byte_size(None::<i32>);

pub fn set_total_estimated_row_count<T>(self, v: T) -> Self

where T: Into<i64>,

Sets the value of total_estimated_row_count.

Example

let x = ReadRowsResponse::new().set_total_estimated_row_count(42);

pub fn set_or_clear_total_estimated_row_count<T>(self, v: Option<T>) -> Self

where T: Into<i64>,

Sets or clears the value of total_estimated_row_count.

Example

let x = ReadRowsResponse::new().set_or_clear_total_estimated_row_count(Some(42));
let x = ReadRowsResponse::new().set_or_clear_total_estimated_row_count(None::<i32>);

pub fn set_rows<T: Into<Option<Rows>>>(self, v: T) -> Self

Sets the value of rows.

Note that all the setters affecting rows are mutually exclusive.

Example

use google_cloud_bigquery::model::AvroRows;
let x = ReadRowsResponse::new().set_rows(Some(
    google_cloud_bigquery::model::read_rows_response::Rows::AvroRows(AvroRows::default().into())));

pub fn avro_rows(&self) -> Option<&Box<AvroRows>>

The value of rows if it holds a AvroRows, None if the field is not set or holds a different branch.

pub fn set_avro_rows<T: Into<Box<AvroRows>>>(self, v: T) -> Self

Sets the value of rows to hold a AvroRows.

Note that all the setters affecting rows are mutually exclusive.

Example

use google_cloud_bigquery::model::AvroRows;
let x = ReadRowsResponse::new().set_avro_rows(AvroRows::default()/* use setters */);
assert!(x.avro_rows().is_some());
assert!(x.arrow_record_batch().is_none());

pub fn arrow_record_batch(&self) -> Option<&Box<ArrowRecordBatch>>

The value of rows if it holds a ArrowRecordBatch, None if the field is not set or holds a different branch.

pub fn set_arrow_record_batch<T: Into<Box<ArrowRecordBatch>>>( self, v: T, ) -> Self

Sets the value of rows to hold a ArrowRecordBatch.

Note that all the setters affecting rows are mutually exclusive.

Example

use google_cloud_bigquery::model::ArrowRecordBatch;
let x = ReadRowsResponse::new().set_arrow_record_batch(ArrowRecordBatch::default()/* use setters */);
assert!(x.arrow_record_batch().is_some());
assert!(x.avro_rows().is_none());

pub fn set_schema<T: Into<Option<Schema>>>(self, v: T) -> Self

Sets the value of schema.

Note that all the setters affecting schema are mutually exclusive.

Example

use google_cloud_bigquery::model::AvroSchema;
let x = ReadRowsResponse::new().set_schema(Some(
    google_cloud_bigquery::model::read_rows_response::Schema::AvroSchema(AvroSchema::default().into())));

pub fn avro_schema(&self) -> Option<&Box<AvroSchema>>

The value of schema if it holds a AvroSchema, None if the field is not set or holds a different branch.

pub fn set_avro_schema<T: Into<Box<AvroSchema>>>(self, v: T) -> Self

Sets the value of schema to hold a AvroSchema.

Note that all the setters affecting schema are mutually exclusive.

Example

use google_cloud_bigquery::model::AvroSchema;
let x = ReadRowsResponse::new().set_avro_schema(AvroSchema::default()/* use setters */);
assert!(x.avro_schema().is_some());
assert!(x.arrow_schema().is_none());

pub fn arrow_schema(&self) -> Option<&Box<ArrowSchema>>

The value of schema if it holds a ArrowSchema, None if the field is not set or holds a different branch.

pub fn set_arrow_schema<T: Into<Box<ArrowSchema>>>(self, v: T) -> Self

Sets the value of schema to hold a ArrowSchema.

Note that all the setters affecting schema are mutually exclusive.

Example

use google_cloud_bigquery::model::ArrowSchema;
let x = ReadRowsResponse::new().set_arrow_schema(ArrowSchema::default()/* use setters */);
assert!(x.arrow_schema().is_some());
assert!(x.avro_schema().is_none());

Trait Implementations

impl Clone for ReadRowsResponse

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ReadRowsResponse

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

Formats the value using the given formatter.

impl Default for ReadRowsResponse

fn default() -> Self

Returns the “default value” for a type.

impl Message for ReadRowsResponse

fn typename() -> &'static str

The typename of this message.

impl PartialEq for ReadRowsResponse

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ReadRowsResponse