Class AppendRowsRequest (2.13.0)

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

PROTO_ROWS_FIELD_NUMBER

public static final int PROTO_ROWS_FIELD_NUMBER
Field Value
TypeDescription
int

TRACE_ID_FIELD_NUMBER

public static final int TRACE_ID_FIELD_NUMBER
Field Value
TypeDescription
int

WRITE_STREAM_FIELD_NUMBER

public static final int WRITE_STREAM_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static AppendRowsRequest getDefaultInstance()
Returns
TypeDescription
AppendRowsRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static AppendRowsRequest.Builder newBuilder()
Returns
TypeDescription
AppendRowsRequest.Builder

newBuilder(AppendRowsRequest prototype)

public static AppendRowsRequest.Builder newBuilder(AppendRowsRequest prototype)
Parameter
NameDescription
prototypeAppendRowsRequest
Returns
TypeDescription
AppendRowsRequest.Builder

parseDelimitedFrom(InputStream input)

public static AppendRowsRequest parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
AppendRowsRequest
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AppendRowsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AppendRowsRequest
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static AppendRowsRequest parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
AppendRowsRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static AppendRowsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AppendRowsRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static AppendRowsRequest parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
AppendRowsRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static AppendRowsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AppendRowsRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static AppendRowsRequest parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
AppendRowsRequest
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static AppendRowsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AppendRowsRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static AppendRowsRequest parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
AppendRowsRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AppendRowsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AppendRowsRequest
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static AppendRowsRequest parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
AppendRowsRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static AppendRowsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AppendRowsRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<AppendRowsRequest> parser()
Returns
TypeDescription
Parser<AppendRowsRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public AppendRowsRequest getDefaultInstanceForType()
Returns
TypeDescription
AppendRowsRequest

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

The offset.

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

getParserForType()

public Parser<AppendRowsRequest> getParserForType()
Returns
TypeDescription
Parser<AppendRowsRequest>
Overrides

getProtoRows()

public 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 AppendRowsRequest.ProtoDataOrBuilder getProtoRowsOrBuilder()

Rows in proto format.

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

Returns
TypeDescription
AppendRowsRequest.ProtoDataOrBuilder

getRowsCase()

public AppendRowsRequest.RowsCase getRowsCase()
Returns
TypeDescription
AppendRowsRequest.RowsCase

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for traceId.

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
boolean

Whether the protoRows field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public AppendRowsRequest.Builder newBuilderForType()
Returns
TypeDescription
AppendRowsRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected AppendRowsRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
AppendRowsRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public AppendRowsRequest.Builder toBuilder()
Returns
TypeDescription
AppendRowsRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException