Google BigQuery Storage V1 Client - Class SplitReadStreamRequest (1.5.0)

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

Request message for SplitReadStream.

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

Namespace

Google \ Cloud \ BigQuery \ Storage \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ name string

Required. Name of the stream to split.

↳ fraction float

A value in the range (0.0, 1.0) that specifies the fractional point at which the original stream should be split. The actual split point is evaluated on pre-filtered rows, so if a filter is provided, then there is no guarantee that the division of the rows between the new child streams will be proportional to this fractional value. Additionally, because the server-side unit for assigning data is collections of rows, this fraction will always map to a data storage boundary on the server side.

getName

Required. Name of the stream to split.

Returns
TypeDescription
string

setName

Required. Name of the stream to split.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getFraction

A value in the range (0.0, 1.0) that specifies the fractional point at which the original stream should be split. The actual split point is evaluated on pre-filtered rows, so if a filter is provided, then there is no guarantee that the division of the rows between the new child streams will be proportional to this fractional value. Additionally, because the server-side unit for assigning data is collections of rows, this fraction will always map to a data storage boundary on the server side.

Returns
TypeDescription
float

setFraction

A value in the range (0.0, 1.0) that specifies the fractional point at which the original stream should be split. The actual split point is evaluated on pre-filtered rows, so if a filter is provided, then there is no guarantee that the division of the rows between the new child streams will be proportional to this fractional value. Additionally, because the server-side unit for assigning data is collections of rows, this fraction will always map to a data storage boundary on the server side.

Parameter
NameDescription
var float
Returns
TypeDescription
$this