Interface AppendRowsRequestOrBuilder (2.28.4)

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
NameDescription
keyString
Returns
TypeDescription
boolean

getMissingValueInterpretations()

public abstract Map<String,AppendRowsRequest.MissingValueInterpretation> getMissingValueInterpretations()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
keyString
defaultValueAppendRowsRequest.MissingValueInterpretation
Returns
TypeDescription
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
NameDescription
keyString
Returns
TypeDescription
AppendRowsRequest.MissingValueInterpretation

getMissingValueInterpretationsValue()

public abstract Map<String,Integer> getMissingValueInterpretationsValue()
Returns
TypeDescription
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
TypeDescription
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
NameDescription
keyString
defaultValueint
Returns
TypeDescription
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
NameDescription
keyString
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
Int64ValueOrBuilder

getProtoRows()

public abstract AppendRowsRequest.ProtoData getProtoRows()

Rows in proto format.

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

Returns
TypeDescription
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
TypeDescription
AppendRowsRequest.ProtoDataOrBuilder

getRowsCase()

public abstract AppendRowsRequest.RowsCase getRowsCase()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for traceId.

getWriteStream()

public abstract String getWriteStream()

Required. The write_stream identifies the target of the append operation, and only needs to be specified as part of the first request on the gRPC connection. If provided for subsequent requests, it must match the value of the first request. 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.

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

Returns
TypeDescription
String

The writeStream.

getWriteStreamBytes()

public abstract ByteString getWriteStreamBytes()

Required. The write_stream identifies the target of the append operation, and only needs to be specified as part of the first request on the gRPC connection. If provided for subsequent requests, it must match the value of the first request. 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.

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

Returns
TypeDescription
ByteString

The bytes for writeStream.

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

Whether the protoRows field is set.