Struct google_api_proto::google::cloud::bigquery::storage::v1beta1::CreateReadSessionRequest

pub struct CreateReadSessionRequest {
    pub table_reference: Option<TableReference>,
    pub parent: String,
    pub table_modifiers: Option<TableModifiers>,
    pub requested_streams: i32,
    pub read_options: Option<TableReadOptions>,
    pub format: i32,
    pub sharding_strategy: i32,
}

Creates a new read session, which may include additional options such as requested parallelism, projection filters and constraints.

Fields

table_reference: Option<TableReference>

Required. Reference to the table to read.

parent: String

Required. String of the form projects/{project_id} indicating the project this ReadSession is associated with. This is the project that will be billed for usage.

table_modifiers: Option<TableModifiers>

Any modifiers to the Table (e.g. snapshot timestamp).

requested_streams: i32

Initial number of streams. If unset or 0, we will provide a value of streams so as to produce reasonable throughput. Must be non-negative. The number of streams may be lower than the requested number, depending on the amount parallelism that is reasonable for the table and the maximum amount of parallelism allowed by the system.

Streams must be read starting from offset 0.

read_options: Option<TableReadOptions>

Read options for this session (e.g. column selection, filters).

format: i32

Data output format. Currently default to Avro. DATA_FORMAT_UNSPECIFIED not supported.

sharding_strategy: i32

The strategy to use for distributing data among multiple streams. Currently defaults to liquid sharding.

Implementations

impl CreateReadSessionRequest

pub fn format(&self) -> DataFormat

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

pub fn set_format(&mut self, value: DataFormat)

Sets format to the provided enum value.

pub fn sharding_strategy(&self) -> ShardingStrategy

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

pub fn set_sharding_strategy(&mut self, value: ShardingStrategy)

Sets sharding_strategy to the provided enum value.

Trait Implementations

impl Clone for CreateReadSessionRequest

fn clone(&self) -> CreateReadSessionRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateReadSessionRequest

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

Formats the value using the given formatter.

impl Default for CreateReadSessionRequest

fn default() -> Self

Returns the “default value” for a type.

impl Message for CreateReadSessionRequest

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 CreateReadSessionRequest

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for CreateReadSessionRequest