Google BigQuery Storage V1 Client - Class CreateReadSessionRequest (1.8.0)

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

Namespace

Google \ Cloud \ BigQuery \ Storage \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ parent string

Required. The request project that owns the session, in the form of projects/{project_id}.

↳ 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. There is a default system max limit of 1,000. This must be greater than or equal to preferred_min_stream_count. Typically, clients should either leave this unset to let the system to determine an upper bound OR set this a size for the maximum "units of work" it can gracefully handle.

↳ preferred_min_stream_count int

The minimum preferred stream count. This parameter can be used to inform the service that there is a desired lower bound on the number of streams. This is typically a target parallelism of the client (e.g. a Spark cluster with N-workers would set this to a low multiple of N to ensure good cluster utilization). The system will make a best effort to provide at least this number of streams, but in some cases might provide less.

getParent

Required. The request project that owns the session, in the form of projects/{project_id}.

Returns
TypeDescription
string

setParent

Required. The request project that owns the session, in the form of projects/{project_id}.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getReadSession

Required. Session to be created.

Returns
TypeDescription
Google\Cloud\BigQuery\Storage\V1\ReadSession|null

hasReadSession

clearReadSession

setReadSession

Required. Session to be created.

Parameter
NameDescription
var Google\Cloud\BigQuery\Storage\V1\ReadSession
Returns
TypeDescription
$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.

There is a default system max limit of 1,000. This must be greater than or equal to preferred_min_stream_count. Typically, clients should either leave this unset to let the system to determine an upper bound OR set this a size for the maximum "units of work" it can gracefully handle.

Returns
TypeDescription
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.

There is a default system max limit of 1,000. This must be greater than or equal to preferred_min_stream_count. Typically, clients should either leave this unset to let the system to determine an upper bound OR set this a size for the maximum "units of work" it can gracefully handle.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getPreferredMinStreamCount

The minimum preferred stream count. This parameter can be used to inform the service that there is a desired lower bound on the number of streams.

This is typically a target parallelism of the client (e.g. a Spark cluster with N-workers would set this to a low multiple of N to ensure good cluster utilization). The system will make a best effort to provide at least this number of streams, but in some cases might provide less.

Returns
TypeDescription
int

setPreferredMinStreamCount

The minimum preferred stream count. This parameter can be used to inform the service that there is a desired lower bound on the number of streams.

This is typically a target parallelism of the client (e.g. a Spark cluster with N-workers would set this to a low multiple of N to ensure good cluster utilization). The system will make a best effort to provide at least this number of streams, but in some cases might provide less.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

static::build

Parameters
NameDescription
parent string

Required. The request project that owns the session, in the form of projects/{project_id}. Please see Google\Cloud\BigQuery\Storage\V1\BigQueryReadClient::projectName() for help formatting this field.

readSession Google\Cloud\BigQuery\Storage\V1\ReadSession

Required. Session to be created.

maxStreamCount 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. There is a default system max limit of 1,000.

This must be greater than or equal to preferred_min_stream_count. Typically, clients should either leave this unset to let the system to determine an upper bound OR set this a size for the maximum "units of work" it can gracefully handle.

Returns
TypeDescription
Google\Cloud\BigQuery\Storage\V1\CreateReadSessionRequest