Analytics Hub API - Module Google::Cloud::Bigquery::DataExchange (v0.5.0)

Reference documentation and code samples for the Analytics Hub API module Google::Cloud::Bigquery::DataExchange.

Methods

.analytics_hub_service

def self.analytics_hub_service(version: :v1beta1, &block) -> ::Object

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.

.analytics_hub_service_available?

def self.analytics_hub_service_available?(version: :v1beta1) -> boolean

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

def self.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.
Yields
  • (::Google::Cloud.configure.bigquery_data_exchange)
Returns
  • (::Google::Cloud::Config) — The default configuration used by this library

Constants

VERSION

value: "0.5.0"