Class WriteStream.Builder (2.33.0)

public static final class WriteStream.Builder extends GeneratedMessageV3.Builder<WriteStream.Builder> implements WriteStreamOrBuilder

Information about a single stream that gets data inside the storage system.

Protobuf type google.cloud.bigquery.storage.v1beta2.WriteStream

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public WriteStream.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
WriteStream.Builder
Overrides

build()

public WriteStream build()
Returns
TypeDescription
WriteStream

buildPartial()

public WriteStream buildPartial()
Returns
TypeDescription
WriteStream

clear()

public WriteStream.Builder clear()
Returns
TypeDescription
WriteStream.Builder
Overrides

clearCommitTime()

public WriteStream.Builder clearCommitTime()

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, commit_time being empty means it is not committed.

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

Returns
TypeDescription
WriteStream.Builder

clearCreateTime()

public WriteStream.Builder clearCreateTime()

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
TypeDescription
WriteStream.Builder

clearField(Descriptors.FieldDescriptor field)

public WriteStream.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
WriteStream.Builder
Overrides

clearName()

public WriteStream.Builder clearName()

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
TypeDescription
WriteStream.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public WriteStream.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
WriteStream.Builder
Overrides

clearTableSchema()

public WriteStream.Builder clearTableSchema()

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.v1beta2.TableSchema table_schema = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
WriteStream.Builder

clearType()

public WriteStream.Builder clearType()

Immutable. Type of the stream.

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

Returns
TypeDescription
WriteStream.Builder

This builder for chaining.

clone()

public WriteStream.Builder clone()
Returns
TypeDescription
WriteStream.Builder
Overrides

getCommitTime()

public 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, commit_time being empty means it is not committed.

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

Returns
TypeDescription
Timestamp

The commitTime.

getCommitTimeBuilder()

public Timestamp.Builder getCommitTimeBuilder()

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, commit_time being empty means it is not committed.

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

Returns
TypeDescription
Builder

getCommitTimeOrBuilder()

public 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, commit_time being empty means it is not committed.

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

Returns
TypeDescription
TimestampOrBuilder

getCreateTime()

public 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
TypeDescription
Timestamp

The createTime.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

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
TypeDescription
Builder

getCreateTimeOrBuilder()

public 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];

Returns
TypeDescription
TimestampOrBuilder

getDefaultInstanceForType()

public WriteStream getDefaultInstanceForType()
Returns
TypeDescription
WriteStream

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getName()

public 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
TypeDescription
String

The name.

getNameBytes()

public 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
TypeDescription
ByteString

The bytes for name.

getTableSchema()

public 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.v1beta2.TableSchema table_schema = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
TableSchema

The tableSchema.

getTableSchemaBuilder()

public TableSchema.Builder getTableSchemaBuilder()

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.v1beta2.TableSchema table_schema = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
TableSchema.Builder

getTableSchemaOrBuilder()

public 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.v1beta2.TableSchema table_schema = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
TableSchemaOrBuilder

getType()

public WriteStream.Type getType()

Immutable. Type of the stream.

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

Returns
TypeDescription
WriteStream.Type

The type.

getTypeValue()

public int getTypeValue()

Immutable. Type of the stream.

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

Returns
TypeDescription
int

The enum numeric value on the wire for type.

hasCommitTime()

public 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, commit_time being empty means it is not committed.

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

Returns
TypeDescription
boolean

Whether the commitTime field is set.

hasCreateTime()

public 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
TypeDescription
boolean

Whether the createTime field is set.

hasTableSchema()

public 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.v1beta2.TableSchema table_schema = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
boolean

Whether the tableSchema field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeCommitTime(Timestamp value)

public WriteStream.Builder mergeCommitTime(Timestamp value)

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, commit_time being empty means it is not committed.

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

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
WriteStream.Builder

mergeCreateTime(Timestamp value)

public WriteStream.Builder mergeCreateTime(Timestamp value)

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];

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
WriteStream.Builder

mergeFrom(WriteStream other)

public WriteStream.Builder mergeFrom(WriteStream other)
Parameter
NameDescription
otherWriteStream
Returns
TypeDescription
WriteStream.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public WriteStream.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
WriteStream.Builder
Overrides Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public WriteStream.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
WriteStream.Builder
Overrides

mergeTableSchema(TableSchema value)

public WriteStream.Builder mergeTableSchema(TableSchema value)

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.v1beta2.TableSchema table_schema = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
valueTableSchema
Returns
TypeDescription
WriteStream.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final WriteStream.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
WriteStream.Builder
Overrides

setCommitTime(Timestamp value)

public WriteStream.Builder setCommitTime(Timestamp value)

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, commit_time being empty means it is not committed.

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

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
WriteStream.Builder

setCommitTime(Timestamp.Builder builderForValue)

public WriteStream.Builder setCommitTime(Timestamp.Builder builderForValue)

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, commit_time being empty means it is not committed.

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

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
WriteStream.Builder

setCreateTime(Timestamp value)

public WriteStream.Builder setCreateTime(Timestamp value)

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];

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
WriteStream.Builder

setCreateTime(Timestamp.Builder builderForValue)

public WriteStream.Builder setCreateTime(Timestamp.Builder builderForValue)

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];

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
WriteStream.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public WriteStream.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
WriteStream.Builder
Overrides

setName(String value)

public WriteStream.Builder setName(String value)

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];

Parameter
NameDescription
valueString

The name to set.

Returns
TypeDescription
WriteStream.Builder

This builder for chaining.

setNameBytes(ByteString value)

public WriteStream.Builder setNameBytes(ByteString value)

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];

Parameter
NameDescription
valueByteString

The bytes for name to set.

Returns
TypeDescription
WriteStream.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public WriteStream.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
WriteStream.Builder
Overrides

setTableSchema(TableSchema value)

public WriteStream.Builder setTableSchema(TableSchema value)

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.v1beta2.TableSchema table_schema = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
valueTableSchema
Returns
TypeDescription
WriteStream.Builder

setTableSchema(TableSchema.Builder builderForValue)

public WriteStream.Builder setTableSchema(TableSchema.Builder builderForValue)

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.v1beta2.TableSchema table_schema = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
builderForValueTableSchema.Builder
Returns
TypeDescription
WriteStream.Builder

setType(WriteStream.Type value)

public WriteStream.Builder setType(WriteStream.Type value)

Immutable. Type of the stream.

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

Parameter
NameDescription
valueWriteStream.Type

The type to set.

Returns
TypeDescription
WriteStream.Builder

This builder for chaining.

setTypeValue(int value)

public WriteStream.Builder setTypeValue(int value)

Immutable. Type of the stream.

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

Parameter
NameDescription
valueint

The enum numeric value on the wire for type to set.

Returns
TypeDescription
WriteStream.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final WriteStream.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
WriteStream.Builder
Overrides