Reference documentation and code samples for the Google BigQuery Storage V1 Client class ReadRowsResponse.
Response from calling ReadRows
may include row data, progress and
throttling information.
Generated from protobuf message google.cloud.bigquery.storage.v1.ReadRowsResponse
Namespace
Google \ Cloud \ BigQuery \ Storage \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ avro_rows
↳ arrow_record_batch
↳ row_count
int|string
Number of serialized rows in the rows block.
↳ stats
↳ throttle_state
Google\Cloud\BigQuery\Storage\V1\ThrottleState
Throttling state. If unset, the latest response still describes the current throttling status.
↳ avro_schema
↳ arrow_schema
↳ uncompressed_byte_size
int|string
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.
getAvroRows
Serialized row data in AVRO format.
hasAvroRows
setAvroRows
Serialized row data in AVRO format.
$this
getArrowRecordBatch
Serialized row data in Arrow RecordBatch format.
hasArrowRecordBatch
setArrowRecordBatch
Serialized row data in Arrow RecordBatch format.
$this
getRowCount
Number of serialized rows in the rows block.
int|string
setRowCount
Number of serialized rows in the rows block.
var
int|string
$this
getStats
Statistics for the stream.
hasStats
clearStats
setStats
Statistics for the stream.
$this
getThrottleState
Throttling state. If unset, the latest response still describes the current throttling status.
hasThrottleState
clearThrottleState
setThrottleState
Throttling state. If unset, the latest response still describes the current throttling status.
$this
getAvroSchema
Output only. Avro schema.
hasAvroSchema
setAvroSchema
Output only. Avro schema.
$this
getArrowSchema
Output only. Arrow schema.
hasArrowSchema
setArrowSchema
Output only. Arrow schema.
$this
getUncompressedByteSize
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.
int|string
hasUncompressedByteSize
clearUncompressedByteSize
setUncompressedByteSize
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.
var
int|string
$this
getRows
string
getSchema
string
