Module: Google::Cloud::Bigquery::DataExchange

Defined in:
lib/google/cloud/bigquery/data_exchange.rb,
lib/google/cloud/bigquery/data_exchange/version.rb

Constant Summary collapse

VERSION = 
"0.4.1"

Class Method Summary collapse

Class Method Details

.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.

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.

Parameters:

  • 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.



73
74
75
76
77
78
79
80
81
82
 
# File 'lib/google/cloud/bigquery/data_exchange.rb', line 73

def self.analytics_hub_service version: :v1beta1, &block
  require "google/cloud/bigquery/data_exchange/#{version.to_s.downcase}"

  package_name = Google::Cloud::Bigquery::DataExchange
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  service_module = Google::Cloud::Bigquery::DataExchange.const_get(package_name).const_get(:AnalyticsHubService)
  service_module.const_get(:Client).new(&block)
end

.configure {|::Google::Cloud.configure.bigquery_data_exchange| ... } ⇒ ::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:

Returns:

  • (::Google::Cloud::Config) —

    The default configuration used by this library



112
113
114
115
116
 
# File 'lib/google/cloud/bigquery/data_exchange.rb', line 112

def self.configure
  yield ::Google::Cloud.configure.bigquery_data_exchange if block_given?

  ::Google::Cloud.configure.bigquery_data_exchange
end