Class AppendRowsRequest.Builder (3.10.3) 

public static final class AppendRowsRequest.Builder extends GeneratedMessageV3.Builder<AppendRowsRequest.Builder> implements AppendRowsRequestOrBuilder

Request message for AppendRows.

Because AppendRows is a bidirectional streaming RPC, certain parts of the AppendRowsRequest need only be specified for the first request before switching table destinations. You can also switch table destinations within the same connection for the default stream.

The size of a single AppendRowsRequest must be less than 10 MB in size. Requests larger than this return an error, typically INVALID_ARGUMENT.

Protobuf type google.cloud.bigquery.storage.v1.AppendRowsRequest

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > AppendRowsRequest.Builder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public AppendRowsRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
AppendRowsRequest.Builder
Overrides

build()

public AppendRowsRequest build()
Returns
Type Description
AppendRowsRequest

buildPartial()

public AppendRowsRequest buildPartial()
Returns
Type Description
AppendRowsRequest

clear()

public AppendRowsRequest.Builder clear()
Returns
Type Description
AppendRowsRequest.Builder
Overrides

clearArrowRows()

public AppendRowsRequest.Builder clearArrowRows()

Rows in arrow format. This is an experimental feature only selected for allowlisted customers.

.google.cloud.bigquery.storage.v1.AppendRowsRequest.ArrowData arrow_rows = 5;

Returns
Type Description
AppendRowsRequest.Builder

clearDefaultMissingValueInterpretation()

public AppendRowsRequest.Builder clearDefaultMissingValueInterpretation()

Optional. Default missing value interpretation for all columns in the table. When a value is specified on an AppendRowsRequest, it is applied to all requests on the connection from that point forward, until a subsequent AppendRowsRequest sets it to a different value. missing_value_interpretation can override default_missing_value_interpretation. For example, if you want to write NULL instead of using default values for some columns, you can set default_missing_value_interpretation to DEFAULT_VALUE and at the same time, set missing_value_interpretations to NULL_VALUE on those columns.

.google.cloud.bigquery.storage.v1.AppendRowsRequest.MissingValueInterpretation default_missing_value_interpretation = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
AppendRowsRequest.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public AppendRowsRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
AppendRowsRequest.Builder
Overrides

clearMissingValueInterpretations()

public AppendRowsRequest.Builder clearMissingValueInterpretations()
Returns
Type Description
AppendRowsRequest.Builder

clearOffset()

public AppendRowsRequest.Builder clearOffset()

If present, the write is only performed if the next append offset is same as the provided value. If not present, the write is performed at the current end of stream. Specifying a value for this field is not allowed when calling AppendRows for the '_default' stream.

.google.protobuf.Int64Value offset = 2;

Returns
Type Description
AppendRowsRequest.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public AppendRowsRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
AppendRowsRequest.Builder
Overrides

clearProtoRows()

public AppendRowsRequest.Builder clearProtoRows()

Rows in proto format.

.google.cloud.bigquery.storage.v1.AppendRowsRequest.ProtoData proto_rows = 4;

Returns
Type Description
AppendRowsRequest.Builder

clearRows()

public AppendRowsRequest.Builder clearRows()
Returns
Type Description
AppendRowsRequest.Builder

clearTraceId()

public AppendRowsRequest.Builder clearTraceId()

Id set by client to annotate its identity. Only initial request setting is respected.

string trace_id = 6;

Returns
Type Description
AppendRowsRequest.Builder

This builder for chaining.

clearWriteStream()

public AppendRowsRequest.Builder clearWriteStream()

Required. The write_stream identifies the append operation. It must be provided in the following scenarios:

  • In the first request to an AppendRows connection.

  • In all subsequent requests to an AppendRows connection, if you use the same connection to write to multiple tables or change the input schema for default streams.

    For explicitly created write streams, the format is:

  • projects/{project}/datasets/{dataset}/tables/{table}/streams/{id}

    For the special default stream, the format is:

  • projects/{project}/datasets/{dataset}/tables/{table}/streams/_default.

    An example of a possible sequence of requests with write_stream fields within a single connection:

  • r1: {write_stream: stream_name_1}

  • r2: {write_stream: /*omit*/}

  • r3: {write_stream: /*omit*/}

  • r4: {write_stream: stream_name_2}

  • r5: {write_stream: stream_name_2}

    The destination changed in request_4, so the write_stream field must be populated in all subsequent requests in this stream.

string write_stream = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
AppendRowsRequest.Builder

This builder for chaining.

clone()

public AppendRowsRequest.Builder clone()
Returns
Type Description
AppendRowsRequest.Builder
Overrides

containsMissingValueInterpretations(String key)

public boolean containsMissingValueInterpretations(String key)

A map to indicate how to interpret missing value for some fields. Missing values are fields present in user schema but missing in rows. The key is the field name. The value is the interpretation of missing values for the field.

For example, a map {'foo': NULL_VALUE, 'bar': DEFAULT_VALUE} means all missing values in field foo are interpreted as NULL, all missing values in field bar are interpreted as the default value of field bar in table schema.

If a field is not in this map and has missing values, the missing values in this field are interpreted as NULL.

This field only applies to the current request, it won't affect other requests on the connection.

Currently, field name can only be top-level column name, can't be a struct field path like 'foo.bar'.

map<string, .google.cloud.bigquery.storage.v1.AppendRowsRequest.MissingValueInterpretation> missing_value_interpretations = 7;

Parameter
Name Description
key String
Returns
Type Description
boolean

getArrowRows()

public AppendRowsRequest.ArrowData getArrowRows()

Rows in arrow format. This is an experimental feature only selected for allowlisted customers.

.google.cloud.bigquery.storage.v1.AppendRowsRequest.ArrowData arrow_rows = 5;

Returns
Type Description
AppendRowsRequest.ArrowData

The arrowRows.

getArrowRowsBuilder()

public AppendRowsRequest.ArrowData.Builder getArrowRowsBuilder()

Rows in arrow format. This is an experimental feature only selected for allowlisted customers.

.google.cloud.bigquery.storage.v1.AppendRowsRequest.ArrowData arrow_rows = 5;

Returns
Type Description
AppendRowsRequest.ArrowData.Builder

getArrowRowsOrBuilder()

public AppendRowsRequest.ArrowDataOrBuilder getArrowRowsOrBuilder()

Rows in arrow format. This is an experimental feature only selected for allowlisted customers.

.google.cloud.bigquery.storage.v1.AppendRowsRequest.ArrowData arrow_rows = 5;

Returns
Type Description
AppendRowsRequest.ArrowDataOrBuilder

getDefaultInstanceForType()

public AppendRowsRequest getDefaultInstanceForType()
Returns
Type Description
AppendRowsRequest

getDefaultMissingValueInterpretation()

public AppendRowsRequest.MissingValueInterpretation getDefaultMissingValueInterpretation()

Optional. Default missing value interpretation for all columns in the table. When a value is specified on an AppendRowsRequest, it is applied to all requests on the connection from that point forward, until a subsequent AppendRowsRequest sets it to a different value. missing_value_interpretation can override default_missing_value_interpretation. For example, if you want to write NULL instead of using default values for some columns, you can set default_missing_value_interpretation to DEFAULT_VALUE and at the same time, set missing_value_interpretations to NULL_VALUE on those columns.

.google.cloud.bigquery.storage.v1.AppendRowsRequest.MissingValueInterpretation default_missing_value_interpretation = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
AppendRowsRequest.MissingValueInterpretation

The defaultMissingValueInterpretation.

getDefaultMissingValueInterpretationValue()

public int getDefaultMissingValueInterpretationValue()

Optional. Default missing value interpretation for all columns in the table. When a value is specified on an AppendRowsRequest, it is applied to all requests on the connection from that point forward, until a subsequent AppendRowsRequest sets it to a different value. missing_value_interpretation can override default_missing_value_interpretation. For example, if you want to write NULL instead of using default values for some columns, you can set default_missing_value_interpretation to DEFAULT_VALUE and at the same time, set missing_value_interpretations to NULL_VALUE on those columns.

.google.cloud.bigquery.storage.v1.AppendRowsRequest.MissingValueInterpretation default_missing_value_interpretation = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for defaultMissingValueInterpretation.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getMissingValueInterpretations() (deprecated)

public Map<String,AppendRowsRequest.MissingValueInterpretation> getMissingValueInterpretations()

Use #getMissingValueInterpretationsMap() instead.

Returns
Type Description
Map<String,MissingValueInterpretation>

getMissingValueInterpretationsCount()

public int getMissingValueInterpretationsCount()

A map to indicate how to interpret missing value for some fields. Missing values are fields present in user schema but missing in rows. The key is the field name. The value is the interpretation of missing values for the field.

For example, a map {'foo': NULL_VALUE, 'bar': DEFAULT_VALUE} means all missing values in field foo are interpreted as NULL, all missing values in field bar are interpreted as the default value of field bar in table schema.

