Reference documentation and code samples for the Google BigQuery Storage V1 Client class CreateReadSessionRequest.
Request message for CreateReadSession.
Generated from protobuf message google.cloud.bigquery.storage.v1.CreateReadSessionRequest
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ parent |
string
Required. The request project that owns the session, in the form of |
↳ read_session |
Google\Cloud\BigQuery\Storage\V1\ReadSession
Required. Session to be created. |
↳ max_stream_count |
int
Max initial number of streams. If unset or zero, the server will provide a value of streams so as to produce reasonable throughput. Must be non-negative. The number of streams may be lower than the requested number, depending on the amount parallelism that is reasonable for the table. Error will be returned if the max count is greater than the current system max limit of 1,000. Streams must be read starting from offset 0. |
getParent
Required. The request project that owns the session, in the form of
projects/{project_id}.
| Returns | |
|---|---|
| Type | Description |
string | |
setParent
Required. The request project that owns the session, in the form of
projects/{project_id}.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getReadSession
Required. Session to be created.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\BigQuery\Storage\V1\ReadSession|null | |
hasReadSession
clearReadSession
setReadSession
Required. Session to be created.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\BigQuery\Storage\V1\ReadSession
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getMaxStreamCount
Max initial number of streams. If unset or zero, the server will provide a value of streams so as to produce reasonable throughput. Must be non-negative. The number of streams may be lower than the requested number, depending on the amount parallelism that is reasonable for the table. Error will be returned if the max count is greater than the current system max limit of 1,000.
Streams must be read starting from offset 0.
| Returns | |
|---|---|
| Type | Description |
int | |
setMaxStreamCount
Max initial number of streams. If unset or zero, the server will provide a value of streams so as to produce reasonable throughput. Must be non-negative. The number of streams may be lower than the requested number, depending on the amount parallelism that is reasonable for the table. Error will be returned if the max count is greater than the current system max limit of 1,000.
Streams must be read starting from offset 0.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |