Class ReadRowsResponse (2.25.0)

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

Response from calling ReadRows may include row data, progress and throttling information.

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
avro_rows google.cloud.bigquery_storage_v1.types.AvroRows
Serialized row data in AVRO format. This field is a member of oneof_ rows.
arrow_record_batch google.cloud.bigquery_storage_v1.types.ArrowRecordBatch
Serialized row data in Arrow RecordBatch format. This field is a member of oneof_ rows.
row_count int
Number of serialized rows in the rows block.
stats google.cloud.bigquery_storage_v1.types.StreamStats
Statistics for the stream.
throttle_state google.cloud.bigquery_storage_v1.types.ThrottleState
Throttling state. If unset, the latest response still describes the current throttling status.
avro_schema google.cloud.bigquery_storage_v1.types.AvroSchema
Output only. Avro schema. This field is a member of oneof_ schema.
arrow_schema google.cloud.bigquery_storage_v1.types.ArrowSchema
Output only. Arrow schema. This field is a member of oneof_ schema.
uncompressed_byte_size int
Optional. If the row data in this ReadRowsResponse is compressed, then uncompressed byte size is the original size of the uncompressed row data. If it is set to a value greater than 0, then decompress into a buffer of size uncompressed_byte_size using the compression codec that was requested during session creation time and which is specified in TableReadOptions.response_compression_codec in ReadSession. This value is not set if no response_compression_codec was not requested and it is -1 if the requested compression would not have reduced the size of this ReadRowsResponse's row data. This attempts to match Apache Arrow's behavior described here https://github.com/apache/arrow/issues/15102 where the uncompressed length may be set to -1 to indicate that the data that follows is not compressed, which can be useful for cases where compression does not yield appreciable savings. When uncompressed_byte_size is not greater than 0, the client should skip decompression. This field is a member of oneof_ _uncompressed_byte_size.