Dataproc Metastore API - Module Google::Cloud::Metastore (v1.6.0)

Reference documentation and code samples for the Dataproc Metastore API module Google::Cloud::Metastore.

Methods

.configure

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

.dataproc_metastore

def self.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 Metastore.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}.

Parameters
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (::Object) — A client object for the specified version.

.dataproc_metastore_available?

def self.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 Metastore.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.

Parameters
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (boolean) — Whether the service is available.

.dataproc_metastore_federation

def self.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 Metastore.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}.
Parameters
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (::Object) — A client object for the specified version.

.dataproc_metastore_federation_available?

def self.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 Metastore.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.

Parameters
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (boolean) — Whether the service is available.

Constants

VERSION

value: "1.6.0"