Class ReadSession (2.13.2)

Version 2.13.2

• 2.24.0 (latest)
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.1
• 2.18.1
• 2.17.0
• 2.16.2
• 2.15.0
• 2.14.2
• 2.13.2
• 2.12.0
• 2.11.0
• 2.10.1
• 2.9.1
• 2.8.0
• 2.7.0
• 2.6.3
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.1
• 2.1.0
• 2.0.1
• 1.1.2
• 1.0.0
• 0.8.0
• 0.7.0
• 0.6.0

ReadSession(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Information about the ReadSession.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Attributes

Name	Description
name	str Output only. Unique identifier for the session, in the form projects/{project_id}/locations/{location}/sessions/{session_id}.
expire_time	google.protobuf.timestamp_pb2.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	google.cloud.bigquery_storage_v1beta2.types.DataFormat Immutable. Data format of the output data.
avro_schema	google.cloud.bigquery_storage_v1beta2.types.AvroSchema Output only. Avro schema. This field is a member of oneof_ schema.
arrow_schema	google.cloud.bigquery_storage_v1beta2.types.ArrowSchema Output only. Arrow schema. This field is a member of oneof_ schema.
table	str Immutable. Table that this ReadSession is reading from, in the form \`projects/{project_id}/datasets/{dataset_id}/tables/{table_id}
table_modifiers	google.cloud.bigquery_storage_v1beta2.types.ReadSession.TableModifiers Optional. Any modifiers which are applied when reading from the specified table.
read_options	google.cloud.bigquery_storage_v1beta2.types.ReadSession.TableReadOptions Optional. Read options for this session (e.g. column selection, filters).
streams	Sequence[google.cloud.bigquery_storage_v1beta2.types.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.

Classes

TableModifiers

TableModifiers(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Additional attributes when reading a table.

TableReadOptions

TableReadOptions(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Options dictating how we read a table.