Reference documentation and code samples for the BigQuery Storage V1 API class Google::Cloud::Bigquery::Storage::V1::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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-09 UTC."],[],[],null,["# BigQuery Storage V1 API - Class Google::Cloud::Bigquery::Storage::V1::StorageError (v1.4.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.4.0 (latest)](/ruby/docs/reference/google-cloud-bigquery-storage-v1/latest/Google-Cloud-Bigquery-Storage-V1-StorageError)\n- [1.3.1](/ruby/docs/reference/google-cloud-bigquery-storage-v1/1.3.1/Google-Cloud-Bigquery-Storage-V1-StorageError)\n- [1.2.0](/ruby/docs/reference/google-cloud-bigquery-storage-v1/1.2.0/Google-Cloud-Bigquery-Storage-V1-StorageError)\n- [1.1.0](/ruby/docs/reference/google-cloud-bigquery-storage-v1/1.1.0/Google-Cloud-Bigquery-Storage-V1-StorageError)\n- [1.0.1](/ruby/docs/reference/google-cloud-bigquery-storage-v1/1.0.1/Google-Cloud-Bigquery-Storage-V1-StorageError)\n- [0.27.0](/ruby/docs/reference/google-cloud-bigquery-storage-v1/0.27.0/Google-Cloud-Bigquery-Storage-V1-StorageError)\n- [0.26.0](/ruby/docs/reference/google-cloud-bigquery-storage-v1/0.26.0/Google-Cloud-Bigquery-Storage-V1-StorageError)\n- [0.25.2](/ruby/docs/reference/google-cloud-bigquery-storage-v1/0.25.2/Google-Cloud-Bigquery-Storage-V1-StorageError)\n- [0.24.0](/ruby/docs/reference/google-cloud-bigquery-storage-v1/0.24.0/Google-Cloud-Bigquery-Storage-V1-StorageError)\n- [0.23.0](/ruby/docs/reference/google-cloud-bigquery-storage-v1/0.23.0/Google-Cloud-Bigquery-Storage-V1-StorageError)\n- [0.22.0](/ruby/docs/reference/google-cloud-bigquery-storage-v1/0.22.0/Google-Cloud-Bigquery-Storage-V1-StorageError)\n- [0.21.0](/ruby/docs/reference/google-cloud-bigquery-storage-v1/0.21.0/Google-Cloud-Bigquery-Storage-V1-StorageError)\n- [0.20.0](/ruby/docs/reference/google-cloud-bigquery-storage-v1/0.20.0/Google-Cloud-Bigquery-Storage-V1-StorageError)\n- [0.19.1](/ruby/docs/reference/google-cloud-bigquery-storage-v1/0.19.1/Google-Cloud-Bigquery-Storage-V1-StorageError)\n- [0.18.0](/ruby/docs/reference/google-cloud-bigquery-storage-v1/0.18.0/Google-Cloud-Bigquery-Storage-V1-StorageError)\n- [0.17.0](/ruby/docs/reference/google-cloud-bigquery-storage-v1/0.17.0/Google-Cloud-Bigquery-Storage-V1-StorageError)\n- [0.16.0](/ruby/docs/reference/google-cloud-bigquery-storage-v1/0.16.0/Google-Cloud-Bigquery-Storage-V1-StorageError)\n- [0.15.1](/ruby/docs/reference/google-cloud-bigquery-storage-v1/0.15.1/Google-Cloud-Bigquery-Storage-V1-StorageError)\n- [0.14.0](/ruby/docs/reference/google-cloud-bigquery-storage-v1/0.14.0/Google-Cloud-Bigquery-Storage-V1-StorageError)\n- [0.13.0](/ruby/docs/reference/google-cloud-bigquery-storage-v1/0.13.0/Google-Cloud-Bigquery-Storage-V1-StorageError)\n- [0.12.0](/ruby/docs/reference/google-cloud-bigquery-storage-v1/0.12.0/Google-Cloud-Bigquery-Storage-V1-StorageError)\n- [0.11.1](/ruby/docs/reference/google-cloud-bigquery-storage-v1/0.11.1/Google-Cloud-Bigquery-Storage-V1-StorageError)\n- [0.10.1](/ruby/docs/reference/google-cloud-bigquery-storage-v1/0.10.1/Google-Cloud-Bigquery-Storage-V1-StorageError)\n- [0.9.2](/ruby/docs/reference/google-cloud-bigquery-storage-v1/0.9.2/Google-Cloud-Bigquery-Storage-V1-StorageError) \nReference documentation and code samples for the BigQuery Storage V1 API class Google::Cloud::Bigquery::Storage::V1::StorageError.\n\nStructured custom BigQuery Storage error message. The error can be attached\nas error details in the returned rpc Status. In particular, the use of error\ncodes allows more structured error handling, and reduces the need to evaluate\nunstructured error text strings. \n\nInherits\n--------\n\n- Object \n\nExtended By\n-----------\n\n- Google::Protobuf::MessageExts::ClassMethods \n\nIncludes\n--------\n\n- Google::Protobuf::MessageExts\n\nMethods\n-------\n\n### #code\n\n def code() -\u003e ::Google::Cloud::Bigquery::Storage::V1::StorageError::StorageErrorCode\n\n**Returns**\n\n- ([::Google::Cloud::Bigquery::Storage::V1::StorageError::StorageErrorCode](./Google-Cloud-Bigquery-Storage-V1-StorageError-StorageErrorCode)) --- BigQuery Storage specific error code.\n\n### #code=\n\n def code=(value) -\u003e ::Google::Cloud::Bigquery::Storage::V1::StorageError::StorageErrorCode\n\n**Parameter**\n\n- **value** ([::Google::Cloud::Bigquery::Storage::V1::StorageError::StorageErrorCode](./Google-Cloud-Bigquery-Storage-V1-StorageError-StorageErrorCode)) --- BigQuery Storage specific error code. \n**Returns**\n\n- ([::Google::Cloud::Bigquery::Storage::V1::StorageError::StorageErrorCode](./Google-Cloud-Bigquery-Storage-V1-StorageError-StorageErrorCode)) --- BigQuery Storage specific error code.\n\n### #entity\n\n def entity() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Name of the failed entity.\n\n### #entity=\n\n def entity=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Name of the failed entity. \n**Returns**\n\n- (::String) --- Name of the failed entity.\n\n### #error_message\n\n def error_message() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Message that describes the error.\n\n### #error_message=\n\n def error_message=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Message that describes the error. \n**Returns**\n\n- (::String) --- Message that describes the error."]]