com.google.cloud.bigquery.storage.v1

Interface WriteStreamOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

WriteStream, WriteStream.Builder

public interface WriteStreamOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
com.google.protobuf.Timestamp	getCommitTime() Output only.
com.google.protobuf.TimestampOrBuilder	getCommitTimeOrBuilder() Output only.
com.google.protobuf.Timestamp	getCreateTime() Output only.
com.google.protobuf.TimestampOrBuilder	getCreateTimeOrBuilder() Output only.
String	getLocation() Immutable.
com.google.protobuf.ByteString	getLocationBytes() Immutable.
String	getName() Output only.
com.google.protobuf.ByteString	getNameBytes() Output only.
TableSchema	getTableSchema() Output only.
TableSchemaOrBuilder	getTableSchemaOrBuilder() Output only.
WriteStream.Type	getType() Immutable.
int	getTypeValue() Immutable.
WriteStream.WriteMode	getWriteMode() Immutable.
int	getWriteModeValue() Immutable.
boolean	hasCommitTime() Output only.
boolean	hasCreateTime() Output only.
boolean	hasTableSchema() Output only.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getName

String getName()

 Output only. Name of the stream, in the form
 `projects/{project}/datasets/{dataset}/tables/{table}/streams/{stream}`.
 

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The name.

getNameBytes

com.google.protobuf.ByteString getNameBytes()

 Output only. Name of the stream, in the form
 `projects/{project}/datasets/{dataset}/tables/{table}/streams/{stream}`.
 

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The bytes for name.

getTypeValue

int getTypeValue()

 Immutable. Type of the stream.
 

.google.cloud.bigquery.storage.v1.WriteStream.Type type = 2 [(.google.api.field_behavior) = IMMUTABLE];

Returns:

The enum numeric value on the wire for type.

getType

WriteStream.Type getType()

 Immutable. Type of the stream.
 

.google.cloud.bigquery.storage.v1.WriteStream.Type type = 2 [(.google.api.field_behavior) = IMMUTABLE];

Returns:

The type.

hasCreateTime

boolean hasCreateTime()

 Output only. Create time of the stream. For the _default stream, this is
 the creation_time of the table.
 

.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

Whether the createTime field is set.

getCreateTime

com.google.protobuf.Timestamp getCreateTime()

 Output only. Create time of the stream. For the _default stream, this is
 the creation_time of the table.
 

.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The createTime.

getCreateTimeOrBuilder

com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()

 Output only. Create time of the stream. For the _default stream, this is
 the creation_time of the table.
 

.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

hasCommitTime

boolean hasCommitTime()

 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.
 

.google.protobuf.Timestamp commit_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

Whether the commitTime field is set.

getCommitTime

com.google.protobuf.Timestamp 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.
 

.google.protobuf.Timestamp commit_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The commitTime.

getCommitTimeOrBuilder

com.google.protobuf.TimestampOrBuilder getCommitTimeOrBuilder()

 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.
 

.google.protobuf.Timestamp commit_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

hasTableSchema

boolean hasTableSchema()

 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.
 

.google.cloud.bigquery.storage.v1.TableSchema table_schema = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

Whether the tableSchema field is set.

getTableSchema

TableSchema 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.
 

.google.cloud.bigquery.storage.v1.TableSchema table_schema = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The tableSchema.

getTableSchemaOrBuilder

TableSchemaOrBuilder getTableSchemaOrBuilder()

 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.
 

.google.cloud.bigquery.storage.v1.TableSchema table_schema = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

getWriteModeValue

int getWriteModeValue()

 Immutable. Mode of the stream.
 

.google.cloud.bigquery.storage.v1.WriteStream.WriteMode write_mode = 7 [(.google.api.field_behavior) = IMMUTABLE];

Returns:

The enum numeric value on the wire for writeMode.

getWriteMode

WriteStream.WriteMode getWriteMode()

 Immutable. Mode of the stream.
 

.google.cloud.bigquery.storage.v1.WriteStream.WriteMode write_mode = 7 [(.google.api.field_behavior) = IMMUTABLE];

Returns:

The writeMode.

getLocation

String getLocation()

 Immutable. The geographic location where the stream's dataset resides. See
 https://cloud.google.com/bigquery/docs/locations for supported
 locations.
 

string location = 8 [(.google.api.field_behavior) = IMMUTABLE];

Returns:

The location.

getLocationBytes

com.google.protobuf.ByteString getLocationBytes()

 Immutable. The geographic location where the stream's dataset resides. See
 https://cloud.google.com/bigquery/docs/locations for supported
 locations.
 

string location = 8 [(.google.api.field_behavior) = IMMUTABLE];

Returns:

The bytes for location.