Class ReadSession

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
NameDescription
strname
Output only. Unique identifier for the session, in the form ``projects/{project_id}/locations/{location}/sessions/{session_id}``.
google.protobuf.timestamp_pb2.Timestampexpire_time
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.
google.cloud.bigquery_storage_v1.types.DataFormatdata_format
Immutable. Data format of the output data.
google.cloud.bigquery_storage_v1.types.AvroSchemaavro_schema
Output only. Avro schema. This field is a member of `oneof`_ ``schema``.
google.cloud.bigquery_storage_v1.types.ArrowSchemaarrow_schema
Output only. Arrow schema. This field is a member of `oneof`_ ``schema``.
strtable
Immutable. Table that this ReadSession is reading from, in the form ``projects/{project_id}/datasets/{dataset_id}/tables/{table_id}``
google.cloud.bigquery_storage_v1.types.ReadSession.TableModifierstable_modifiers
Optional. Any modifiers which are applied when reading from the specified table.
google.cloud.bigquery_storage_v1.types.ReadSession.TableReadOptionsread_options
Optional. Read options for this session (e.g. column selection, filters).
Sequence[google.cloud.bigquery_storage_v1.types.ReadStream]streams
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.
intestimated_total_bytes_scanned
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.

Inheritance

builtins.object > proto.message.Message > ReadSession

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)