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
Name
Description
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
Type
Description
string
setName
Required. Name of the stream to split.
Parameter
Name
Description
var
string
Returns
Type
Description
$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
Type
Description
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.
[[["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 SplitReadStreamRequest (2.1.5)\n\nVersion latestkeyboard_arrow_down\n\n- [2.1.5 (latest)](/php/docs/reference/cloud-bigquery-storage/latest/V1.SplitReadStreamRequest)\n- [2.1.4](/php/docs/reference/cloud-bigquery-storage/2.1.4/V1.SplitReadStreamRequest)\n- [2.0.0](/php/docs/reference/cloud-bigquery-storage/2.0.0/V1.SplitReadStreamRequest)\n- [1.10.4](/php/docs/reference/cloud-bigquery-storage/1.10.4/V1.SplitReadStreamRequest)\n- [1.9.0](/php/docs/reference/cloud-bigquery-storage/1.9.0/V1.SplitReadStreamRequest)\n- [1.8.0](/php/docs/reference/cloud-bigquery-storage/1.8.0/V1.SplitReadStreamRequest)\n- [1.7.1](/php/docs/reference/cloud-bigquery-storage/1.7.1/V1.SplitReadStreamRequest)\n- [1.6.0](/php/docs/reference/cloud-bigquery-storage/1.6.0/V1.SplitReadStreamRequest)\n- [1.5.0](/php/docs/reference/cloud-bigquery-storage/1.5.0/V1.SplitReadStreamRequest)\n- [1.4.1](/php/docs/reference/cloud-bigquery-storage/1.4.1/V1.SplitReadStreamRequest)\n- [1.3.2](/php/docs/reference/cloud-bigquery-storage/1.3.2/V1.SplitReadStreamRequest)\n- [1.2.12](/php/docs/reference/cloud-bigquery-storage/1.2.12/V1.SplitReadStreamRequest) \nReference documentation and code samples for the Google BigQuery Storage V1 Client class SplitReadStreamRequest.\n\nRequest message for `SplitReadStream`.\n\nGenerated from protobuf message `google.cloud.bigquery.storage.v1.SplitReadStreamRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ BigQuery \\\\ Storage \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getName\n\nRequired. Name of the stream to split.\n\n### setName\n\nRequired. Name of the stream to split.\n\n### getFraction\n\nA value in the range (0.0, 1.0) that specifies the fractional point at\nwhich the original stream should be split. The actual split point is\nevaluated on pre-filtered rows, so if a filter is provided, then there is\nno guarantee that the division of the rows between the new child streams\nwill be proportional to this fractional value. Additionally, because the\nserver-side unit for assigning data is collections of rows, this fraction\nwill always map to a data storage boundary on the server side.\n\n### setFraction\n\nA value in the range (0.0, 1.0) that specifies the fractional point at\nwhich the original stream should be split. The actual split point is\nevaluated on pre-filtered rows, so if a filter is provided, then there is\nno guarantee that the division of the rows between the new child streams\nwill be proportional to this fractional value. Additionally, because the\nserver-side unit for assigning data is collections of rows, this fraction\nwill always map to a data storage boundary on the server side."]]
