BigQuery Storage V1 API - Class Google::Cloud::Bigquery::Storage::V1::ReadSession (v1.5.1)

Reference documentation and code samples for the BigQuery Storage V1 API class Google::Cloud::Bigquery::Storage::V1::ReadSession.

Information about the ReadSession.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#arrow_schema

defarrow_schema()->::Google::Cloud::Bigquery::Storage::V1::ArrowSchema
Returns
  • (::Google::Cloud::Bigquery::Storage::V1::ArrowSchema) — Output only. Arrow schema.

    Note: The following fields are mutually exclusive: arrow_schema, avro_schema. If a field in that set is populated, all other fields in the set will automatically be cleared.

#avro_schema

defavro_schema()->::Google::Cloud::Bigquery::Storage::V1::AvroSchema
Returns
  • (::Google::Cloud::Bigquery::Storage::V1::AvroSchema) — Output only. Avro schema.

    Note: The following fields are mutually exclusive: avro_schema, arrow_schema. If a field in that set is populated, all other fields in the set will automatically be cleared.

#data_format

defdata_format()->::Google::Cloud::Bigquery::Storage::V1::DataFormat
Returns

#data_format=

defdata_format=(value)->::Google::Cloud::Bigquery::Storage::V1::DataFormat
Parameter
Returns

#estimated_row_count

defestimated_row_count()->::Integer
Returns
  • (::Integer) — Output only. An estimate on the number of rows present in this session's streams. This estimate is based on metadata from the table which might be incomplete or stale.

#estimated_total_bytes_scanned

defestimated_total_bytes_scanned()->::Integer
Returns
  • (::Integer) — Output only. An estimate on the number of bytes this session will scan when all streams are completely consumed. This estimate is based on metadata from the table which might be incomplete or stale.

#estimated_total_physical_file_size

defestimated_total_physical_file_size()->::Integer
Returns
  • (::Integer) — Output only. A pre-projected estimate of the total physical size of files (in bytes) that this session will scan when all streams are consumed. This estimate is independent of the selected columns and can be based on incomplete or stale metadata from the table. This field is only set for BigLake tables.

#expire_time

defexpire_time()->::Google::Protobuf::Timestamp
Returns
  • (::Google::Protobuf::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.

#name

defname()->::String
Returns
  • (::String) — Output only. Unique identifier for the session, in the form projects/{project_id}/locations/{location}/sessions/{session_id}.

#read_options

defread_options()->::Google::Cloud::Bigquery::Storage::V1::ReadSession::TableReadOptions
Returns

#read_options=

defread_options=(value)->::Google::Cloud::Bigquery::Storage::V1::ReadSession::TableReadOptions
Parameter
Returns

#streams

defstreams()->::Array<::Google::Cloud::Bigquery::Storage::V1::ReadStream>
Returns
  • (::Array<::Google::Cloud::Bigquery::Storage::V1::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.

#table

deftable()->::String
Returns
  • (::String) — Immutable. Table that this ReadSession is reading from, in the form projects/{project_id}/datasets/{dataset_id}/tables/{table_id}

#table=

deftable=(value)->::String
Parameter
  • value (::String) — Immutable. Table that this ReadSession is reading from, in the form projects/{project_id}/datasets/{dataset_id}/tables/{table_id}
Returns
  • (::String) — Immutable. Table that this ReadSession is reading from, in the form projects/{project_id}/datasets/{dataset_id}/tables/{table_id}

#table_modifiers

deftable_modifiers()->::Google::Cloud::Bigquery::Storage::V1::ReadSession::TableModifiers
Returns

#table_modifiers=

deftable_modifiers=(value)->::Google::Cloud::Bigquery::Storage::V1::ReadSession::TableModifiers
Parameter
Returns

#trace_id

deftrace_id()->::String
Returns
  • (::String) — Optional. ID set by client to annotate a session identity. This does not need to be strictly unique, but instead the same ID should be used to group logically connected sessions (e.g. All using the same ID for all sessions needed to complete a Spark SQL query is reasonable).

    Maximum length is 256 bytes.

#trace_id=

deftrace_id=(value)->::String
Parameter
  • value (::String) — Optional. ID set by client to annotate a session identity. This does not need to be strictly unique, but instead the same ID should be used to group logically connected sessions (e.g. All using the same ID for all sessions needed to complete a Spark SQL query is reasonable).

    Maximum length is 256 bytes.

Returns
  • (::String) — Optional. ID set by client to annotate a session identity. This does not need to be strictly unique, but instead the same ID should be used to group logically connected sessions (e.g. All using the same ID for all sessions needed to complete a Spark SQL query is reasonable).

    Maximum length is 256 bytes.

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025年10月30日 UTC.