2.6.0 (latest) 2.5.4 2.3.1 2.2.1 2.1.5 2.0.0 1.10.4 1.9.0 1.8.0 1.7.1 1.6.0 1.5.0 1.4.1 1.3.2 1.2.12 Reference documentation and code samples for the Google BigQuery Storage V1 Client class AppendRowsResponse.

Response message for `AppendRows`.

Generated from protobuf message `google.cloud.bigquery.storage.v1.AppendRowsResponse`

## Namespace

Google \\ Cloud \\ BigQuery \\ Storage \\ V1

## Methods

### __construct

Constructor.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `data` | `array` Optional. Data for populating the Message object. |
| `↳ append_result` | `https://docs.cloud.google.com/php/docs/reference/cloud-bigquery-storage/latest/V1.AppendRowsResponse.AppendResult` Result if the append is successful. |
| `↳ error` | `https://docs.cloud.google.com/php/docs/reference/common-protos/latest/Rpc.Status.html` 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. |
| `↳ updated_schema` | `https://docs.cloud.google.com/php/docs/reference/cloud-bigquery-storage/latest/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. |
| `↳ row_errors` | `array<https://docs.cloud.google.com/php/docs/reference/cloud-bigquery-storage/latest/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. |
| `↳ write_stream` | `string` The target of the append operation. Matches the write_stream in the corresponding request. |

### getAppendResult

Result if the append is successful.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-bigquery-storage/latest/V1.AppendRowsResponse.AppendResult|null` |   |

### hasAppendResult

### setAppendResult

Result if the append is successful.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://docs.cloud.google.com/php/docs/reference/cloud-bigquery-storage/latest/V1.AppendRowsResponse.AppendResult` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### 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.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/common-protos/latest/Rpc.Status.html|null` |   |

### hasError

### setError

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.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://docs.cloud.google.com/php/docs/reference/common-protos/latest/Rpc.Status.html` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### 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.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-bigquery-storage/latest/V1.TableSchema|null` |   |

### hasUpdatedSchema

### clearUpdatedSchema

### setUpdatedSchema

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.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://docs.cloud.google.com/php/docs/reference/cloud-bigquery-storage/latest/V1.TableSchema` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getRowErrors

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** ||
|---|---|
| **Type** | **Description** |
| `Google\Protobuf\RepeatedField<https://docs.cloud.google.com/php/docs/reference/cloud-bigquery-storage/latest/V1.RowError>` |   |

### setRowErrors

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.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `array<https://docs.cloud.google.com/php/docs/reference/cloud-bigquery-storage/latest/V1.RowError>` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getWriteStream

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

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### setWriteStream

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

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getResponse

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |