Struct ReadRowsRequest 

#[non_exhaustive]
pub struct ReadRowsRequest {
    pub read_stream: String,
    pub offset: i64,
    pub output_format_serialization_options: Option<OutputFormatSerializationOptions>,
    /* private fields */
}

Request message for ReadRows.

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.

read_stream: String

Required. Stream to read rows from.

offset: i64

The offset requested must be less than the last row read from Read. Requesting a larger offset is undefined. If not specified, start reading from offset zero.

output_format_serialization_options: Option<OutputFormatSerializationOptions>

Specifies output serialization options. Only job _default streams are supported.

This feature is not yet available.

Implementations

impl ReadRowsRequest

pub fn new() -> Self

Creates a new default instance.

pub fn set_read_stream<T: Into<String>>(self, v: T) -> Self

Sets the value of read_stream.

Example

let x = ReadRowsRequest::new().set_read_stream(format!("projects/{project_id}/locations/{location_id}/sessions/{session_id}/streams/{stream_id}"));

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

Sets the value of offset.

Example

let x = ReadRowsRequest::new().set_offset(42);

pub fn set_output_format_serialization_options<T: Into<Option<OutputFormatSerializationOptions>>>( self, v: T, ) -> Self

Sets the value of output_format_serialization_options.

Note that all the setters affecting output_format_serialization_options are mutually exclusive.

Example

use google_cloud_bigquery::model::ArrowSerializationOptions;
let x = ReadRowsRequest::new().set_output_format_serialization_options(Some(
    google_cloud_bigquery::model::read_rows_request::OutputFormatSerializationOptions::ArrowSerializationOptions(ArrowSerializationOptions::default().into())));

pub fn arrow_serialization_options( &self, ) -> Option<&Box<ArrowSerializationOptions>>

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

pub fn set_arrow_serialization_options<T: Into<Box<ArrowSerializationOptions>>>( self, v: T, ) -> Self

Sets the value of output_format_serialization_options to hold a ArrowSerializationOptions.

Note that all the setters affecting output_format_serialization_options are mutually exclusive.

Example

use google_cloud_bigquery::model::ArrowSerializationOptions;
let x = ReadRowsRequest::new().set_arrow_serialization_options(ArrowSerializationOptions::default()/* use setters */);
assert!(x.arrow_serialization_options().is_some());

Trait Implementations

impl Clone for ReadRowsRequest

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 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 typename() -> &'static str

The typename of this message.

impl PartialEq for ReadRowsRequest

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ReadRowsRequest