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.
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
↳ 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}
.
string
setName
Output only. Unique identifier for the session, in the form projects/{project_id}/locations/{location}/sessions/{session_id}
.
var
string
$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.
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.
$this
getDataFormat
Immutable. Data format of the output data.
int
setDataFormat
Immutable. Data format of the output data.
var
int
$this
getAvroSchema
Output only. Avro schema.
hasAvroSchema
setAvroSchema
Output only. Avro schema.
$this
getArrowSchema
Output only. Arrow schema.
hasArrowSchema
setArrowSchema
Output only. Arrow schema.
$this
getTable
Immutable. Table that this ReadSession is reading from, in the form projects/{project_id}/datasets/{dataset_id}/tables/{table_id}
string
setTable
Immutable. Table that this ReadSession is reading from, in the form projects/{project_id}/datasets/{dataset_id}/tables/{table_id}
var
string
$this
getTableModifiers
Optional. Any modifiers which are applied when reading from the specified table.
hasTableModifiers
clearTableModifiers
setTableModifiers
Optional. Any modifiers which are applied when reading from the specified table.
$this
getReadOptions
Optional. Read options for this session (e.g. column selection, filters).
hasReadOptions
clearReadOptions
setReadOptions
Optional. Read options for this session (e.g. column selection, filters).
$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.
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.
$this
getSchema
string
