Reference documentation and code samples for the Dataproc Metastore API module Google::Cloud::Metastore.
Methods
.configure
defself.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
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:
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.
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.
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.
[[["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,["# Dataproc Metastore API - Module Google::Cloud::Metastore (v2.0.1)\n\nVersion latestkeyboard_arrow_down\n\n- [2.0.1 (latest)](/ruby/docs/reference/google-cloud-metastore/latest/Google-Cloud-Metastore)\n- [2.0.0](/ruby/docs/reference/google-cloud-metastore/2.0.0/Google-Cloud-Metastore)\n- [1.6.0](/ruby/docs/reference/google-cloud-metastore/1.6.0/Google-Cloud-Metastore)\n- [1.5.1](/ruby/docs/reference/google-cloud-metastore/1.5.1/Google-Cloud-Metastore)\n- [1.4.0](/ruby/docs/reference/google-cloud-metastore/1.4.0/Google-Cloud-Metastore)\n- [1.3.0](/ruby/docs/reference/google-cloud-metastore/1.3.0/Google-Cloud-Metastore)\n- [1.2.0](/ruby/docs/reference/google-cloud-metastore/1.2.0/Google-Cloud-Metastore)\n- [1.1.0](/ruby/docs/reference/google-cloud-metastore/1.1.0/Google-Cloud-Metastore)\n- [1.0.1](/ruby/docs/reference/google-cloud-metastore/1.0.1/Google-Cloud-Metastore) \nReference documentation and code samples for the Dataproc Metastore API module Google::Cloud::Metastore.\n\nMethods\n-------\n\n### .configure\n\n def self.configure() -\u003e ::Google::Cloud::Config\n\nConfigure the google-cloud-metastore 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.metastore) \n**Returns**\n\n- (::Google::Cloud::Config) --- The default configuration used by this library\n\n### .dataproc_metastore\n\n def self.dataproc_metastore(version: :v1, transport: :grpc, &block) -\u003e ::Object\n\nCreate a new client object for DataprocMetastore.\n\n\nBy default, this returns an instance of\n[Google::Cloud::Metastore::V1::DataprocMetastore::Client](https://cloud.google.com/ruby/docs/reference/google-cloud-metastore-v1/latest/Google-Cloud-Metastore-V1-DataprocMetastore-Client)\nfor a gRPC client for version V1 of the API.\nHowever, you can specify a different API version by passing it in the\n`version` parameter. If the DataprocMetastore service is\nsupported by that API version, and the corresponding gem is available, the\nappropriate versioned client will be returned.\nYou can also specify a different transport by passing `:rest` or `:grpc` in\nthe `transport` parameter.\n\nRaises an exception if the currently installed versioned client gem for the\ngiven API version does not support the given transport of the DataprocMetastore service.\nYou can determine whether the method will succeed by calling\n[Metastore.dataproc_metastore_available?](/ruby/docs/reference/google-cloud-metastore/latest/Google-Cloud-Metastore#Google__Cloud__Metastore_dataproc_metastore_available__class_ \"Google::Cloud::Metastore.dataproc_metastore_available? (method)\").\n\n#### About DataprocMetastore\n\nConfigures and manages metastore services.\nMetastore services are fully managed, highly available, autoscaled,\nautohealing, OSS-native deployments of technical metadata management\nsoftware. Each metastore service exposes a network endpoint through which\nmetadata queries are served. Metadata queries can originate from a variety\nof sources, including Apache Hive, Apache Presto, and Apache Spark.\n\nThe Dataproc Metastore API defines the following resource model:\n\n- The service works with a collection of Google Cloud projects, named: `/projects/`\n- Each project has a collection of available locations, named: `/locations/` (a location must refer to a Google Cloud `region`)\n- Each location has a collection of services, named: `/services/*`\n- Dataproc Metastore services are resources with names of the form:\n\n\u003cbr /\u003e\n\n`/projects/{project_number}/locations/{location_id}/services/{service_id}`. \n**Parameters**\n\n- **version** (::String, ::Symbol) *(defaults to: :v1)* --- The API version to connect to. Optional. Defaults to `:v1`.\n- **transport** (:grpc, :rest) *(defaults to: :grpc)* --- The transport to use. Defaults to `:grpc`. \n**Returns**\n\n- (::Object) --- A client object for the specified version.\n\n### .dataproc_metastore_available?\n\n def self.dataproc_metastore_available?(version: :v1, transport: :grpc) -\u003e boolean\n\nDetermines whether the DataprocMetastore service is supported by the current client.\nIf true, you can retrieve a client object by calling [Metastore.dataproc_metastore](/ruby/docs/reference/google-cloud-metastore/latest/Google-Cloud-Metastore#Google__Cloud__Metastore_dataproc_metastore_class_ \"Google::Cloud::Metastore.dataproc_metastore (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 DataprocMetastore service,\nor if the versioned client gem needs an update to support the DataprocMetastore service. \n**Parameters**\n\n- **version** (::String, ::Symbol) *(defaults to: :v1)* --- The API version to connect to. Optional. Defaults to `:v1`.\n- **transport** (:grpc, :rest) *(defaults to: :grpc)* --- The transport to use. Defaults to `:grpc`. \n**Returns**\n\n- (boolean) --- Whether the service is available.\n\n### .dataproc_metastore_federation\n\n def self.dataproc_metastore_federation(version: :v1, transport: :grpc, &block) -\u003e ::Object\n\nCreate a new client object for DataprocMetastoreFederation.\n\nBy default, this returns an instance of\n[Google::Cloud::Metastore::V1::DataprocMetastoreFederation::Client](https://cloud.google.com/ruby/docs/reference/google-cloud-metastore-v1/latest/Google-Cloud-Metastore-V1-DataprocMetastoreFederation-Client)\nfor a gRPC client for version V1 of the API.\nHowever, you can specify a different API version by passing it in the\n`version` parameter. If the DataprocMetastoreFederation service is\nsupported by that API version, and the corresponding gem is available, the\nappropriate versioned client will be returned.\nYou can also specify a different transport by passing `:rest` or `:grpc` in\nthe `transport` parameter.\n\nRaises an exception if the currently installed versioned client gem for the\ngiven API version does not support the given transport of the DataprocMetastoreFederation service.\nYou can determine whether the method will succeed by calling\n[Metastore.dataproc_metastore_federation_available?](/ruby/docs/reference/google-cloud-metastore/latest/Google-Cloud-Metastore#Google__Cloud__Metastore_dataproc_metastore_federation_available__class_ \"Google::Cloud::Metastore.dataproc_metastore_federation_available? (method)\").\n\n#### About DataprocMetastoreFederation\n\nConfigures and manages metastore federation services.\nDataproc Metastore Federation Service allows federating a collection of\nbackend metastores like BigQuery, Dataplex Lakes, and other Dataproc\nMetastores. The Federation Service exposes a gRPC URL through which metadata\nfrom the backend metastores are served at query time.\n\nThe Dataproc Metastore Federation API defines the following resource model:\n\n- The service works with a collection of Google Cloud projects.\n- Each project has a collection of available locations.\n- Each location has a collection of federations.\n- Dataproc Metastore Federations are resources with names of the form: `projects/{project_number}/locations/{location_id}/federations/{federation_id}`. \n**Parameters**\n\n- **version** (::String, ::Symbol) *(defaults to: :v1)* --- The API version to connect to. Optional. Defaults to `:v1`.\n- **transport** (:grpc, :rest) *(defaults to: :grpc)* --- The transport to use. Defaults to `:grpc`. \n**Returns**\n\n- (::Object) --- A client object for the specified version.\n\n### .dataproc_metastore_federation_available?\n\n def self.dataproc_metastore_federation_available?(version: :v1, transport: :grpc) -\u003e boolean\n\nDetermines whether the DataprocMetastoreFederation service is supported by the current client.\nIf true, you can retrieve a client object by calling [Metastore.dataproc_metastore_federation](/ruby/docs/reference/google-cloud-metastore/latest/Google-Cloud-Metastore#Google__Cloud__Metastore_dataproc_metastore_federation_class_ \"Google::Cloud::Metastore.dataproc_metastore_federation (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 DataprocMetastoreFederation service,\nor if the versioned client gem needs an update to support the DataprocMetastoreFederation service. \n**Parameters**\n\n- **version** (::String, ::Symbol) *(defaults to: :v1)* --- The API version to connect to. Optional. Defaults to `:v1`.\n- **transport** (:grpc, :rest) *(defaults to: :grpc)* --- The transport to use. Defaults to `:grpc`. \n**Returns**\n\n- (boolean) --- Whether the service is available.\n\nConstants\n---------\n\n### VERSION\n\n**value:**\"2.0.1\""]]