If a field is not in this map and has missing values, the missing values in this field are interpreted as NULL.

This field only applies to the current request, it won't affect other requests on the connection.

Currently, field name can only be top-level column name, can't be a struct field path like 'foo.bar'.

map<string, .google.cloud.bigquery.storage.v1.AppendRowsRequest.MissingValueInterpretation> missing_value_interpretations = 7;

Returns
Type Description
int

getMissingValueInterpretationsMap()

public Map<String,AppendRowsRequest.MissingValueInterpretation> getMissingValueInterpretationsMap()

A map to indicate how to interpret missing value for some fields. Missing values are fields present in user schema but missing in rows. The key is the field name. The value is the interpretation of missing values for the field.

For example, a map {'foo': NULL_VALUE, 'bar': DEFAULT_VALUE} means all missing values in field foo are interpreted as NULL, all missing values in field bar are interpreted as the default value of field bar in table schema.

If a field is not in this map and has missing values, the missing values in this field are interpreted as NULL.

This field only applies to the current request, it won't affect other requests on the connection.

Currently, field name can only be top-level column name, can't be a struct field path like 'foo.bar'.

map<string, .google.cloud.bigquery.storage.v1.AppendRowsRequest.MissingValueInterpretation> missing_value_interpretations = 7;

Returns
Type Description
Map<String,MissingValueInterpretation>

getMissingValueInterpretationsOrDefault(String key, AppendRowsRequest.MissingValueInterpretation defaultValue)

public AppendRowsRequest.MissingValueInterpretation getMissingValueInterpretationsOrDefault(String key, AppendRowsRequest.MissingValueInterpretation defaultValue)

A map to indicate how to interpret missing value for some fields. Missing values are fields present in user schema but missing in rows. The key is the field name. The value is the interpretation of missing values for the field.

For example, a map {'foo': NULL_VALUE, 'bar': DEFAULT_VALUE} means all missing values in field foo are interpreted as NULL, all missing values in field bar are interpreted as the default value of field bar in table schema.

If a field is not in this map and has missing values, the missing values in this field are interpreted as NULL.

This field only applies to the current request, it won't affect other requests on the connection.

Currently, field name can only be top-level column name, can't be a struct field path like 'foo.bar'.

map<string, .google.cloud.bigquery.storage.v1.AppendRowsRequest.MissingValueInterpretation> missing_value_interpretations = 7;

Parameters
Name Description
key String
defaultValue AppendRowsRequest.MissingValueInterpretation
Returns
Type Description
AppendRowsRequest.MissingValueInterpretation

getMissingValueInterpretationsOrThrow(String key)

public AppendRowsRequest.MissingValueInterpretation getMissingValueInterpretationsOrThrow(String key)

A map to indicate how to interpret missing value for some fields. Missing values are fields present in user schema but missing in rows. The key is the field name. The value is the interpretation of missing values for the field.

For example, a map {'foo': NULL_VALUE, 'bar': DEFAULT_VALUE} means all missing values in field foo are interpreted as NULL, all missing values in field bar are interpreted as the default value of field bar in table schema.

If a field is not in this map and has missing values, the missing values in this field are interpreted as NULL.

This field only applies to the current request, it won't affect other requests on the connection.

Currently, field name can only be top-level column name, can't be a struct field path like 'foo.bar'.

map<string, .google.cloud.bigquery.storage.v1.AppendRowsRequest.MissingValueInterpretation> missing_value_interpretations = 7;

Parameter
Name Description
key String
Returns
Type Description
AppendRowsRequest.MissingValueInterpretation

getMissingValueInterpretationsValue() (deprecated)

public Map<String,Integer> getMissingValueInterpretationsValue()

Use #getMissingValueInterpretationsValueMap() instead.

Returns
Type Description
Map<String,java.lang.Integer>

getMissingValueInterpretationsValueMap()

public Map<String,Integer> getMissingValueInterpretationsValueMap()

A map to indicate how to interpret missing value for some fields. Missing values are fields present in user schema but missing in rows. The key is the field name. The value is the interpretation of missing values for the field.

For example, a map {'foo': NULL_VALUE, 'bar': DEFAULT_VALUE} means all missing values in field foo are interpreted as NULL, all missing values in field bar are interpreted as the default value of field bar in table schema.

If a field is not in this map and has missing values, the missing values in this field are interpreted as NULL.

This field only applies to the current request, it won't affect other requests on the connection.

Currently, field name can only be top-level column name, can't be a struct field path like 'foo.bar'.

map<string, .google.cloud.bigquery.storage.v1.AppendRowsRequest.MissingValueInterpretation> missing_value_interpretations = 7;

Returns
Type Description
Map<String,java.lang.Integer>

getMissingValueInterpretationsValueOrDefault(String key, int defaultValue)

public int getMissingValueInterpretationsValueOrDefault(String key, int defaultValue)

A map to indicate how to interpret missing value for some fields. Missing values are fields present in user schema but missing in rows. The key is the field name. The value is the interpretation of missing values for the field.

For example, a map {'foo': NULL_VALUE, 'bar': DEFAULT_VALUE} means all missing values in field foo are interpreted as NULL, all missing values in field bar are interpreted as the default value of field bar in table schema.

If a field is not in this map and has missing values, the missing values in this field are interpreted as NULL.

This field only applies to the current request, it won't affect other requests on the connection.

Currently, field name can only be top-level column name, can't be a struct field path like 'foo.bar'.

map<string, .google.cloud.bigquery.storage.v1.AppendRowsRequest.MissingValueInterpretation> missing_value_interpretations = 7;

Parameters
Name Description
key String
defaultValue int
Returns
Type Description
int

getMissingValueInterpretationsValueOrThrow(String key)

public int getMissingValueInterpretationsValueOrThrow(String key)

A map to indicate how to interpret missing value for some fields. Missing values are fields present in user schema but missing in rows. The key is the field name. The value is the interpretation of missing values for the field.

For example, a map {'foo': NULL_VALUE, 'bar': DEFAULT_VALUE} means all missing values in field foo are interpreted as NULL, all missing values in field bar are interpreted as the default value of field bar in table schema.

If a field is not in this map and has missing values, the missing values in this field are interpreted as NULL.

This field only applies to the current request, it won't affect other requests on the connection.

Currently, field name can only be top-level column name, can't be a struct field path like 'foo.bar'.

map<string, .google.cloud.bigquery.storage.v1.AppendRowsRequest.MissingValueInterpretation> missing_value_interpretations = 7;

Parameter
Name Description
key String
Returns
Type Description
int

getMutableMissingValueInterpretations() (deprecated)

public Map<String,AppendRowsRequest.MissingValueInterpretation> getMutableMissingValueInterpretations()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,MissingValueInterpretation>

getMutableMissingValueInterpretationsValue() (deprecated)

public Map<String,Integer> getMutableMissingValueInterpretationsValue()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,java.lang.Integer>

getOffset()

public Int64Value getOffset()

If present, the write is only performed if the next append offset is same as the provided value. If not present, the write is performed at the current end of stream. Specifying a value for this field is not allowed when calling AppendRows for the '_default' stream.

.google.protobuf.Int64Value offset = 2;

Returns
Type Description
Int64Value

The offset.

getOffsetBuilder()

public Int64Value.Builder getOffsetBuilder()

If present, the write is only performed if the next append offset is same as the provided value. If not present, the write is performed at the current end of stream. Specifying a value for this field is not allowed when calling AppendRows for the '_default' stream.

.google.protobuf.Int64Value offset = 2;

Returns
Type Description
Builder

getOffsetOrBuilder()

public Int64ValueOrBuilder getOffsetOrBuilder()

If present, the write is only performed if the next append offset is same as the provided value. If not present, the write is performed at the current end of stream. Specifying a value for this field is not allowed when calling AppendRows for the '_default' stream.

.google.protobuf.Int64Value offset = 2;

Returns
Type Description
Int64ValueOrBuilder

getProtoRows()

public AppendRowsRequest.ProtoData getProtoRows()

Rows in proto format.

.google.cloud.bigquery.storage.v1.AppendRowsRequest.ProtoData proto_rows = 4;

Returns
Type Description
AppendRowsRequest.ProtoData

The protoRows.

getProtoRowsBuilder()

public AppendRowsRequest.ProtoData.Builder getProtoRowsBuilder()

Rows in proto format.

.google.cloud.bigquery.storage.v1.AppendRowsRequest.ProtoData proto_rows = 4;

Returns
Type Description
AppendRowsRequest.ProtoData.Builder

getProtoRowsOrBuilder()

public AppendRowsRequest.ProtoDataOrBuilder getProtoRowsOrBuilder()

Rows in proto format.

.google.cloud.bigquery.storage.v1.AppendRowsRequest.ProtoData proto_rows = 4;

Returns
Type Description
AppendRowsRequest.ProtoDataOrBuilder

getRowsCase()

public AppendRowsRequest.RowsCase getRowsCase()
Returns
Type Description
AppendRowsRequest.RowsCase

getTraceId()

public String getTraceId()

Id set by client to annotate its identity. Only initial request setting is respected.

string trace_id = 6;

Returns
Type Description
String

The traceId.

getTraceIdBytes()

public ByteString getTraceIdBytes()

Id set by client to annotate its identity. Only initial request setting is respected.

string trace_id = 6;

Returns
Type Description
ByteString

The bytes for traceId.

getWriteStream()

public String getWriteStream()

Required. The write_stream identifies the append operation. It must be provided in the following scenarios:

  • In the first request to an AppendRows connection.

  • In all subsequent requests to an AppendRows connection, if you use the same connection to write to multiple tables or change the input schema for default streams.

    For explicitly created write streams, the format is:

  • projects/{project}/datasets/{dataset}/tables/{table}/streams/{id}

    For the special default stream, the format is:

  • projects/{project}/datasets/{dataset}/tables/{table}/streams/_default.

    An example of a possible sequence of requests with write_stream fields within a single connection:

  • r1: {write_stream: stream_name_1}

  • r2: {write_stream: /*omit*/}

  • r3: {write_stream: /*omit*/}

  • r4: {write_stream: stream_name_2}

  • r5: {write_stream: stream_name_2}

    The destination changed in request_4, so the write_stream field must be populated in all subsequent requests in this stream.

string write_stream = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The writeStream.

getWriteStreamBytes()

public ByteString getWriteStreamBytes()

Required. The write_stream identifies the append operation. It must be provided in the following scenarios:

  • In the first request to an AppendRows connection.

  • In all subsequent requests to an AppendRows connection, if you use the same connection to write to multiple tables or change the input schema for default streams.

    For explicitly created write streams, the format is:

  • projects/{project}/datasets/{dataset}/tables/{table}/streams/{id}

    For the special default stream, the format is:

  • projects/{project}/datasets/{dataset}/tables/{table}/streams/_default.

    An example of a possible sequence of requests with write_stream fields within a single connection:

  • r1: {write_stream: stream_name_1}

  • r2: {write_stream: /*omit*/}

  • r3: {write_stream: /*omit*/}

  • r4: {write_stream: stream_name_2}

  • r5: {write_stream: stream_name_2}

    The destination changed in request_4, so the write_stream field must be populated in all subsequent requests in this stream.

string write_stream = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for writeStream.

hasArrowRows()

public boolean hasArrowRows()

Rows in arrow format. This is an experimental feature only selected for allowlisted customers.

.google.cloud.bigquery.storage.v1.AppendRowsRequest.ArrowData arrow_rows = 5;

Returns
Type Description
boolean

Whether the arrowRows field is set.

hasOffset()

public boolean hasOffset()

If present, the write is only performed if the next append offset is same as the provided value. If not present, the write is performed at the current end of stream. Specifying a value for this field is not allowed when calling AppendRows for the '_default' stream.

.google.protobuf.Int64Value offset = 2;

Returns
Type Description
boolean

Whether the offset field is set.

hasProtoRows()

public boolean hasProtoRows()

Rows in proto format.

.google.cloud.bigquery.storage.v1.AppendRowsRequest.ProtoData proto_rows = 4;

Returns
Type Description
boolean

Whether the protoRows field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeArrowRows(AppendRowsRequest.ArrowData value)

public AppendRowsRequest.Builder mergeArrowRows(AppendRowsRequest.ArrowData value)

Rows in arrow format. This is an experimental feature only selected for allowlisted customers.

.google.cloud.bigquery.storage.v1.AppendRowsRequest.ArrowData arrow_rows = 5;

Parameter
Name Description
value AppendRowsRequest.ArrowData
Returns
Type Description
AppendRowsRequest.Builder

mergeFrom(AppendRowsRequest other)

public AppendRowsRequest.Builder mergeFrom(AppendRowsRequest other)
Parameter
Name Description
other AppendRowsRequest
Returns
Type Description
AppendRowsRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public AppendRowsRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AppendRowsRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public AppendRowsRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
AppendRowsRequest.Builder
Overrides

mergeOffset(Int64Value value)

public AppendRowsRequest.Builder mergeOffset(Int64Value value)

If present, the write is only performed if the next append offset is same as the provided value. If not present, the write is performed at the current end of stream. Specifying a value for this field is not allowed when calling AppendRows for the '_default' stream.

.google.protobuf.Int64Value offset = 2;

Parameter
Name Description
value Int64Value
Returns
Type Description
AppendRowsRequest.Builder

mergeProtoRows(AppendRowsRequest.ProtoData value)

public AppendRowsRequest.Builder mergeProtoRows(AppendRowsRequest.ProtoData value)

Rows in proto format.

.google.cloud.bigquery.storage.v1.AppendRowsRequest.ProtoData proto_rows = 4;

Parameter
Name Description
value AppendRowsRequest.ProtoData
Returns
Type Description
AppendRowsRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final AppendRowsRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
AppendRowsRequest.Builder
Overrides

putAllMissingValueInterpretations(Map<String,AppendRowsRequest.MissingValueInterpretation> values)

public AppendRowsRequest.Builder putAllMissingValueInterpretations(Map<String,AppendRowsRequest.MissingValueInterpretation> values)

A map to indicate how to interpret missing value for some fields. Missing values are fields present in user schema but missing in rows. The key is the field name. The value is the interpretation of missing values for the field.

For example, a map {'foo': NULL_VALUE, 'bar': DEFAULT_VALUE} means all missing values in field foo are interpreted as NULL, all missing values in field bar are interpreted as the default value of field bar in table schema.

If a field is not in this map and has missing values, the missing values in this field are interpreted as NULL.

This field only applies to the current request, it won't affect other requests on the connection.

Currently, field name can only be top-level column name, can't be a struct field path like 'foo.bar'.

map<string, .google.cloud.bigquery.storage.v1.AppendRowsRequest.MissingValueInterpretation> missing_value_interpretations = 7;

Parameter
Name Description
values Map<String,MissingValueInterpretation>
Returns
Type Description
AppendRowsRequest.Builder

putAllMissingValueInterpretationsValue(Map<String,Integer> values)

public AppendRowsRequest.Builder putAllMissingValueInterpretationsValue(Map<String,Integer> values)

A map to indicate how to interpret missing value for some fields. Missing values are fields present in user schema but missing in rows. The key is the field name. The value is the interpretation of missing values for the field.

For example, a map {'foo': NULL_VALUE, 'bar': DEFAULT_VALUE} means all missing values in field foo are interpreted as NULL, all missing values in field bar are interpreted as the default value of field bar in table schema.

If a field is not in this map and has missing values, the missing values in this field are interpreted as NULL.

This field only applies to the current request, it won't affect other requests on the connection.

Currently, field name can only be top-level column name, can't be a struct field path like 'foo.bar'.

map<string, .google.cloud.bigquery.storage.v1.AppendRowsRequest.MissingValueInterpretation> missing_value_interpretations = 7;

Parameter
Name Description
values Map<String,java.lang.Integer>
Returns
Type Description
AppendRowsRequest.Builder

putMissingValueInterpretations(String key, AppendRowsRequest.MissingValueInterpretation value)

public AppendRowsRequest.Builder putMissingValueInterpretations(String key, AppendRowsRequest.MissingValueInterpretation value)

A map to indicate how to interpret missing value for some fields. Missing values are fields present in user schema but missing in rows. The key is the field name. The value is the interpretation of missing values for the field.

For example, a map {'foo': NULL_VALUE, 'bar': DEFAULT_VALUE} means all missing values in field foo are interpreted as NULL, all missing values in field bar are interpreted as the default value of field bar in table schema.

If a field is not in this map and has missing values, the missing values in this field are interpreted as NULL.

This field only applies to the current request, it won't affect other requests on the connection.

Currently, field name can only be top-level column name, can't be a struct field path like 'foo.bar'.

map<string, .google.cloud.bigquery.storage.v1.AppendRowsRequest.MissingValueInterpretation> missing_value_interpretations = 7;

Parameters
Name Description
key String
value AppendRowsRequest.MissingValueInterpretation
Returns
Type Description
AppendRowsRequest.Builder

putMissingValueInterpretationsValue(String key, int value)

public AppendRowsRequest.Builder putMissingValueInterpretationsValue(String key, int value)

A map to indicate how to interpret missing value for some fields. Missing values are fields present in user schema but missing in rows. The key is the field name. The value is the interpretation of missing values for the field.

For example, a map {'foo': NULL_VALUE, 'bar': DEFAULT_VALUE} means all missing values in field foo are interpreted as NULL, all missing values in field bar are interpreted as the default value of field bar in table schema.

If a field is not in this map and has missing values, the missing values in this field are interpreted as NULL.

