Reference documentation and code samples for the BigQuery Storage V1 API class Google::Cloud::Bigquery::Storage::V1::WriteStream.
Information about a single stream that gets data inside the storage system.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#commit_time
def commit_time() -> ::Google::Protobuf::Timestamp
Returns
-
(::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 ascreate_time
. If the stream is ofPENDING
type, empty commit_time means it is not committed.
#create_time
def create_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — Output only. Create time of the stream. For the _default stream, this is the creation_time of the table.
#location
def location() -> ::String
Returns
- (::String) — Immutable. The geographic location where the stream's dataset resides. See https://cloud.google.com/bigquery/docs/locations for supported locations.
#location=
def location=(value) -> ::String
Parameter
- value (::String) — Immutable. The geographic location where the stream's dataset resides. See https://cloud.google.com/bigquery/docs/locations for supported locations.
Returns
- (::String) — Immutable. The geographic location where the stream's dataset resides. See https://cloud.google.com/bigquery/docs/locations for supported locations.
#name
def name() -> ::String
Returns
-
(::String) — Output only. Name of the stream, in the form
projects/{project}/datasets/{dataset}/tables/{table}/streams/{stream}
.
#table_schema
def table_schema() -> ::Google::Cloud::Bigquery::Storage::V1::TableSchema
Returns
-
(::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 initialAppendRowsRequest
. The table schema could go out of date during the life time of the stream.
#type
def type() -> ::Google::Cloud::Bigquery::Storage::V1::WriteStream::Type
Returns
- (::Google::Cloud::Bigquery::Storage::V1::WriteStream::Type) — Immutable. Type of the stream.
#type=
def type=(value) -> ::Google::Cloud::Bigquery::Storage::V1::WriteStream::Type
Parameter
- value (::Google::Cloud::Bigquery::Storage::V1::WriteStream::Type) — Immutable. Type of the stream.
Returns
- (::Google::Cloud::Bigquery::Storage::V1::WriteStream::Type) — Immutable. Type of the stream.
#write_mode
def write_mode() -> ::Google::Cloud::Bigquery::Storage::V1::WriteStream::WriteMode
Returns
- (::Google::Cloud::Bigquery::Storage::V1::WriteStream::WriteMode) — Immutable. Mode of the stream.
#write_mode=
def write_mode=(value) -> ::Google::Cloud::Bigquery::Storage::V1::WriteStream::WriteMode
Parameter
- value (::Google::Cloud::Bigquery::Storage::V1::WriteStream::WriteMode) — Immutable. Mode of the stream.
Returns
- (::Google::Cloud::Bigquery::Storage::V1::WriteStream::WriteMode) — Immutable. Mode of the stream.