BigQuery Storage V1 API - Class Google::Cloud::Bigquery::Storage::V1::AppendRowsResponse (v1.2.0)

Reference documentation and code samples for the BigQuery Storage V1 API class Google::Cloud::Bigquery::Storage::V1::AppendRowsResponse.

Response message for AppendRows.

Inherits

Object

Extended By

Google::Protobuf::MessageExts::ClassMethods

Includes

Google::Protobuf::MessageExts

Methods

#append_result

def append_result() -> ::Google::Cloud::Bigquery::Storage::V1::AppendRowsResponse::AppendResult

Returns

(::Google::Cloud::Bigquery::Storage::V1::AppendRowsResponse::AppendResult) — Result if the append is successful.

#append_result=

def append_result=(value) -> ::Google::Cloud::Bigquery::Storage::V1::AppendRowsResponse::AppendResult

Parameter

value (::Google::Cloud::Bigquery::Storage::V1::AppendRowsResponse::AppendResult) — Result if the append is successful.

Returns

(::Google::Cloud::Bigquery::Storage::V1::AppendRowsResponse::AppendResult) — Result if the append is successful.

#error

def error() -> ::Google::Rpc::Status

Returns

(::Google::Rpc::Status) — 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.

#error=

def error=(value) -> ::Google::Rpc::Status

Parameter

value (::Google::Rpc::Status) — 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.

Returns

(::Google::Rpc::Status) — 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.

#row_errors

def row_errors() -> ::Array<::Google::Cloud::Bigquery::Storage::V1::RowError>

Returns

(::Array<::Google::Cloud::Bigquery::Storage::V1::RowError>) — 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.

#row_errors=

def row_errors=(value) -> ::Array<::Google::Cloud::Bigquery::Storage::V1::RowError>

Parameter

value (::Array<::Google::Cloud::Bigquery::Storage::V1::RowError>) — 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.

Returns

(::Array<::Google::Cloud::Bigquery::Storage::V1::RowError>) — 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.

#updated_schema

def updated_schema() -> ::Google::Cloud::Bigquery::Storage::V1::TableSchema

Returns

(::Google::Cloud::Bigquery::Storage::V1::TableSchema) — 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.

#updated_schema=

def updated_schema=(value) -> ::Google::Cloud::Bigquery::Storage::V1::TableSchema

Parameter

value (::Google::Cloud::Bigquery::Storage::V1::TableSchema) — 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.

Returns

(::Google::Cloud::Bigquery::Storage::V1::TableSchema) — 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.

#write_stream

def write_stream() -> ::String

Returns

(::String) — The target of the append operation. Matches the write_stream in the corresponding request.

#write_stream=

def write_stream=(value) -> ::String

Parameter

value (::String) — The target of the append operation. Matches the write_stream in the corresponding request.

Returns

(::String) — The target of the append operation. Matches the write_stream in the corresponding request.