Struct gcp_client::google::cloud::bigquery::storage::v1::ReadSession

pub struct ReadSession {
    pub name: String,
    pub expire_time: Option<Timestamp>,
    pub data_format: i32,
    pub table: String,
    pub table_modifiers: Option<TableModifiers>,
    pub read_options: Option<TableReadOptions>,
    pub streams: Vec<ReadStream>,
    pub schema: Option<Schema>,
}

Information about the ReadSession.

Fields

name: String

Output only. Unique identifier for the session, in the form projects/{project_id}/locations/{location}/sessions/{session_id}.

expire_time: Option<Timestamp>

Output only. Time at which the session becomes invalid. After this time, subsequent requests to read this Session will return errors. The expire_time is automatically assigned and currently cannot be specified or updated.

data_format: i32

Immutable. Data format of the output data.

table: String

Immutable. Table that this ReadSession is reading from, in the form projects/{project_id}/datasets/{dataset_id}/tables/{table_id}

table_modifiers: Option<TableModifiers>

Optional. Any modifiers which are applied when reading from the specified table.

read_options: Option<TableReadOptions>

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

streams: Vec<ReadStream>

Output only. A list of streams created with the session.

At least one stream is created with the session. In the future, larger request_stream_count values may result in this list being unpopulated, in that case, the user will need to use a List method to get the streams instead, which is not yet available.

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.

Implementations

impl ReadSession

pub fn data_format(&self) -> DataFormat

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

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

Sets data_format to the provided enum value.

Trait Implementations

impl Clone for ReadSession

fn clone(&self) -> ReadSession

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ReadSession

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

Formats the value using the given formatter.

impl Default for ReadSession

fn default() -> ReadSession

Returns the "default value" for a type.

impl Message for ReadSession

fn encode_raw<B>(&self, buf: &mut B) where
    B: BufMut, 

fn merge_field<B>(
    &mut self,
    tag: u32,
    wire_type: WireType,
    buf: &mut B,
    ctx: DecodeContext
) -> Result<(), DecodeError> where
    B: Buf, 

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<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, 

Encodes the message to a buffer.

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

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

fn decode<B>(buf: B) -> Result<Self, DecodeError> where
    B: Buf,
    Self: Default, 

Decodes an instance of the message from a buffer.

fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError> where
    B: Buf,
    Self: Default, 

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

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

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

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

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

impl PartialEq<ReadSession> for ReadSession

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

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

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

This method tests for !=.

impl StructuralPartialEq for ReadSession