By default, this returns an instance of
Google::Cloud::Bigquery::Storage::V1::BigQueryRead::Client
for a gRPC client for version V1 of the API.
However, you can specify a different API version by passing it in the
version parameter. If the BigQueryRead service is
supported by that API version, and the corresponding gem is available, the
appropriate versioned client will be returned.
Raises an exception if the currently installed versioned client gem for the
given API version does not support the BigQueryRead service.
You can determine whether the method will succeed by calling
Storage.big_query_read_available?.
About BigQueryRead
BigQuery Read API.
The Read API can be used to read data from BigQuery.
Parameter
version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional.
Defaults to :v1.
Returns
(::Object) — A client object for the specified version.
Determines whether the BigQueryRead service is supported by the current client.
If true, you can retrieve a client object by calling Storage.big_query_read.
If false, that method will raise an exception. This could happen if the given
API version does not exist or does not support the BigQueryRead service,
or if the versioned client gem needs an update to support the BigQueryRead service.
Parameter
version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional.
Defaults to :v1.
By default, this returns an instance of
Google::Cloud::Bigquery::Storage::V1::BigQueryWrite::Client
for a gRPC client for version V1 of the API.
However, you can specify a different API version by passing it in the
version parameter. If the BigQueryWrite service is
supported by that API version, and the corresponding gem is available, the
appropriate versioned client will be returned.
Raises an exception if the currently installed versioned client gem for the
given API version does not support the BigQueryWrite service.
You can determine whether the method will succeed by calling
Storage.big_query_write_available?.
About BigQueryWrite
BigQuery Write API.
The Write API can be used to write data to BigQuery.
Determines whether the BigQueryWrite service is supported by the current client.
If true, you can retrieve a client object by calling Storage.big_query_write.
If false, that method will raise an exception. This could happen if the given
API version does not exist or does not support the BigQueryWrite service,
or if the versioned client gem needs an update to support the BigQueryWrite service.
Parameter
version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional.
Defaults to :v1.
Returns
(boolean) — Whether the service is available.
.configure
defself.configure()->::Google::Cloud::Config
Configure the google-cloud-bigquery-storage library.
The following configuration parameters are supported:
credentials (type:String, Hash, Google::Auth::Credentials) -
The path to the keyfile as a String, the contents of the keyfile as a
Hash, or a Google::Auth::Credentials object.
lib_name (type:String) -
The library name as recorded in instrumentation and logging.
lib_version (type:String) -
The library version as recorded in instrumentation and logging.
interceptors (type:Array<GRPC::ClientInterceptor>) -
An array of interceptors that are run before calls are executed.
timeout (type:Numeric) -
Default timeout in seconds.
metadata (type:Hash{Symbol=>String}) -
Additional headers to be sent with the call.
retry_policy (type:Hash) -
The retry policy. The value is a hash with the following keys:
:initial_delay (type:Numeric) - The initial delay in seconds.
:max_delay (type:Numeric) - The max delay in seconds.
:multiplier (type:Numeric) - The incremental backoff multiplier.
:retry_codes (type:Array<String>) -
The error codes that should trigger a retry.
Yields
(::Google::Cloud.configure.bigquery_storage)
Returns
(::Google::Cloud::Config) — The default configuration used by this library
[[["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 API - Module Google::Cloud::Bigquery::Storage (v1.6.1)\n\nVersion latestkeyboard_arrow_down\n\n- [1.6.1 (latest)](/ruby/docs/reference/google-cloud-bigquery-storage/latest/Google-Cloud-Bigquery-Storage)\n- [1.6.0](/ruby/docs/reference/google-cloud-bigquery-storage/1.6.0/Google-Cloud-Bigquery-Storage)\n- [1.5.1](/ruby/docs/reference/google-cloud-bigquery-storage/1.5.1/Google-Cloud-Bigquery-Storage)\n- [1.4.0](/ruby/docs/reference/google-cloud-bigquery-storage/1.4.0/Google-Cloud-Bigquery-Storage)\n- [1.3.0](/ruby/docs/reference/google-cloud-bigquery-storage/1.3.0/Google-Cloud-Bigquery-Storage)\n- [1.2.1](/ruby/docs/reference/google-cloud-bigquery-storage/1.2.1/Google-Cloud-Bigquery-Storage) \nReference documentation and code samples for the BigQuery Storage API module Google::Cloud::Bigquery::Storage.\n\nMethods\n-------\n\n### .big_query_read\n\n def self.big_query_read(version: :v1, &block) -\u003e ::Object\n\nCreate a new client object for BigQueryRead.\n\n\nBy default, this returns an instance of\n[Google::Cloud::Bigquery::Storage::V1::BigQueryRead::Client](https://cloud.google.com/ruby/docs/reference/google-cloud-bigquery-storage-v1/latest/Google-Cloud-Bigquery-Storage-V1-BigQueryRead-Client)\nfor a gRPC client for version V1 of the API.\nHowever, you can specify a different API version by passing it in the\n`version` parameter. If the BigQueryRead service is\nsupported by that API version, and the corresponding gem is available, the\nappropriate versioned client will be returned.\n\nRaises an exception if the currently installed versioned client gem for the\ngiven API version does not support the BigQueryRead service.\nYou can determine whether the method will succeed by calling\n[Storage.big_query_read_available?](/ruby/docs/reference/google-cloud-bigquery-storage/latest/Google-Cloud-Bigquery-Storage#Google__Cloud__Bigquery__Storage_big_query_read_available__class_ \"Google::Cloud::Bigquery::Storage.big_query_read_available? (method)\").\n\n#### About BigQueryRead\n\nBigQuery Read API.\n\n\u003cbr /\u003e\n\nThe Read API can be used to read data from BigQuery. \n**Parameter**\n\n- **version** (::String, ::Symbol) *(defaults to: :v1)* --- The API version to connect to. Optional. Defaults to `:v1`. \n**Returns**\n\n- (::Object) --- A client object for the specified version.\n\n### .big_query_read_available?\n\n def self.big_query_read_available?(version: :v1) -\u003e boolean\n\nDetermines whether the BigQueryRead service is supported by the current client.\nIf true, you can retrieve a client object by calling [Storage.big_query_read](/ruby/docs/reference/google-cloud-bigquery-storage/latest/Google-Cloud-Bigquery-Storage#Google__Cloud__Bigquery__Storage_big_query_read_class_ \"Google::Cloud::Bigquery::Storage.big_query_read (method)\").\nIf false, that method will raise an exception. This could happen if the given\nAPI version does not exist or does not support the BigQueryRead service,\nor if the versioned client gem needs an update to support the BigQueryRead service. \n**Parameter**\n\n- **version** (::String, ::Symbol) *(defaults to: :v1)* --- The API version to connect to. Optional. Defaults to `:v1`. \n**Returns**\n\n- (boolean) --- Whether the service is available.\n\n### .big_query_write\n\n def self.big_query_write(version: :v1, &block) -\u003e ::Object\n\nCreate a new client object for BigQueryWrite.\n\n\nBy default, this returns an instance of\n[Google::Cloud::Bigquery::Storage::V1::BigQueryWrite::Client](https://cloud.google.com/ruby/docs/reference/google-cloud-bigquery-storage-v1/latest/Google-Cloud-Bigquery-Storage-V1-BigQueryWrite-Client)\nfor a gRPC client for version V1 of the API.\nHowever, you can specify a different API version by passing it in the\n`version` parameter. If the BigQueryWrite service is\nsupported by that API version, and the corresponding gem is available, the\nappropriate versioned client will be returned.\n\nRaises an exception if the currently installed versioned client gem for the\ngiven API version does not support the BigQueryWrite service.\nYou can determine whether the method will succeed by calling\n[Storage.big_query_write_available?](/ruby/docs/reference/google-cloud-bigquery-storage/latest/Google-Cloud-Bigquery-Storage#Google__Cloud__Bigquery__Storage_big_query_write_available__class_ \"Google::Cloud::Bigquery::Storage.big_query_write_available? (method)\").\n\n#### About BigQueryWrite\n\nBigQuery Write API.\n\nThe Write API can be used to write data to BigQuery.\n\n\u003cbr /\u003e\n\nFor supplementary information about the Write API, see:\n\u003chttps://cloud.google.com/bigquery/docs/write-api\u003e \n**Parameter**\n\n- **version** (::String, ::Symbol) *(defaults to: :v1)* --- The API version to connect to. Optional. Defaults to `:v1`. \n**Returns**\n\n- (::Object) --- A client object for the specified version.\n\n### .big_query_write_available?\n\n def self.big_query_write_available?(version: :v1) -\u003e boolean\n\nDetermines whether the BigQueryWrite service is supported by the current client.\nIf true, you can retrieve a client object by calling [Storage.big_query_write](/ruby/docs/reference/google-cloud-bigquery-storage/latest/Google-Cloud-Bigquery-Storage#Google__Cloud__Bigquery__Storage_big_query_write_class_ \"Google::Cloud::Bigquery::Storage.big_query_write (method)\").\nIf false, that method will raise an exception. This could happen if the given\nAPI version does not exist or does not support the BigQueryWrite service,\nor if the versioned client gem needs an update to support the BigQueryWrite service. \n**Parameter**\n\n- **version** (::String, ::Symbol) *(defaults to: :v1)* --- The API version to connect to. Optional. Defaults to `:v1`. \n**Returns**\n\n- (boolean) --- Whether the service is available.\n\n### .configure\n\n def self.configure() -\u003e ::Google::Cloud::Config\n\nConfigure the google-cloud-bigquery-storage library.\n\nThe following configuration parameters are supported:\n\n- `credentials` (*type:* `String, Hash, Google::Auth::Credentials`) - The path to the keyfile as a String, the contents of the keyfile as a Hash, or a Google::Auth::Credentials object.\n- `lib_name` (*type:* `String`) - The library name as recorded in instrumentation and logging.\n- `lib_version` (*type:* `String`) - The library version as recorded in instrumentation and logging.\n- `interceptors` (*type:* `Array\u003cGRPC::ClientInterceptor\u003e`) - An array of interceptors that are run before calls are executed.\n- `timeout` (*type:* `Numeric`) - Default timeout in seconds.\n- `metadata` (*type:* `Hash{Symbol=\u003eString}`) - Additional headers to be sent with the call.\n- `retry_policy` (*type:* `Hash`) - The retry policy. The value is a hash with the following keys:\n - `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.\n - `:max_delay` (*type:* `Numeric`) - The max delay in seconds.\n - `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.\n- `:retry_codes` (*type:* `Array\u003cString\u003e`) - The error codes that should trigger a retry. \n**Yields**\n\n- (::Google::Cloud.configure.bigquery_storage) \n**Returns**\n\n- (::Google::Cloud::Config) --- The default configuration used by this library\n\nConstants\n---------\n\n### VERSION\n\n**value:**\"1.6.1\""]]