Google BigQuery Storage V1 Client - Class ReadRowsRequest (2.1.5)

Reference documentation and code samples for the Google BigQuery Storage V1 Client class ReadRowsRequest.

Request message for ReadRows.

Generated from protobuf message google.cloud.bigquery.storage.v1.ReadRowsRequest

Namespace

Google \ Cloud \ BigQuery \ Storage \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ read_stream string

Required. Stream to read rows from.
↳ offset int|string

The offset requested must be less than the last row read from Read. Requesting a larger offset is undefined. If not specified, start reading from offset zero.

getReadStream

Required. Stream to read rows from.

Returns
Type Description
string

setReadStream

Required. Stream to read rows from.

Parameter
Name Description
var string
Returns
Type Description
$this

getOffset

The offset requested must be less than the last row read from Read.

Requesting a larger offset is undefined. If not specified, start reading from offset zero.

Returns
Type Description
int|string

setOffset

The offset requested must be less than the last row read from Read.

Requesting a larger offset is undefined. If not specified, start reading from offset zero.

Parameter
Name Description
var int|string
Returns
Type Description
$this

static::build

Parameters
Name Description
readStream string

Required. Stream to read rows from. Please see BigQueryReadClient::readStreamName() for help formatting this field.
offset int

The offset requested must be less than the last row read from Read. Requesting a larger offset is undefined. If not specified, start reading from offset zero.
Returns
Type Description
ReadRowsRequest