2.6.0 (latest) 2.5.4 2.3.1 2.2.1 2.1.5 2.0.0 1.10.4 1.9.0 1.8.0 1.7.1 1.6.0 1.5.0 1.4.1 1.3.2 1.2.12 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 \\ V1

## Methods

### __construct

Constructor.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `data` | `array` Optional. Data for populating the Message object. |
| `↳ avro_rows` | `https://docs.cloud.google.com/php/docs/reference/cloud-bigquery-storage/latest/V1.AvroRows` Serialized row data in AVRO format. |
| `↳ arrow_record_batch` | `https://docs.cloud.google.com/php/docs/reference/cloud-bigquery-storage/latest/V1.ArrowRecordBatch` Serialized row data in Arrow RecordBatch format. |
| `↳ row_count` | `int|string` Number of serialized rows in the rows block. |
| `↳ stats` | `https://docs.cloud.google.com/php/docs/reference/cloud-bigquery-storage/latest/V1.StreamStats` Statistics for the stream. |
| `↳ throttle_state` | `https://docs.cloud.google.com/php/docs/reference/cloud-bigquery-storage/latest/V1.ThrottleState` Throttling state. If unset, the latest response still describes the current throttling status. |
| `↳ avro_schema` | `https://docs.cloud.google.com/php/docs/reference/cloud-bigquery-storage/latest/V1.AvroSchema` Output only. Avro schema. |
| `↳ arrow_schema` | `https://docs.cloud.google.com/php/docs/reference/cloud-bigquery-storage/latest/V1.ArrowSchema` Output only. 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. |
| `↳ total_estimated_row_count` | `int|string` Output only. The total estimated number of rows in the query results. Only populated when reading data from a BigQuery job. This feature is not yet available. |

### getAvroRows

Serialized row data in AVRO format.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-bigquery-storage/latest/V1.AvroRows|null` |   |

### hasAvroRows

### setAvroRows

Serialized row data in AVRO format.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://docs.cloud.google.com/php/docs/reference/cloud-bigquery-storage/latest/V1.AvroRows` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getArrowRecordBatch

Serialized row data in Arrow RecordBatch format.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-bigquery-storage/latest/V1.ArrowRecordBatch|null` |   |

### hasArrowRecordBatch

### setArrowRecordBatch

Serialized row data in Arrow RecordBatch format.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://docs.cloud.google.com/php/docs/reference/cloud-bigquery-storage/latest/V1.ArrowRecordBatch` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getRowCount

Number of serialized rows in the rows block.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `int|string` |   |

### setRowCount

Number of serialized rows in the rows block.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `int|string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getStats

Statistics for the stream.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-bigquery-storage/latest/V1.StreamStats|null` |   |

### hasStats

### clearStats

### setStats

Statistics for the stream.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://docs.cloud.google.com/php/docs/reference/cloud-bigquery-storage/latest/V1.StreamStats` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getThrottleState

Throttling state. If unset, the latest response still describes
the current throttling status.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-bigquery-storage/latest/V1.ThrottleState|null` |   |

### hasThrottleState

### clearThrottleState

### setThrottleState

Throttling state. If unset, the latest response still describes
the current throttling status.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://docs.cloud.google.com/php/docs/reference/cloud-bigquery-storage/latest/V1.ThrottleState` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getAvroSchema

Output only. Avro schema.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-bigquery-storage/latest/V1.AvroSchema|null` |   |

### hasAvroSchema

### setAvroSchema

Output only. Avro schema.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://docs.cloud.google.com/php/docs/reference/cloud-bigquery-storage/latest/V1.AvroSchema` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getArrowSchema

Output only. Arrow schema.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-bigquery-storage/latest/V1.ArrowSchema|null` |   |

### hasArrowSchema

### setArrowSchema

Output only. Arrow schema.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://docs.cloud.google.com/php/docs/reference/cloud-bigquery-storage/latest/V1.ArrowSchema` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$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.

| **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 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.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `int|string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getTotalEstimatedRowCount

Output only. The total estimated number of rows in the query results.

Only populated when reading data from a BigQuery job.
This feature is not yet available.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `int|string` |   |

### hasTotalEstimatedRowCount

### clearTotalEstimatedRowCount

### setTotalEstimatedRowCount

Output only. The total estimated number of rows in the query results.

Only populated when reading data from a BigQuery job.
This feature is not yet available.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `int|string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getRows

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### getSchema

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |