Struct CreateReadSessionRequest 

#[non_exhaustive]
pub struct CreateReadSessionRequest {
    pub parent: String,
    pub read_session: Option<ReadSession>,
    pub max_stream_count: i32,
    pub preferred_min_stream_count: i32,
    /* private fields */
}

Request message for CreateReadSession.

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.

parent: String

Required. The request project that owns the session, in the form of projects/{project_id}.

read_session: Option<ReadSession>

Required. Session to be created.

max_stream_count: i32

Max initial number of streams. If unset or zero, the server 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. There is a default system max limit of 1,000.

This must be greater than or equal to preferred_min_stream_count. Typically, clients should either leave this unset to let the system to determine an upper bound OR set this a size for the maximum “units of work” it can gracefully handle.

preferred_min_stream_count: i32

The minimum preferred stream count. This parameter can be used to inform the service that there is a desired lower bound on the number of streams. This is typically a target parallelism of the client (e.g. a Spark cluster with N-workers would set this to a low multiple of N to ensure good cluster utilization).

The system will make a best effort to provide at least this number of streams, but in some cases might provide less.

Implementations

impl CreateReadSessionRequest

pub fn new() -> Self

Creates a new default instance.

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

Sets the value of parent.

Example

let x = CreateReadSessionRequest::new().set_parent("example");

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

where T: Into<ReadSession>,

Sets the value of read_session.

Example

use google_cloud_bigquery::model::ReadSession;
let x = CreateReadSessionRequest::new().set_read_session(ReadSession::default()/* use setters */);

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

where T: Into<ReadSession>,

Sets or clears the value of read_session.

Example

use google_cloud_bigquery::model::ReadSession;
let x = CreateReadSessionRequest::new().set_or_clear_read_session(Some(ReadSession::default()/* use setters */));
let x = CreateReadSessionRequest::new().set_or_clear_read_session(None::<ReadSession>);

pub fn set_max_stream_count<T: Into<i32>>(self, v: T) -> Self

Sets the value of max_stream_count.

Example

let x = CreateReadSessionRequest::new().set_max_stream_count(42);

pub fn set_preferred_min_stream_count<T: Into<i32>>(self, v: T) -> Self

Sets the value of preferred_min_stream_count.

Example

let x = CreateReadSessionRequest::new().set_preferred_min_stream_count(42);

Trait Implementations

impl Clone for CreateReadSessionRequest

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

The typename of this message.

impl PartialEq for CreateReadSessionRequest

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for CreateReadSessionRequest