Reference documentation and code samples for the Google BigQuery Storage V1 Client class StorageError.
Structured custom BigQuery Storage error message. The error can be attached as error details in the returned rpc Status. In particular, the use of error codes allows more structured error handling, and reduces the need to evaluate unstructured error text strings.
Generated from protobuf message google.cloud.bigquery.storage.v1.StorageError
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ code |
int
BigQuery Storage specific error code. |
↳ entity |
string
Name of the failed entity. |
↳ error_message |
string
Message that describes the error. |
getCode
BigQuery Storage specific error code.
| Returns | |
|---|---|
| Type | Description |
int | |
setCode
BigQuery Storage specific error code.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getEntity
Name of the failed entity.
| Returns | |
|---|---|
| Type | Description |
string | |
setEntity
Name of the failed entity.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getErrorMessage
Message that describes the error.
| Returns | |
|---|---|
| Type | Description |
string | |
setErrorMessage
Message that describes the error.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |