Module: Google::Cloud::Metastore

Defined in:
lib/google/cloud/metastore.rb,
lib/google/cloud/metastore/version.rb

Constant Summary collapse

VERSION = 
"1.6.0"

Class Method Summary collapse

Class Method Details

.configure {|::Google::Cloud.configure.metastore| ... } ⇒ ::Google::Cloud::Config

Configure the google-cloud-metastore 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:



244
245
246
247
248
 
# File 'lib/google/cloud/metastore.rb', line 244

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

  ::Google::Cloud.configure.metastore
end

.dataproc_metastore(version: :v1, transport: :grpc, &block) ⇒ ::Object

Create a new client object for DataprocMetastore.

By default, this returns an instance of Google::Cloud::Metastore::V1::DataprocMetastore::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 DataprocMetastore service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the DataprocMetastore service. You can determine whether the method will succeed by calling dataproc_metastore_available?.

About DataprocMetastore

Configures and manages metastore services. Metastore services are fully managed, highly available, autoscaled, autohealing, OSS-native deployments of technical metadata management software. Each metastore service exposes a network endpoint through which metadata queries are served. Metadata queries can originate from a variety of sources, including Apache Hive, Apache Presto, and Apache Spark.

The Dataproc Metastore API defines the following resource model:

  • The service works with a collection of Google Cloud projects, named: /projects/*
  • Each project has a collection of available locations, named: /locations/* (a location must refer to a Google Cloud region)
  • Each location has a collection of services, named: /services/*
  • Dataproc Metastore services are resources with names of the form:

/projects/{project_number}/locations/{location_id}/services/{service_id}.



91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/google/cloud/metastore.rb', line 91

def self.dataproc_metastore version: :v1, transport: :grpc, &block
  require "google/cloud/metastore/#{version.to_s.downcase}"

  package_name = Google::Cloud::Metastore
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  service_module = Google::Cloud::Metastore.const_get(package_name).const_get(:DataprocMetastore)
  service_module = service_module.const_get(:Rest) if transport == :rest
  service_module.const_get(:Client).new(&block)
end

.dataproc_metastore_available?(version: :v1, transport: :grpc) ⇒ boolean

Determines whether the DataprocMetastore service is supported by the current client. If true, you can retrieve a client object by calling dataproc_metastore. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the DataprocMetastore service, or if the versioned client gem needs an update to support the DataprocMetastore service.



115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/google/cloud/metastore.rb', line 115

def self.dataproc_metastore_available? version: :v1, transport: :grpc
  require "google/cloud/metastore/#{version.to_s.downcase}"
  package_name = Google::Cloud::Metastore
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  return false unless package_name
  service_module = Google::Cloud::Metastore.const_get package_name
  return false unless service_module.const_defined? :DataprocMetastore
  service_module = service_module.const_get :DataprocMetastore
  if transport == :rest
    return false unless service_module.const_defined? :Rest
    service_module = service_module.const_get :Rest
  end
  service_module.const_defined? :Client
rescue ::LoadError
  false
end

.dataproc_metastore_federation(version: :v1, transport: :grpc, &block) ⇒ ::Object

Create a new client object for DataprocMetastoreFederation.

By default, this returns an instance of Google::Cloud::Metastore::V1::DataprocMetastoreFederation::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 DataprocMetastoreFederation service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the DataprocMetastoreFederation service. You can determine whether the method will succeed by calling dataproc_metastore_federation_available?.

About DataprocMetastoreFederation

Configures and manages metastore federation services. Dataproc Metastore Federation Service allows federating a collection of backend metastores like BigQuery, Dataplex Lakes, and other Dataproc Metastores. The Federation Service exposes a gRPC URL through which metadata from the backend metastores are served at query time.

The Dataproc Metastore Federation API defines the following resource model:

  • The service works with a collection of Google Cloud projects.
  • Each project has a collection of available locations.
  • Each location has a collection of federations.
  • Dataproc Metastore Federations are resources with names of the form: projects/{project_number}/locations/{location_id}/federations/{federation_id}.


173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/google/cloud/metastore.rb', line 173

def self.dataproc_metastore_federation version: :v1, transport: :grpc, &block
  require "google/cloud/metastore/#{version.to_s.downcase}"

  package_name = Google::Cloud::Metastore
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  service_module = Google::Cloud::Metastore.const_get(package_name).const_get(:DataprocMetastoreFederation)
  service_module = service_module.const_get(:Rest) if transport == :rest
  service_module.const_get(:Client).new(&block)
end

.dataproc_metastore_federation_available?(version: :v1, transport: :grpc) ⇒ boolean

Determines whether the DataprocMetastoreFederation service is supported by the current client. If true, you can retrieve a client object by calling dataproc_metastore_federation. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the DataprocMetastoreFederation service, or if the versioned client gem needs an update to support the DataprocMetastoreFederation service.



197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
 
# File 'lib/google/cloud/metastore.rb', line 197

def self.dataproc_metastore_federation_available? version: :v1, transport: :grpc
  require "google/cloud/metastore/#{version.to_s.downcase}"
  package_name = Google::Cloud::Metastore
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  return false unless package_name
  service_module = Google::Cloud::Metastore.const_get package_name
  return false unless service_module.const_defined? :DataprocMetastoreFederation
  service_module = service_module.const_get :DataprocMetastoreFederation
  if transport == :rest
    return false unless service_module.const_defined? :Rest
    service_module = service_module.const_get :Rest
  end
  service_module.const_defined? :Client
rescue ::LoadError
  false
end