com.google.cloud.bigquery.storage.v1

Interface AppendRowsRequestOrBuilder

All Superinterfaces:

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

All Known Implementing Classes:

AppendRowsRequest, AppendRowsRequest.Builder

public interface AppendRowsRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
boolean	containsMissingValueInterpretations(String key) A map to indicate how to interpret missing value for some fields.
Map<String,AppendRowsRequest.MissingValueInterpretation>	getMissingValueInterpretations() Deprecated.
int	getMissingValueInterpretationsCount() A map to indicate how to interpret missing value for some fields.
Map<String,AppendRowsRequest.MissingValueInterpretation>	getMissingValueInterpretationsMap() A map to indicate how to interpret missing value for some fields.
AppendRowsRequest.MissingValueInterpretation	getMissingValueInterpretationsOrDefault(String key, AppendRowsRequest.MissingValueInterpretation defaultValue) A map to indicate how to interpret missing value for some fields.
AppendRowsRequest.MissingValueInterpretation	getMissingValueInterpretationsOrThrow(String key) A map to indicate how to interpret missing value for some fields.
Map<String,Integer>	getMissingValueInterpretationsValue() Deprecated.
Map<String,Integer>	getMissingValueInterpretationsValueMap() A map to indicate how to interpret missing value for some fields.
int	getMissingValueInterpretationsValueOrDefault(String key, int defaultValue) A map to indicate how to interpret missing value for some fields.
int	getMissingValueInterpretationsValueOrThrow(String key) A map to indicate how to interpret missing value for some fields.
com.google.protobuf.Int64Value	getOffset() If present, the write is only performed if the next append offset is same as the provided value.
com.google.protobuf.Int64ValueOrBuilder	getOffsetOrBuilder() If present, the write is only performed if the next append offset is same as the provided value.
AppendRowsRequest.ProtoData	getProtoRows() Rows in proto format.
AppendRowsRequest.ProtoDataOrBuilder	getProtoRowsOrBuilder() Rows in proto format.
AppendRowsRequest.RowsCase	getRowsCase()
String	getTraceId() Id set by client to annotate its identity.
com.google.protobuf.ByteString	getTraceIdBytes() Id set by client to annotate its identity.
String	getWriteStream() Required.
com.google.protobuf.ByteString	getWriteStreamBytes() Required.
boolean	hasOffset() If present, the write is only performed if the next append offset is same as the provided value.
boolean	hasProtoRows() Rows in proto format.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getWriteStream

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:

The writeStream.

getWriteStreamBytes

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

The bytes for writeStream.

hasOffset

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:

Whether the offset field is set.

getOffset

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

The offset.

getOffsetOrBuilder

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

hasProtoRows

boolean hasProtoRows()

 Rows in proto format.
 

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

Returns:

Whether the protoRows field is set.

getProtoRows

AppendRowsRequest.ProtoData getProtoRows()

 Rows in proto format.
 

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

Returns:

The protoRows.

getProtoRowsOrBuilder

AppendRowsRequest.ProtoDataOrBuilder getProtoRowsOrBuilder()

 Rows in proto format.
 

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

getTraceId

String getTraceId()

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

string trace_id = 6;

Returns:

The traceId.

getTraceIdBytes

com.google.protobuf.ByteString getTraceIdBytes()

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

string trace_id = 6;

Returns:

The bytes for traceId.

getMissingValueInterpretationsCount

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;

containsMissingValueInterpretations

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;

getMissingValueInterpretations

@Deprecated
Map<String,AppendRowsRequest.MissingValueInterpretation> getMissingValueInterpretations()

Deprecated.

Use getMissingValueInterpretationsMap() instead.

getMissingValueInterpretationsMap

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;

getMissingValueInterpretationsOrDefault

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;

getMissingValueInterpretationsOrThrow

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;

getMissingValueInterpretationsValue

@Deprecated
Map<String,Integer> getMissingValueInterpretationsValue()

Deprecated.

Use getMissingValueInterpretationsValueMap() instead.

getMissingValueInterpretationsValueMap

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;

getMissingValueInterpretationsValueOrDefault

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;

getMissingValueInterpretationsValueOrThrow

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;

getRowsCase

AppendRowsRequest.RowsCase getRowsCase()