Reference documentation and code samples for the Google BigQuery Storage V1 Client class WriteStream.
Information about a single stream that gets data inside the storage system.
Generated from protobuf message google.cloud.bigquery.storage.v1.WriteStream
Namespace
Google \ Cloud \ BigQuery \ Storage \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ name
string
Output only. Name of the stream, in the form projects/{project}/datasets/{dataset}/tables/{table}/streams/{stream}
.
↳ type
int
Immutable. Type of the stream.
↳ create_time
Google\Protobuf\Timestamp
Output only. Create time of the stream. For the _default stream, this is the creation_time of the table.
↳ commit_time
Google\Protobuf\Timestamp
Output only. Commit time of the stream. If a stream is of COMMITTED
type, then it will have a commit_time same as create_time
. If the stream is of PENDING
type, empty commit_time means it is not committed.
↳ table_schema
Google\Cloud\BigQuery\Storage\V1\TableSchema
Output only. The schema of the destination table. It is only returned in CreateWriteStream
response. Caller should generate data that's compatible with this schema to send in initial AppendRowsRequest
. The table schema could go out of date during the life time of the stream.
↳ write_mode
int
Immutable. Mode of the stream.
↳ location
string
Immutable. The geographic location where the stream's dataset resides. See https://cloud.google.com/bigquery/docs/locations for supported locations.
getName
Output only. Name of the stream, in the form projects/{project}/datasets/{dataset}/tables/{table}/streams/{stream}
.
string
setName
Output only. Name of the stream, in the form projects/{project}/datasets/{dataset}/tables/{table}/streams/{stream}
.
var
string
$this
getType
Immutable. Type of the stream.
int
setType
Immutable. Type of the stream.
var
int
$this
getCreateTime
Output only. Create time of the stream. For the _default stream, this is the creation_time of the table.
hasCreateTime
clearCreateTime
setCreateTime
Output only. Create time of the stream. For the _default stream, this is the creation_time of the table.
$this
getCommitTime
Output only. Commit time of the stream.
If a stream is of COMMITTED
type, then it will have a commit_time same as create_time
. If the stream is of PENDING
type, empty commit_time
means it is not committed.
hasCommitTime
clearCommitTime
setCommitTime
Output only. Commit time of the stream.
If a stream is of COMMITTED
type, then it will have a commit_time same as create_time
. If the stream is of PENDING
type, empty commit_time
means it is not committed.
$this
getTableSchema
Output only. The schema of the destination table. It is only returned in CreateWriteStream
response. Caller should generate data that's
compatible with this schema to send in initial AppendRowsRequest
.
The table schema could go out of date during the life time of the stream.
hasTableSchema
clearTableSchema
setTableSchema
Output only. The schema of the destination table. It is only returned in CreateWriteStream
response. Caller should generate data that's
compatible with this schema to send in initial AppendRowsRequest
.
The table schema could go out of date during the life time of the stream.
$this
getWriteMode
Immutable. Mode of the stream.
int
setWriteMode
Immutable. Mode of the stream.
var
int
$this
getLocation
Immutable. The geographic location where the stream's dataset resides. See https://cloud.google.com/bigquery/docs/locations for supported locations.
string
setLocation
Immutable. The geographic location where the stream's dataset resides. See https://cloud.google.com/bigquery/docs/locations for supported locations.
var
string
$this
