Interface AppendRowsResponseOrBuilder (3.9.2)

public interface AppendRowsResponseOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAppendResult()

public abstract 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 abstract AppendRowsResponse.AppendResultOrBuilder getAppendResultOrBuilder()

Result if the append is successful.

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

Returns
Type Description
AppendRowsResponse.AppendResultOrBuilder

getError()

public abstract 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 abstract 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

getResponseCase()

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

getRowErrors(int index)

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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>

getUpdatedSchema()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.