Interface AppendRowsRequestOrBuilder (3.10.2) 

public interface AppendRowsRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsMissingValueInterpretations(String key)

public abstract 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 abstract 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.

getArrowRowsOrBuilder()

public abstract 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

getDefaultMissingValueInterpretation()

public abstract 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 abstract 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.

getMissingValueInterpretations() (deprecated)

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

Use #getMissingValueInterpretationsMap() instead.

Returns
Type Description
Map<String,MissingValueInterpretation>

getMissingValueInterpretationsCount()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract Map<String,Integer> getMissingValueInterpretationsValue()

Use #getMissingValueInterpretationsValueMap() instead.

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

getMissingValueInterpretationsValueMap()

public abstract 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 abstract 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 abstract 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

getOffset()

public abstract 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.

getOffsetOrBuilder()

public abstract 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 abstract AppendRowsRequest.ProtoData getProtoRows()

Rows in proto format.

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

Returns
Type Description
AppendRowsRequest.ProtoData

The protoRows.

getProtoRowsOrBuilder()

public abstract AppendRowsRequest.ProtoDataOrBuilder getProtoRowsOrBuilder()

Rows in proto format.

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

Returns
Type Description
AppendRowsRequest.ProtoDataOrBuilder

getRowsCase()

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

getTraceId()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.