Google BigQuery Storage V1 Client - Class ReadSession (1.2.12)

Version 1.2.12

• 2.1.2 (latest)
• 2.1.1
• 2.0.0
• 1.10.4
• 1.9.0
• 1.8.0
• 1.7.1
• 1.6.0
• 1.5.0
• 1.4.1
• 1.3.2
• 1.2.12

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

Information about the ReadSession.

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

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ name	string Output only. Unique identifier for the session, in the form projects/{project_id}/locations/{location}/sessions/{session_id}.
↳ expire_time	Google\Protobuf\Timestamp Output only. Time at which the session becomes invalid. After this time, subsequent requests to read this Session will return errors. The expire_time is automatically assigned and currently cannot be specified or updated.
↳ data_format	int Immutable. Data format of the output data.
↳ avro_schema	Google\Cloud\BigQuery\Storage\V1\AvroSchema Output only. Avro schema.
↳ arrow_schema	Google\Cloud\BigQuery\Storage\V1\ArrowSchema Output only. Arrow schema.
↳ table	string Immutable. Table that this ReadSession is reading from, in the form projects/{project_id}/datasets/{dataset_id}/tables/{table_id}
↳ table_modifiers	Google\Cloud\BigQuery\Storage\V1\ReadSession\TableModifiers Optional. Any modifiers which are applied when reading from the specified table.
↳ read_options	Google\Cloud\BigQuery\Storage\V1\ReadSession\TableReadOptions Optional. Read options for this session (e.g. column selection, filters).
↳ streams	array<Google\Cloud\BigQuery\Storage\V1\ReadStream> Output only. A list of streams created with the session. At least one stream is created with the session. In the future, larger request_stream_count values may result in this list being unpopulated, in that case, the user will need to use a List method to get the streams instead, which is not yet available.

getName

Output only. Unique identifier for the session, in the form projects/{project_id}/locations/{location}/sessions/{session_id}.

Returns
Type	Description
string

setName

Output only. Unique identifier for the session, in the form projects/{project_id}/locations/{location}/sessions/{session_id}.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getExpireTime

Output only. Time at which the session becomes invalid. After this time, subsequent requests to read this Session will return errors. The expire_time is automatically assigned and currently cannot be specified or updated.

Returns
Type	Description
Google\Protobuf\Timestamp|null

hasExpireTime

clearExpireTime

setExpireTime

Output only. Time at which the session becomes invalid. After this time, subsequent requests to read this Session will return errors. The expire_time is automatically assigned and currently cannot be specified or updated.

Parameter
Name	Description
var	Google\Protobuf\Timestamp

Returns
Type	Description
$this

getDataFormat

Immutable. Data format of the output data.

Returns
Type	Description
int

setDataFormat

Immutable. Data format of the output data.

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getAvroSchema

Output only. Avro schema.

Returns
Type	Description
Google\Cloud\BigQuery\Storage\V1\AvroSchema|null

hasAvroSchema

setAvroSchema

Output only. Avro schema.

Parameter
Name	Description
var	Google\Cloud\BigQuery\Storage\V1\AvroSchema

Returns
Type	Description
$this

getArrowSchema

Output only. Arrow schema.

Returns
Type	Description
Google\Cloud\BigQuery\Storage\V1\ArrowSchema|null

hasArrowSchema

setArrowSchema

Output only. Arrow schema.

Parameter
Name	Description
var	Google\Cloud\BigQuery\Storage\V1\ArrowSchema

Returns
Type	Description
$this

getTable

Immutable. Table that this ReadSession is reading from, in the form projects/{project_id}/datasets/{dataset_id}/tables/{table_id}

Returns
Type	Description
string

setTable

Immutable. Table that this ReadSession is reading from, in the form projects/{project_id}/datasets/{dataset_id}/tables/{table_id}

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getTableModifiers

Optional. Any modifiers which are applied when reading from the specified table.

Returns
Type	Description
Google\Cloud\BigQuery\Storage\V1\ReadSession\TableModifiers|null

hasTableModifiers

clearTableModifiers

setTableModifiers

Optional. Any modifiers which are applied when reading from the specified table.

Parameter
Name	Description
var	Google\Cloud\BigQuery\Storage\V1\ReadSession\TableModifiers

Returns
Type	Description
$this

getReadOptions

Optional. Read options for this session (e.g. column selection, filters).

Returns
Type	Description
Google\Cloud\BigQuery\Storage\V1\ReadSession\TableReadOptions|null

hasReadOptions

clearReadOptions

setReadOptions

Optional. Read options for this session (e.g. column selection, filters).

Parameter
Name	Description
var	Google\Cloud\BigQuery\Storage\V1\ReadSession\TableReadOptions

Returns
Type	Description
$this

getStreams

Output only. A list of streams created with the session.

At least one stream is created with the session. In the future, larger request_stream_count values may result in this list being unpopulated, in that case, the user will need to use a List method to get the streams instead, which is not yet available.

Returns
Type	Description
Google\Protobuf\Internal\RepeatedField

setStreams

Output only. A list of streams created with the session.

At least one stream is created with the session. In the future, larger request_stream_count values may result in this list being unpopulated, in that case, the user will need to use a List method to get the streams instead, which is not yet available.

Parameter
Name	Description
var	array<Google\Cloud\BigQuery\Storage\V1\ReadStream>

Returns
Type	Description
$this

getSchema

Returns
Type	Description
string