Create a new client object for AnalyticsHubService.
By default, this returns an instance of
Google::Cloud::Bigquery::DataExchange::V1beta1::AnalyticsHubService::Client
for a gRPC client for version V1beta1 of the API.
However, you can specify a different API version by passing it in the
version parameter. If the AnalyticsHubService 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 AnalyticsHubService service.
You can determine whether the method will succeed by calling
DataExchange.analytics_hub_service_available?.
About AnalyticsHubService
The AnalyticsHubService API facilitates data sharing within and across
organizations. It allows data providers to publish listings that reference
shared datasets. With Analytics Hub, users can discover and search for
listings that they have access to. Subscribers can view and subscribe to
listings. When you subscribe to a listing, Analytics Hub creates a linked
dataset in your project.
Parameter
version (::String, ::Symbol) (defaults to: :v1beta1) — The API version to connect to. Optional.
Defaults to :v1beta1.
Returns
(::Object) — A client object for the specified version.
Determines whether the AnalyticsHubService service is supported by the current client.
If true, you can retrieve a client object by calling DataExchange.analytics_hub_service.
If false, that method will raise an exception. This could happen if the given
API version does not exist or does not support the AnalyticsHubService service,
or if the versioned client gem needs an update to support the AnalyticsHubService service.
Parameter
version (::String, ::Symbol) (defaults to: :v1beta1) — The API version to connect to. Optional.
Defaults to :v1beta1.
Returns
(boolean) — Whether the service is available.
.configure
defself.configure()->::Google::Cloud::Config
Configure the google-cloud-bigquery-data_exchange 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.
[[["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-08-28 UTC."],[],[],null,["# Analytics Hub API - Module Google::Cloud::Bigquery::DataExchange (v0.5.1)\n\nVersion latestkeyboard_arrow_down\n\n- [0.5.1 (latest)](/ruby/docs/reference/google-cloud-bigquery-data_exchange/latest/Google-Cloud-Bigquery-DataExchange)\n- [0.5.0](/ruby/docs/reference/google-cloud-bigquery-data_exchange/0.5.0/Google-Cloud-Bigquery-DataExchange)\n- [0.4.1](/ruby/docs/reference/google-cloud-bigquery-data_exchange/0.4.1/Google-Cloud-Bigquery-DataExchange)\n- [0.3.0](/ruby/docs/reference/google-cloud-bigquery-data_exchange/0.3.0/Google-Cloud-Bigquery-DataExchange)\n- [0.2.0](/ruby/docs/reference/google-cloud-bigquery-data_exchange/0.2.0/Google-Cloud-Bigquery-DataExchange)\n- [0.1.0](/ruby/docs/reference/google-cloud-bigquery-data_exchange/0.1.0/Google-Cloud-Bigquery-DataExchange) \nReference documentation and code samples for the Analytics Hub API module Google::Cloud::Bigquery::DataExchange.\n\nMethods\n-------\n\n### .analytics_hub_service\n\n def self.analytics_hub_service(version: :v1beta1, &block) -\u003e ::Object\n\nCreate a new client object for AnalyticsHubService.\n\n\nBy default, this returns an instance of\n[Google::Cloud::Bigquery::DataExchange::V1beta1::AnalyticsHubService::Client](https://cloud.google.com/ruby/docs/reference/google-cloud-bigquery-data_exchange-v1beta1/latest/Google-Cloud-Bigquery-DataExchange-V1beta1-AnalyticsHubService-Client)\nfor a gRPC client for version V1beta1 of the API.\nHowever, you can specify a different API version by passing it in the\n`version` parameter. If the AnalyticsHubService service is\nsupported by that API version, and the corresponding gem is available, the\nappropriate versioned client will be returned.\n\n\u003cbr /\u003e\n\nRaises an exception if the currently installed versioned client gem for the\ngiven API version does not support the AnalyticsHubService service.\nYou can determine whether the method will succeed by calling\n[DataExchange.analytics_hub_service_available?](/ruby/docs/reference/google-cloud-bigquery-data_exchange/latest/Google-Cloud-Bigquery-DataExchange#Google__Cloud__Bigquery__DataExchange_analytics_hub_service_available__class_ \"Google::Cloud::Bigquery::DataExchange.analytics_hub_service_available? (method)\").\n\n#### About AnalyticsHubService\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\nThe `AnalyticsHubService` API facilitates data sharing within and across\norganizations. It allows data providers to publish listings that reference\nshared datasets. With Analytics Hub, users can discover and search for\nlistings that they have access to. Subscribers can view and subscribe to\nlistings. When you subscribe to a listing, Analytics Hub creates a linked\ndataset in your project. \n**Parameter**\n\n- **version** (::String, ::Symbol) *(defaults to: :v1beta1)* --- The API version to connect to. Optional. Defaults to `:v1beta1`. \n**Returns**\n\n- (::Object) --- A client object for the specified version.\n\n### .analytics_hub_service_available?\n\n def self.analytics_hub_service_available?(version: :v1beta1) -\u003e boolean\n\nDetermines whether the AnalyticsHubService service is supported by the current client.\nIf true, you can retrieve a client object by calling [DataExchange.analytics_hub_service](/ruby/docs/reference/google-cloud-bigquery-data_exchange/latest/Google-Cloud-Bigquery-DataExchange#Google__Cloud__Bigquery__DataExchange_analytics_hub_service_class_ \"Google::Cloud::Bigquery::DataExchange.analytics_hub_service (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 AnalyticsHubService service,\nor if the versioned client gem needs an update to support the AnalyticsHubService service. \n**Parameter**\n\n- **version** (::String, ::Symbol) *(defaults to: :v1beta1)* --- The API version to connect to. Optional. Defaults to `:v1beta1`. \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-data_exchange 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_data_exchange) \n**Returns**\n\n- (::Google::Cloud::Config) --- The default configuration used by this library\n\nConstants\n---------\n\n### VERSION\n\n**value:**\"0.5.1\""]]