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 herehttps://github.com/apache/arrow/issues/15102where 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.
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 herehttps://github.com/apache/arrow/issues/15102where
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.
Returns
Type
Description
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 herehttps://github.com/apache/arrow/issues/15102where
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google BigQuery Storage V1 Client - Class ReadRowsResponse (2.1.5)\n\nVersion latestkeyboard_arrow_down\n\n- [2.1.5 (latest)](/php/docs/reference/cloud-bigquery-storage/latest/V1.ReadRowsResponse)\n- [2.1.4](/php/docs/reference/cloud-bigquery-storage/2.1.4/V1.ReadRowsResponse)\n- [2.0.0](/php/docs/reference/cloud-bigquery-storage/2.0.0/V1.ReadRowsResponse)\n- [1.10.4](/php/docs/reference/cloud-bigquery-storage/1.10.4/V1.ReadRowsResponse)\n- [1.9.0](/php/docs/reference/cloud-bigquery-storage/1.9.0/V1.ReadRowsResponse)\n- [1.8.0](/php/docs/reference/cloud-bigquery-storage/1.8.0/V1.ReadRowsResponse)\n- [1.7.1](/php/docs/reference/cloud-bigquery-storage/1.7.1/V1.ReadRowsResponse)\n- [1.6.0](/php/docs/reference/cloud-bigquery-storage/1.6.0/V1.ReadRowsResponse)\n- [1.5.0](/php/docs/reference/cloud-bigquery-storage/1.5.0/V1.ReadRowsResponse)\n- [1.4.1](/php/docs/reference/cloud-bigquery-storage/1.4.1/V1.ReadRowsResponse)\n- [1.3.2](/php/docs/reference/cloud-bigquery-storage/1.3.2/V1.ReadRowsResponse)\n- [1.2.12](/php/docs/reference/cloud-bigquery-storage/1.2.12/V1.ReadRowsResponse) \nReference documentation and code samples for the Google BigQuery Storage V1 Client class ReadRowsResponse.\n\nResponse from calling `ReadRows` may include row data, progress and\nthrottling information.\n\nGenerated from protobuf message `google.cloud.bigquery.storage.v1.ReadRowsResponse`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ BigQuery \\\\ Storage \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getAvroRows\n\nSerialized row data in AVRO format.\n\n### hasAvroRows\n\n### setAvroRows\n\nSerialized row data in AVRO format.\n\n### getArrowRecordBatch\n\nSerialized row data in Arrow RecordBatch format.\n\n### hasArrowRecordBatch\n\n### setArrowRecordBatch\n\nSerialized row data in Arrow RecordBatch format.\n\n### getRowCount\n\nNumber of serialized rows in the rows block.\n\n### setRowCount\n\nNumber of serialized rows in the rows block.\n\n### getStats\n\nStatistics for the stream.\n\n### hasStats\n\n### clearStats\n\n### setStats\n\nStatistics for the stream.\n\n### getThrottleState\n\nThrottling state. If unset, the latest response still describes\nthe current throttling status.\n\n### hasThrottleState\n\n### clearThrottleState\n\n### setThrottleState\n\nThrottling state. If unset, the latest response still describes\nthe current throttling status.\n\n### getAvroSchema\n\nOutput only. Avro schema.\n\n### hasAvroSchema\n\n### setAvroSchema\n\nOutput only. Avro schema.\n\n### getArrowSchema\n\nOutput only. Arrow schema.\n\n### hasArrowSchema\n\n### setArrowSchema\n\nOutput only. Arrow schema.\n\n### getUncompressedByteSize\n\nOptional. If the row data in this ReadRowsResponse is compressed, then\nuncompressed byte size is the original size of the uncompressed row data.\n\nIf it is set to a value greater than 0, then decompress into a buffer of\nsize uncompressed_byte_size using the compression codec that was requested\nduring session creation time and which is specified in\nTableReadOptions.response_compression_codec in ReadSession.\nThis value is not set if no response_compression_codec was not requested\nand it is -1 if the requested compression would not have reduced the size\nof this ReadRowsResponse's row data. This attempts to match Apache Arrow's\nbehavior described here \u003chttps://github.com/apache/arrow/issues/15102\u003e where\nthe uncompressed length may be set to -1 to indicate that the data that\nfollows is not compressed, which can be useful for cases where compression\ndoes not yield appreciable savings. When uncompressed_byte_size is not\ngreater than 0, the client should skip decompression.\n\n### hasUncompressedByteSize\n\n### clearUncompressedByteSize\n\n### setUncompressedByteSize\n\nOptional. If the row data in this ReadRowsResponse is compressed, then\nuncompressed byte size is the original size of the uncompressed row data.\n\nIf it is set to a value greater than 0, then decompress into a buffer of\nsize uncompressed_byte_size using the compression codec that was requested\nduring session creation time and which is specified in\nTableReadOptions.response_compression_codec in ReadSession.\nThis value is not set if no response_compression_codec was not requested\nand it is -1 if the requested compression would not have reduced the size\nof this ReadRowsResponse's row data. This attempts to match Apache Arrow's\nbehavior described here \u003chttps://github.com/apache/arrow/issues/15102\u003e where\nthe uncompressed length may be set to -1 to indicate that the data that\nfollows is not compressed, which can be useful for cases where compression\ndoes not yield appreciable savings. When uncompressed_byte_size is not\ngreater than 0, the client should skip decompression.\n\n### getRows\n\n### getSchema"]]
