Class AppendRowsResponse (3.5.1)

public final class AppendRowsResponse extends GeneratedMessageV3 implements AppendRowsResponseOrBuilder

Response message for AppendRows.

Protobuf type google.cloud.bigquery.storage.v1.AppendRowsResponse

Static Fields

APPEND_RESULT_FIELD_NUMBER

public static final int APPEND_RESULT_FIELD_NUMBER
Field Value
Type Description
int

ERROR_FIELD_NUMBER

public static final int ERROR_FIELD_NUMBER
Field Value
Type Description
int

ROW_ERRORS_FIELD_NUMBER

public static final int ROW_ERRORS_FIELD_NUMBER
Field Value
Type Description
int

UPDATED_SCHEMA_FIELD_NUMBER

public static final int UPDATED_SCHEMA_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 AppendRowsResponse getDefaultInstance()
Returns
Type Description
AppendRowsResponse

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static AppendRowsResponse.Builder newBuilder()
Returns
Type Description
AppendRowsResponse.Builder

newBuilder(AppendRowsResponse prototype)

public static AppendRowsResponse.Builder newBuilder(AppendRowsResponse prototype)
Parameter
Name Description
prototype AppendRowsResponse
Returns
Type Description
AppendRowsResponse.Builder

parseDelimitedFrom(InputStream input)

public static AppendRowsResponse parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
AppendRowsResponse
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AppendRowsResponse parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AppendRowsResponse
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static AppendRowsResponse parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
AppendRowsResponse
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static AppendRowsResponse parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AppendRowsResponse
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static AppendRowsResponse parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
AppendRowsResponse
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static AppendRowsResponse parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AppendRowsResponse
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static AppendRowsResponse parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
AppendRowsResponse
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static AppendRowsResponse parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AppendRowsResponse
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static AppendRowsResponse parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
AppendRowsResponse
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AppendRowsResponse parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AppendRowsResponse
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static AppendRowsResponse parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
AppendRowsResponse
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static AppendRowsResponse parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AppendRowsResponse
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<AppendRowsResponse> parser()
Returns
Type Description
Parser<AppendRowsResponse>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getAppendResult()

public AppendRowsResponse.AppendResult getAppendResult()

Result if the append is successful.

.google.cloud.bigquery.storage.v1.AppendRowsResponse.AppendResult append_result = 1;

Returns
Type Description
AppendRowsResponse.AppendResult

The appendResult.

getAppendResultOrBuilder()

public AppendRowsResponse.AppendResultOrBuilder getAppendResultOrBuilder()

Result if the append is successful.

.google.cloud.bigquery.storage.v1.AppendRowsResponse.AppendResult append_result = 1;

Returns
Type Description
AppendRowsResponse.AppendResultOrBuilder

getDefaultInstanceForType()

public AppendRowsResponse getDefaultInstanceForType()
Returns
Type Description
AppendRowsResponse

getError()

public Status getError()

Error returned when problems were encountered. If present, it indicates rows were not accepted into the system. Users can retry or continue with other append requests within the same connection.

Additional information about error signalling:

ALREADY_EXISTS: Happens when an append specified an offset, and the backend already has received data at this offset. Typically encountered in retry scenarios, and can be ignored.

OUT_OF_RANGE: Returned when the specified offset in the stream is beyond the current end of the stream.

INVALID_ARGUMENT: Indicates a malformed request or data.

ABORTED: Request processing is aborted because of prior failures. The request can be retried if previous failure is addressed.

INTERNAL: Indicates server side error(s) that can be retried.

.google.rpc.Status error = 2;

Returns
Type Description
com.google.rpc.Status

The error.

getErrorOrBuilder()

public StatusOrBuilder getErrorOrBuilder()

Error returned when problems were encountered. If present, it indicates rows were not accepted into the system. Users can retry or continue with other append requests within the same connection.

Additional information about error signalling:

ALREADY_EXISTS: Happens when an append specified an offset, and the backend already has received data at this offset. Typically encountered in retry scenarios, and can be ignored.

OUT_OF_RANGE: Returned when the specified offset in the stream is beyond the current end of the stream.

INVALID_ARGUMENT: Indicates a malformed request or data.

ABORTED: Request processing is aborted because of prior failures. The request can be retried if previous failure is addressed.

INTERNAL: Indicates server side error(s) that can be retried.

.google.rpc.Status error = 2;

Returns
Type Description
com.google.rpc.StatusOrBuilder

getParserForType()

public Parser<AppendRowsResponse> getParserForType()
Returns
Type Description
Parser<AppendRowsResponse>
Overrides

getResponseCase()

public AppendRowsResponse.ResponseCase getResponseCase()
Returns
Type Description
AppendRowsResponse.ResponseCase

