Google BigQuery Storage V1 Client - Class ReadRowsResponse (1.5.0)

Version 1.5.0

• 2.1.0 (latest)
• 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	Google\Cloud\BigQuery\Storage\V1\AvroRows Serialized row data in AVRO format.
↳ arrow_record_batch	Google\Cloud\BigQuery\Storage\V1\ArrowRecordBatch Serialized row data in Arrow RecordBatch format.
↳ row_count	int|string Number of serialized rows in the rows block.
↳ stats	Google\Cloud\BigQuery\Storage\V1\StreamStats Statistics for the stream.
↳ throttle_state	Google\Cloud\BigQuery\Storage\V1\ThrottleState Throttling state. If unset, the latest response still describes the current throttling status.
↳ avro_schema	Google\Cloud\BigQuery\Storage\V1\AvroSchema Output only. Avro schema.
↳ arrow_schema	Google\Cloud\BigQuery\Storage\V1\ArrowSchema Output only. Arrow schema.

getAvroRows

Serialized row data in AVRO format.

Returns
Type	Description
Google\Cloud\BigQuery\Storage\V1\AvroRows|null

hasAvroRows

setAvroRows

Serialized row data in AVRO format.

Parameter
Name	Description
var	Google\Cloud\BigQuery\Storage\V1\AvroRows

Returns
Type	Description
$this

getArrowRecordBatch

Serialized row data in Arrow RecordBatch format.

Returns
Type	Description
Google\Cloud\BigQuery\Storage\V1\ArrowRecordBatch|null

hasArrowRecordBatch

setArrowRecordBatch

Serialized row data in Arrow RecordBatch format.

Parameter
Name	Description
var	Google\Cloud\BigQuery\Storage\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
Google\Cloud\BigQuery\Storage\V1\StreamStats|null

hasStats

clearStats

setStats

Statistics for the stream.

Parameter
Name	Description
var	Google\Cloud\BigQuery\Storage\V1\StreamStats

Returns
Type	Description
$this

getThrottleState

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

Returns
Type	Description
Google\Cloud\BigQuery\Storage\V1\ThrottleState|null

hasThrottleState

clearThrottleState

setThrottleState

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

Parameter
Name	Description
var	Google\Cloud\BigQuery\Storage\V1\ThrottleState

Returns
Type	Description
$this

getAvroSchema

Output only. Avro schema.

Returns
Type	Description
Google\Cloud\BigQuery\Storage\V1\AvroSchema|null

hasAvroSchema

setAvroSchema

Output only. Avro schema.

Parameter
Name	Description
var	Google\Cloud\BigQuery\Storage\V1\AvroSchema

Returns
Type	Description
$this

getArrowSchema

Output only. Arrow schema.

Returns
Type	Description
Google\Cloud\BigQuery\Storage\V1\ArrowSchema|null

hasArrowSchema

setArrowSchema

Output only. Arrow schema.

Parameter
Name	Description
var	Google\Cloud\BigQuery\Storage\V1\ArrowSchema

Returns
Type	Description
$this

getRows

Returns
Type	Description
string

getSchema

Returns
Type	Description
string