This field only applies to the current request, it won't affect other requests on the connection.

Currently, field name can only be top-level column name, can't be a struct field path like 'foo.bar'.

map<string, .google.cloud.bigquery.storage.v1.AppendRowsRequest.MissingValueInterpretation> missing_value_interpretations = 7;

Parameters
Name Description
key String
value int
Returns
Type Description
AppendRowsRequest.Builder

removeMissingValueInterpretations(String key)

public AppendRowsRequest.Builder removeMissingValueInterpretations(String key)

A map to indicate how to interpret missing value for some fields. Missing values are fields present in user schema but missing in rows. The key is the field name. The value is the interpretation of missing values for the field.

For example, a map {'foo': NULL_VALUE, 'bar': DEFAULT_VALUE} means all missing values in field foo are interpreted as NULL, all missing values in field bar are interpreted as the default value of field bar in table schema.

If a field is not in this map and has missing values, the missing values in this field are interpreted as NULL.

This field only applies to the current request, it won't affect other requests on the connection.

Currently, field name can only be top-level column name, can't be a struct field path like 'foo.bar'.

map<string, .google.cloud.bigquery.storage.v1.AppendRowsRequest.MissingValueInterpretation> missing_value_interpretations = 7;

Parameter
Name Description
key String
Returns
Type Description
AppendRowsRequest.Builder

setArrowRows(AppendRowsRequest.ArrowData value)

public AppendRowsRequest.Builder setArrowRows(AppendRowsRequest.ArrowData value)

Rows in arrow format. This is an experimental feature only selected for allowlisted customers.

.google.cloud.bigquery.storage.v1.AppendRowsRequest.ArrowData arrow_rows = 5;

Parameter
Name Description
value AppendRowsRequest.ArrowData
Returns
Type Description
AppendRowsRequest.Builder

setArrowRows(AppendRowsRequest.ArrowData.Builder builderForValue)

public AppendRowsRequest.Builder setArrowRows(AppendRowsRequest.ArrowData.Builder builderForValue)

Rows in arrow format. This is an experimental feature only selected for allowlisted customers.

.google.cloud.bigquery.storage.v1.AppendRowsRequest.ArrowData arrow_rows = 5;

Parameter
Name Description
builderForValue AppendRowsRequest.ArrowData.Builder
Returns
Type Description
AppendRowsRequest.Builder

setDefaultMissingValueInterpretation(AppendRowsRequest.MissingValueInterpretation value)

public AppendRowsRequest.Builder setDefaultMissingValueInterpretation(AppendRowsRequest.MissingValueInterpretation value)

Optional. Default missing value interpretation for all columns in the table. When a value is specified on an AppendRowsRequest, it is applied to all requests on the connection from that point forward, until a subsequent AppendRowsRequest sets it to a different value. missing_value_interpretation can override default_missing_value_interpretation. For example, if you want to write NULL instead of using default values for some columns, you can set default_missing_value_interpretation to DEFAULT_VALUE and at the same time, set missing_value_interpretations to NULL_VALUE on those columns.

.google.cloud.bigquery.storage.v1.AppendRowsRequest.MissingValueInterpretation default_missing_value_interpretation = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value AppendRowsRequest.MissingValueInterpretation

The defaultMissingValueInterpretation to set.
Returns
Type Description
AppendRowsRequest.Builder

This builder for chaining.

setDefaultMissingValueInterpretationValue(int value)

public AppendRowsRequest.Builder setDefaultMissingValueInterpretationValue(int value)

Optional. Default missing value interpretation for all columns in the table. When a value is specified on an AppendRowsRequest, it is applied to all requests on the connection from that point forward, until a subsequent AppendRowsRequest sets it to a different value. missing_value_interpretation can override default_missing_value_interpretation. For example, if you want to write NULL instead of using default values for some columns, you can set default_missing_value_interpretation to DEFAULT_VALUE and at the same time, set missing_value_interpretations to NULL_VALUE on those columns.

.google.cloud.bigquery.storage.v1.AppendRowsRequest.MissingValueInterpretation default_missing_value_interpretation = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value int

The enum numeric value on the wire for defaultMissingValueInterpretation to set.
Returns
Type Description
AppendRowsRequest.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public AppendRowsRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
AppendRowsRequest.Builder
Overrides

setOffset(Int64Value value)

public AppendRowsRequest.Builder setOffset(Int64Value value)

If present, the write is only performed if the next append offset is same as the provided value. If not present, the write is performed at the current end of stream. Specifying a value for this field is not allowed when calling AppendRows for the '_default' stream.

.google.protobuf.Int64Value offset = 2;

Parameter
Name Description
value Int64Value
Returns
Type Description
AppendRowsRequest.Builder

setOffset(Int64Value.Builder builderForValue)

public AppendRowsRequest.Builder setOffset(Int64Value.Builder builderForValue)

If present, the write is only performed if the next append offset is same as the provided value. If not present, the write is performed at the current end of stream. Specifying a value for this field is not allowed when calling AppendRows for the '_default' stream.

.google.protobuf.Int64Value offset = 2;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
AppendRowsRequest.Builder

setProtoRows(AppendRowsRequest.ProtoData value)

public AppendRowsRequest.Builder setProtoRows(AppendRowsRequest.ProtoData value)

Rows in proto format.

.google.cloud.bigquery.storage.v1.AppendRowsRequest.ProtoData proto_rows = 4;

Parameter
Name Description
value AppendRowsRequest.ProtoData
Returns
Type Description
AppendRowsRequest.Builder

setProtoRows(AppendRowsRequest.ProtoData.Builder builderForValue)

public AppendRowsRequest.Builder setProtoRows(AppendRowsRequest.ProtoData.Builder builderForValue)

Rows in proto format.

.google.cloud.bigquery.storage.v1.AppendRowsRequest.ProtoData proto_rows = 4;

Parameter
Name Description
builderForValue AppendRowsRequest.ProtoData.Builder
Returns
Type Description
AppendRowsRequest.Builder

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

public AppendRowsRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
AppendRowsRequest.Builder
Overrides

setTraceId(String value)

public AppendRowsRequest.Builder setTraceId(String value)

Id set by client to annotate its identity. Only initial request setting is respected.

string trace_id = 6;

Parameter
Name Description
value String

The traceId to set.
Returns
Type Description
AppendRowsRequest.Builder

This builder for chaining.

setTraceIdBytes(ByteString value)

public AppendRowsRequest.Builder setTraceIdBytes(ByteString value)

Id set by client to annotate its identity. Only initial request setting is respected.

string trace_id = 6;

Parameter
Name Description
value ByteString

The bytes for traceId to set.
Returns
Type Description
AppendRowsRequest.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final AppendRowsRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
AppendRowsRequest.Builder
Overrides

setWriteStream(String value)

public AppendRowsRequest.Builder setWriteStream(String value)

Required. The write_stream identifies the append operation. It must be provided in the following scenarios:

  • In the first request to an AppendRows connection.

  • In all subsequent requests to an AppendRows connection, if you use the same connection to write to multiple tables or change the input schema for default streams.

    For explicitly created write streams, the format is:

  • projects/{project}/datasets/{dataset}/tables/{table}/streams/{id}

    For the special default stream, the format is:

  • projects/{project}/datasets/{dataset}/tables/{table}/streams/_default.

    An example of a possible sequence of requests with write_stream fields within a single connection:

  • r1: {write_stream: stream_name_1}

  • r2: {write_stream: /*omit*/}

  • r3: {write_stream: /*omit*/}

  • r4: {write_stream: stream_name_2}

  • r5: {write_stream: stream_name_2}

    The destination changed in request_4, so the write_stream field must be populated in all subsequent requests in this stream.

string write_stream = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The writeStream to set.
Returns
Type Description
AppendRowsRequest.Builder

This builder for chaining.

setWriteStreamBytes(ByteString value)

public AppendRowsRequest.Builder setWriteStreamBytes(ByteString value)

Required. The write_stream identifies the append operation. It must be provided in the following scenarios:

  • In the first request to an AppendRows connection.

  • In all subsequent requests to an AppendRows connection, if you use the same connection to write to multiple tables or change the input schema for default streams.

    For explicitly created write streams, the format is:

  • projects/{project}/datasets/{dataset}/tables/{table}/streams/{id}

    For the special default stream, the format is:

  • projects/{project}/datasets/{dataset}/tables/{table}/streams/_default.

    An example of a possible sequence of requests with write_stream fields within a single connection:

  • r1: {write_stream: stream_name_1}

  • r2: {write_stream: /*omit*/}

  • r3: {write_stream: /*omit*/}

  • r4: {write_stream: stream_name_2}

  • r5: {write_stream: stream_name_2}

    The destination changed in request_4, so the write_stream field must be populated in all subsequent requests in this stream.

string write_stream = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

The bytes for writeStream to set.
Returns
Type Description
AppendRowsRequest.Builder

This builder for chaining.