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.
Protobuf type google.cloud.bigquery.storage.v1.AppendRowsRequest
Static Fields
OFFSET_FIELD_NUMBER
public static final int OFFSET_FIELD_NUMBER
Field Value
PROTO_ROWS_FIELD_NUMBER
public static final int PROTO_ROWS_FIELD_NUMBER
Field Value
TRACE_ID_FIELD_NUMBER
public static final int TRACE_ID_FIELD_NUMBER
Field Value
WRITE_STREAM_FIELD_NUMBER
public static final int WRITE_STREAM_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static AppendRowsRequest getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static AppendRowsRequest.Builder newBuilder()
Returns
newBuilder(AppendRowsRequest prototype)
public static AppendRowsRequest.Builder newBuilder(AppendRowsRequest prototype)
Parameter
Returns
public static AppendRowsRequest parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static AppendRowsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static AppendRowsRequest parseFrom(byte[] data)
Parameter
Name | Description |
data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static AppendRowsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static AppendRowsRequest parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static AppendRowsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static AppendRowsRequest parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static AppendRowsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static AppendRowsRequest parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static AppendRowsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static AppendRowsRequest parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static AppendRowsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<AppendRowsRequest> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getDefaultInstanceForType()
public AppendRowsRequest getDefaultInstanceForType()
Returns
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
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
getParserForType()
public Parser<AppendRowsRequest> getParserForType()
Returns
Overrides
getProtoRows()
public AppendRowsRequest.ProtoData getProtoRows()
Rows in proto format.
.google.cloud.bigquery.storage.v1.AppendRowsRequest.ProtoData proto_rows = 4;
Returns
getProtoRowsOrBuilder()
public AppendRowsRequest.ProtoDataOrBuilder getProtoRowsOrBuilder()
Rows in proto format.
.google.cloud.bigquery.storage.v1.AppendRowsRequest.ProtoData proto_rows = 4;
Returns
getRowsCase()
public AppendRowsRequest.RowsCase getRowsCase()
Returns
getSerializedSize()
public int getSerializedSize()
Returns
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
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
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
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public AppendRowsRequest.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected AppendRowsRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public AppendRowsRequest.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions