public final class AppendRowsRequest extends GeneratedMessageV3 implements AppendRowsRequestOrBuilder
Request message for AppendRows.
Due to the nature of AppendRows being a bidirectional streaming RPC, certain
parts of the AppendRowsRequest need only be specified for the first request
sent each time the gRPC network connection is opened/reopened.
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
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
Static Fields
MISSING_VALUE_INTERPRETATIONS_FIELD_NUMBER
public static final int MISSING_VALUE_INTERPRETATIONS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
OFFSET_FIELD_NUMBER
public static final int OFFSET_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
PROTO_ROWS_FIELD_NUMBER
public static final int PROTO_ROWS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
TRACE_ID_FIELD_NUMBER
public static final int TRACE_ID_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
WRITE_STREAM_FIELD_NUMBER
public static final int WRITE_STREAM_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
getDefaultInstance()
public static AppendRowsRequest getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static AppendRowsRequest.Builder newBuilder()
newBuilder(AppendRowsRequest prototype)
public static AppendRowsRequest.Builder newBuilder(AppendRowsRequest prototype)
public static AppendRowsRequest parseDelimitedFrom(InputStream input)
public static AppendRowsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static AppendRowsRequest parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static AppendRowsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static AppendRowsRequest parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static AppendRowsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static AppendRowsRequest parseFrom(CodedInputStream input)
public static AppendRowsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static AppendRowsRequest parseFrom(InputStream input)
public static AppendRowsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static AppendRowsRequest parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static AppendRowsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<AppendRowsRequest> parser()
Methods
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
|
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
Overrides
getDefaultInstanceForType()
public AppendRowsRequest getDefaultInstanceForType()
getMissingValueInterpretations()
public Map<String,AppendRowsRequest.MissingValueInterpretation> getMissingValueInterpretations()
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;
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;
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
|
getMissingValueInterpretationsValue()
public Map<String,Integer> getMissingValueInterpretationsValue()
| 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 | |
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;
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;
getParserForType()
public Parser<AppendRowsRequest> getParserForType()
Overrides
getProtoRows()
public AppendRowsRequest.ProtoData getProtoRows()
Rows in proto format.
.google.cloud.bigquery.storage.v1.AppendRowsRequest.ProtoData proto_rows = 4;
getProtoRowsOrBuilder()
public AppendRowsRequest.ProtoDataOrBuilder getProtoRowsOrBuilder()
Rows in proto format.
.google.cloud.bigquery.storage.v1.AppendRowsRequest.ProtoData proto_rows = 4;
getRowsCase()
public AppendRowsRequest.RowsCase getRowsCase()
getSerializedSize()
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
Overrides
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 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 |
|---|
| Type | Description |
String | The writeStream.
|
getWriteStreamBytes()
public 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 |
|---|
| Type | Description |
ByteString | The bytes for writeStream.
|
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.
|
hashCode()
| Returns |
|---|
| Type | Description |
int | |
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
| Parameter |
|---|
| Name | Description |
number | int
|
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public AppendRowsRequest.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected AppendRowsRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
toBuilder()
public AppendRowsRequest.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