getRowErrors(int index)

public RowError getRowErrors(int index)

If a request failed due to corrupted rows, no rows in the batch will be appended. The API will return row level error info, so that the caller can remove the bad rows and retry the request.

repeated .google.cloud.bigquery.storage.v1.RowError row_errors = 4;

Parameter
Name Description
index int
Returns
Type Description
RowError

getRowErrorsCount()

public int getRowErrorsCount()

If a request failed due to corrupted rows, no rows in the batch will be appended. The API will return row level error info, so that the caller can remove the bad rows and retry the request.

repeated .google.cloud.bigquery.storage.v1.RowError row_errors = 4;

Returns
Type Description
int

getRowErrorsList()

public List<RowError> getRowErrorsList()

If a request failed due to corrupted rows, no rows in the batch will be appended. The API will return row level error info, so that the caller can remove the bad rows and retry the request.

repeated .google.cloud.bigquery.storage.v1.RowError row_errors = 4;

Returns
Type Description
List<RowError>

getRowErrorsOrBuilder(int index)

public RowErrorOrBuilder getRowErrorsOrBuilder(int index)

If a request failed due to corrupted rows, no rows in the batch will be appended. The API will return row level error info, so that the caller can remove the bad rows and retry the request.

repeated .google.cloud.bigquery.storage.v1.RowError row_errors = 4;

Parameter
Name Description
index int
Returns
Type Description
RowErrorOrBuilder

getRowErrorsOrBuilderList()

public List<? extends RowErrorOrBuilder> getRowErrorsOrBuilderList()

If a request failed due to corrupted rows, no rows in the batch will be appended. The API will return row level error info, so that the caller can remove the bad rows and retry the request.

repeated .google.cloud.bigquery.storage.v1.RowError row_errors = 4;

Returns
Type Description
List<? extends com.google.cloud.bigquery.storage.v1.RowErrorOrBuilder>

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getUpdatedSchema()

public TableSchema getUpdatedSchema()

If backend detects a schema update, pass it to user so that user can use it to input new type of message. It will be empty when no schema updates have occurred.

.google.cloud.bigquery.storage.v1.TableSchema updated_schema = 3;

Returns
Type Description
TableSchema

The updatedSchema.

getUpdatedSchemaOrBuilder()

public TableSchemaOrBuilder getUpdatedSchemaOrBuilder()

If backend detects a schema update, pass it to user so that user can use it to input new type of message. It will be empty when no schema updates have occurred.

.google.cloud.bigquery.storage.v1.TableSchema updated_schema = 3;

Returns
Type Description
TableSchemaOrBuilder

getWriteStream()

public String getWriteStream()

The target of the append operation. Matches the write_stream in the corresponding request.

string write_stream = 5;

Returns
Type Description
String

The writeStream.

getWriteStreamBytes()

public ByteString getWriteStreamBytes()

The target of the append operation. Matches the write_stream in the corresponding request.

string write_stream = 5;

Returns
Type Description
ByteString

The bytes for writeStream.

hasAppendResult()

public boolean hasAppendResult()

Result if the append is successful.

.google.cloud.bigquery.storage.v1.AppendRowsResponse.AppendResult append_result = 1;

Returns
Type Description
boolean

Whether the appendResult field is set.

hasError()

public boolean hasError()

Error returned when problems were encountered. If present, it indicates rows were not accepted into the system. Users can retry or continue with other append requests within the same connection.

Additional information about error signalling:

ALREADY_EXISTS: Happens when an append specified an offset, and the backend already has received data at this offset. Typically encountered in retry scenarios, and can be ignored.

OUT_OF_RANGE: Returned when the specified offset in the stream is beyond the current end of the stream.

INVALID_ARGUMENT: Indicates a malformed request or data.

ABORTED: Request processing is aborted because of prior failures. The request can be retried if previous failure is addressed.

INTERNAL: Indicates server side error(s) that can be retried.

.google.rpc.Status error = 2;

Returns
Type Description
boolean

Whether the error field is set.

hasUpdatedSchema()

public boolean hasUpdatedSchema()

If backend detects a schema update, pass it to user so that user can use it to input new type of message. It will be empty when no schema updates have occurred.

.google.cloud.bigquery.storage.v1.TableSchema updated_schema = 3;

Returns
Type Description
boolean

Whether the updatedSchema field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public AppendRowsResponse.Builder newBuilderForType()
Returns
Type Description
AppendRowsResponse.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected AppendRowsResponse.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
AppendRowsResponse.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public AppendRowsResponse.Builder toBuilder()
Returns
Type Description
AppendRowsResponse.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException