DataprocMetastoreClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.metastore_v1.services.dataproc_metastore.transports.base.DataprocMetastoreTransport]] = None, client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)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 Cloudregion)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}.
Properties
transport
Returns the transport used by the client instance.
| Returns | |
|---|---|
| Type | Description |
DataprocMetastoreTransport | The transport used by the client instance. |
Methods
DataprocMetastoreClient
DataprocMetastoreClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.metastore_v1.services.dataproc_metastore.transports.base.DataprocMetastoreTransport]] = None, client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)Instantiates the dataproc metastore client.
| Parameters | |
|---|---|
| Name | Description |
credentials |
Optional[google.auth.credentials.Credentials]
The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment. |
transport |
Union[str, DataprocMetastoreTransport]
The transport to use. If set to None, a transport is chosen automatically. |
client_options |
google.api_core.client_options.ClientOptions
Custom options for the client. It won't take effect if a |
client_info |
google.api_core.gapic_v1.client_info.ClientInfo
The client info used to send a user-agent string along with API requests. If |
| Exceptions | |
|---|---|
| Type | Description |
google.auth.exceptions.MutualTLSChannelError | If mutual TLS transport creation failed for any reason. |
__exit__
__exit__(type, value, traceback)Releases underlying transport's resources.
backup_path
backup_path(project: str, location: str, service: str, backup: str)Returns a fully-qualified backup string.
common_billing_account_path
common_billing_account_path(billing_account: str)Returns a fully-qualified billing_account string.
common_folder_path
common_folder_path(folder: str)Returns a fully-qualified folder string.
common_location_path
common_location_path(project: str, location: str)Returns a fully-qualified location string.
common_organization_path
common_organization_path(organization: str)Returns a fully-qualified organization string.
common_project_path
common_project_path(project: str)Returns a fully-qualified project string.
create_backup
create_backup(request: Optional[Union[google.cloud.metastore_v1.types.metastore.CreateBackupRequest, dict]] = None, *, parent: Optional[str] = None, backup: Optional[google.cloud.metastore_v1.types.metastore.Backup] = None, backup_id: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Creates a new backup in a given project and location.
| Parameters | |
|---|---|
| Name | Description |
request |
Union[google.cloud.metastore_v1.types.CreateBackupRequest, dict]
The request object. Request message for DataprocMetastore.CreateBackup. |
parent |
str
Required. The relative resource name of the service in which to create a backup of the following form: |
backup |
google.cloud.metastore_v1.types.Backup
Required. The backup to create. The |
backup_id |
str
Required. The ID of the backup, which is used as the final component of the backup's name. This value must be between 1 and 64 characters long, begin with a letter, end with a letter or number, and consist of alpha-numeric ASCII characters or hyphens. This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Returns | |
|---|---|
| Type | Description |
google.api_core.operation.Operation | An object representing a long-running operation. The result type for the operation will be Backup The details of a backup resource. |
create_metadata_import
create_metadata_import(request: Optional[Union[google.cloud.metastore_v1.types.metastore.CreateMetadataImportRequest, dict]] = None, *, parent: Optional[str] = None, metadata_import: Optional[google.cloud.metastore_v1.types.metastore.MetadataImport] = None, metadata_import_id: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Creates a new MetadataImport in a given project and location.
| Parameters | |
|---|---|
| Name | Description |
request |
Union[google.cloud.metastore_v1.types.CreateMetadataImportRequest, dict]
The request object. Request message for DataprocMetastore.CreateMetadataImport. |
parent |
str
Required. The relative resource name of the service in which to create a metastore import, in the following form: |
metadata_import |
google.cloud.metastore_v1.types.MetadataImport
Required. The metadata import to create. The |
metadata_import_id |
str
Required. The ID of the metadata import, which is used as the final component of the metadata import's name. This value must be between 1 and 64 characters long, begin with a letter, end with a letter or number, and consist of alpha-numeric ASCII characters or hyphens. This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Returns | |
|---|---|
| Type | Description |
google.api_core.operation.Operation | An object representing a long-running operation. The result type for the operation will be MetadataImport A metastore resource that imports metadata. |
create_service
create_service(request: Optional[Union[google.cloud.metastore_v1.types.metastore.CreateServiceRequest, dict]] = None, *, parent: Optional[str] = None, service: Optional[google.cloud.metastore_v1.types.metastore.Service] = None, service_id: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Creates a metastore service in a project and location.
| Parameters | |
|---|---|
| Name | Description |
request |
Union[google.cloud.metastore_v1.types.CreateServiceRequest, dict]
The request object. Request message for DataprocMetastore.CreateService. |
parent |
str
Required. The relative resource name of the location in which to create a metastore service, in the following form: |
service |
google.cloud.metastore_v1.types.Service
Required. The Metastore service to create. The |
service_id |
str
Required. The ID of the metastore service, which is used as the final component of the metastore service's name. This value must be between 2 and 63 characters long inclusive, begin with a letter, end with a letter or number, and consist of alpha-numeric ASCII characters or hyphens. This corresponds to the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Returns | |
|---|---|
| Type | Description |
google.api_core.operation.Operation | An object representing a long-running operation. The result type for the operation will be Service A managed metastore service that serves metadata queries. |
delete_backup
delete_backup(request: Optional[Union[google.cloud.metastore_v1.types.metastore.DeleteBackupRequest, dict]] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Deletes a single backup.
| Parameters | |
|---|---|
| Name | Description |
request |
Union[google.cloud.metastore_v1.types.DeleteBackupRequest, dict]
The request object. Request message for DataprocMetastore.DeleteBackup. |
name |
str
Required. The relative resource name of the backup to delete, in the following form: |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Returns | |
|---|---|
| Type | Description |
google.api_core.operation.Operation | An object representing a long-running operation. The result type for the operation will be google.protobuf.empty_pb2.Empty A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for Empty is empty JSON object {}. |
delete_service
delete_service(request: Optional[Union[google.cloud.metastore_v1.types.metastore.DeleteServiceRequest, dict]] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Deletes a single service.
| Parameters | |
|---|---|
| Name | Description |
request |
Union[google.cloud.metastore_v1.types.DeleteServiceRequest, dict]
The request object. Request message for DataprocMetastore.DeleteService. |
name |
str
Required. The relative resource name of the metastore service to delete, in the following form: |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Returns | |
|---|---|
| Type | Description |
google.api_core.operation.Operation | An object representing a long-running operation. The result type for the operation will be google.protobuf.empty_pb2.Empty A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for Empty is empty JSON object {}. |
export_metadata
export_metadata(request: Optional[Union[google.cloud.metastore_v1.types.metastore.ExportMetadataRequest, dict]] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Exports metadata from a service.
| Parameters | |
|---|---|
| Name | Description |
request |
Union[google.cloud.metastore_v1.types.ExportMetadataRequest, dict]
The request object. Request message for DataprocMetastore.ExportMetadata. |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Returns | |
|---|---|
| Type | Description |
google.api_core.operation.Operation | An object representing a long-running operation. The result type for the operation will be MetadataExport The details of a metadata export operation. |
from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)Creates an instance of this client using the provided credentials file.
| Parameter | |
|---|---|
| Name | Description |
filename |
str
The path to the service account private key json file. |
| Returns | |
|---|---|
| Type | Description |
DataprocMetastoreClient | The constructed client. |
from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)Creates an instance of this client using the provided credentials info.
| Parameter | |
|---|---|
| Name | Description |
info |
dict
The service account private key info. |
| Returns | |
|---|---|
| Type | Description |
DataprocMetastoreClient | The constructed client. |
from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)Creates an instance of this client using the provided credentials file.
| Parameter | |
|---|---|
| Name | Description |
filename |
str
The path to the service account private key json file. |
| Returns | |
|---|---|
| Type | Description |
DataprocMetastoreClient | The constructed client. |
get_backup
get_backup(request: Optional[Union[google.cloud.metastore_v1.types.metastore.GetBackupRequest, dict]] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Gets details of a single backup.
| Parameters | |
|---|---|
| Name | Description |
request |
Union[google.cloud.metastore_v1.types.GetBackupRequest, dict]
The request object. Request message for DataprocMetastore.GetBackup. |
name |
str
Required. The relative resource name of the backup to retrieve, in the following form: |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Returns | |
|---|---|
| Type | Description |
google.cloud.metastore_v1.types.Backup | The details of a backup resource. |
get_metadata_import
get_metadata_import(request: Optional[Union[google.cloud.metastore_v1.types.metastore.GetMetadataImportRequest, dict]] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Gets details of a single import.
| Parameters | |
|---|---|
| Name | Description |
request |
Union[google.cloud.metastore_v1.types.GetMetadataImportRequest, dict]
The request object. Request message for DataprocMetastore.GetMetadataImport. |
name |
str
Required. The relative resource name of the metadata import to retrieve, in the following form: |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Returns | |
|---|---|
| Type | Description |
google.cloud.metastore_v1.types.MetadataImport | A metastore resource that imports metadata. |
get_service
get_service(request: Optional[Union[google.cloud.metastore_v1.types.metastore.GetServiceRequest, dict]] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Gets the details of a single service.
| Parameters | |
|---|---|
| Name | Description |
request |
Union[google.cloud.metastore_v1.types.GetServiceRequest, dict]
The request object. Request message for DataprocMetastore.GetService. |
name |
str
Required. The relative resource name of the metastore service to retrieve, in the following form: |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Returns | |
|---|---|
| Type | Description |
google.cloud.metastore_v1.types.Service | A managed metastore service that serves metadata queries. |
list_backups
list_backups(request: Optional[Union[google.cloud.metastore_v1.types.metastore.ListBackupsRequest, dict]] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Lists backups in a service.
| Parameters | |
|---|---|
| Name | Description |
request |
Union[google.cloud.metastore_v1.types.ListBackupsRequest, dict]
The request object. Request message for DataprocMetastore.ListBackups. |
parent |
str
Required. The relative resource name of the service whose backups to list, in the following form: |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Returns | |
|---|---|
| Type | Description |
google.cloud.metastore_v1.services.dataproc_metastore.pagers.ListBackupsPager | Response message for DataprocMetastore.ListBackups. Iterating over this object will yield results and resolve additional pages automatically. |
list_metadata_imports
list_metadata_imports(request: Optional[Union[google.cloud.metastore_v1.types.metastore.ListMetadataImportsRequest, dict]] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Lists imports in a service.
| Parameters | |
|---|---|
| Name | Description |
request |
Union[google.cloud.metastore_v1.types.ListMetadataImportsRequest, dict]
The request object. Request message for DataprocMetastore.ListMetadataImports. |
parent |
str
Required. The relative resource name of the service whose metadata imports to list, in the following form: |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Returns | |
|---|---|
| Type | Description |
google.cloud.metastore_v1.services.dataproc_metastore.pagers.ListMetadataImportsPager | Response message for DataprocMetastore.ListMetadataImports. Iterating over this object will yield results and resolve additional pages automatically. |
list_services
list_services(request: Optional[Union[google.cloud.metastore_v1.types.metastore.ListServicesRequest, dict]] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Lists services in a project and location.
| Parameters | |
|---|---|
| Name | Description |
request |
Union[google.cloud.metastore_v1.types.ListServicesRequest, dict]
The request object. Request message for DataprocMetastore.ListServices. |
parent |
str
Required. The relative resource name of the location of metastore services to list, in the following form: |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Returns | |
|---|---|
| Type | Description |
google.cloud.metastore_v1.services.dataproc_metastore.pagers.ListServicesPager | Response message for DataprocMetastore.ListServices. Iterating over this object will yield results and resolve additional pages automatically. |
metadata_import_path
metadata_import_path(
project: str, location: str, service: str, metadata_import: str
)Returns a fully-qualified metadata_import string.
network_path
network_path(project: str, network: str)Returns a fully-qualified network string.
parse_backup_path
parse_backup_path(path: str)Parses a backup path into its component segments.
parse_common_billing_account_path
parse_common_billing_account_path(path: str)Parse a billing_account path into its component segments.
parse_common_folder_path
parse_common_folder_path(path: str)Parse a folder path into its component segments.
parse_common_location_path
parse_common_location_path(path: str)Parse a location path into its component segments.
parse_common_organization_path
parse_common_organization_path(path: str)Parse a organization path into its component segments.
parse_common_project_path
parse_common_project_path(path: str)Parse a project path into its component segments.
parse_metadata_import_path
parse_metadata_import_path(path: str)Parses a metadata_import path into its component segments.
parse_network_path
parse_network_path(path: str)Parses a network path into its component segments.
parse_service_path
parse_service_path(path: str)Parses a service path into its component segments.
restore_service
restore_service(request: Optional[Union[google.cloud.metastore_v1.types.metastore.RestoreServiceRequest, dict]] = None, *, service: Optional[str] = None, backup: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Restores a service from a backup.
| Parameters | |
|---|---|
| Name | Description |
request |
Union[google.cloud.metastore_v1.types.RestoreServiceRequest, dict]
The request object. Request message for [DataprocMetastore.Restore][]. |
service |
str
Required. The relative resource name of the metastore service to run restore, in the following form: |
backup |
str
Required. The relative resource name of the metastore service backup to restore from, in the following form: |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Returns | |
|---|---|
| Type | Description |
google.api_core.operation.Operation | An object representing a long-running operation. The result type for the operation will be Restore The details of a metadata restore operation. |
service_path
service_path(project: str, location: str, service: str)Returns a fully-qualified service string.
update_metadata_import
update_metadata_import(request: Optional[Union[google.cloud.metastore_v1.types.metastore.UpdateMetadataImportRequest, dict]] = None, *, metadata_import: Optional[google.cloud.metastore_v1.types.metastore.MetadataImport] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Updates a single import. Only the description field of MetadataImport is supported to be updated.
| Parameters | |
|---|---|
| Name | Description |
request |
Union[google.cloud.metastore_v1.types.UpdateMetadataImportRequest, dict]
The request object. Request message for DataprocMetastore.UpdateMetadataImport. |
metadata_import |
google.cloud.metastore_v1.types.MetadataImport
Required. The metadata import to update. The server only merges fields in the import if they are specified in |
update_mask |
google.protobuf.field_mask_pb2.FieldMask
Required. A field mask used to specify the fields to be overwritten in the metadata import resource by the update. Fields specified in the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Returns | |
|---|---|
| Type | Description |
google.api_core.operation.Operation | An object representing a long-running operation. The result type for the operation will be MetadataImport A metastore resource that imports metadata. |
update_service
update_service(request: Optional[Union[google.cloud.metastore_v1.types.metastore.UpdateServiceRequest, dict]] = None, *, service: Optional[google.cloud.metastore_v1.types.metastore.Service] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())Updates the parameters of a single service.
| Parameters | |
|---|---|
| Name | Description |
request |
Union[google.cloud.metastore_v1.types.UpdateServiceRequest, dict]
The request object. Request message for DataprocMetastore.UpdateService. |
service |
google.cloud.metastore_v1.types.Service
Required. The metastore service to update. The server only merges fields in the service if they are specified in |
update_mask |
google.protobuf.field_mask_pb2.FieldMask
Required. A field mask used to specify the fields to be overwritten in the metastore service resource by the update. Fields specified in the |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
| Returns | |
|---|---|
| Type | Description |
google.api_core.operation.Operation | An object representing a long-running operation. The result type for the operation will be Service A managed metastore service that serves metadata queries. |