Google BigQuery Storage V1 Client - Class StorageError (1.4.1)

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

Namespace

Google \ Cloud \ BigQuery \ Storage \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
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
TypeDescription
int

setCode

BigQuery Storage specific error code.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getEntity

Name of the failed entity.

Returns
TypeDescription
string

setEntity

Name of the failed entity.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getErrorMessage

Message that describes the error.

Returns
TypeDescription
string

setErrorMessage

Message that describes the error.

Parameter
NameDescription
var string
Returns
TypeDescription
$this