As of January 1, 2020 this library no longer supports Python 2 on the latest released version. Library versions released prior to that date will continue to be available. For more information please visit Python 2 support on Google Cloud.

DataprocMetastore

class google.cloud.metastore_v1beta.services.dataproc_metastore.DataprocMetastoreAsyncClient(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.metastore_v1beta.services.dataproc_metastore.transports.base.DataprocMetastoreTransport] = 'grpc_asyncio', client_options: <module 'google.api_core.client_options' from '/workspace/.nox/docs/lib/python3.8/site-packages/google/api_core/client_options.py'> = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)[source]

Configures and manages metastore services. Metastore services are fully managed, highly available, auto-scaled, auto-healing, 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}.

Instantiates the dataproc metastore client.

Parameters
  • 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 (ClientOptions) – Custom options for the client. It won’t take effect if a transport instance is provided. (1) The api_endpoint property can be used to override the default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT environment variable can also be used to override the endpoint: “always” (always use the default mTLS endpoint), “never” (always use the default regular endpoint) and “auto” (auto switch to the default mTLS endpoint if client certificate is present, this is the default value). However, the api_endpoint property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “true”, then the client_cert_source property can be used to provide client certificate for mutual TLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is “false” or not set, no client certificate will be used.

Raises

google.auth.exceptions.MutualTlsChannelError – If mutual TLS transport creation failed for any reason.

static backup_path(project: str, location: str, service: str, backup: str)str

Returns a fully-qualified backup string.

static common_billing_account_path(billing_account: str)str

Returns a fully-qualified billing_account string.

static common_folder_path(folder: str)str

Returns a fully-qualified folder string.

static common_location_path(project: str, location: str)str

Returns a fully-qualified location string.

static common_organization_path(organization: str)str

Returns a fully-qualified organization string.

static common_project_path(project: str)str

Returns a fully-qualified project string.

async create_backup(request: Optional[google.cloud.metastore_v1beta.types.metastore.CreateBackupRequest] = None, *, parent: Optional[str] = None, backup: Optional[google.cloud.metastore_v1beta.types.metastore.Backup] = None, backup_id: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.api_core.operation_async.AsyncOperation[source]

Creates a new Backup in a given project and location.

Parameters
  • request (google.cloud.metastore_v1beta.types.CreateBackupRequest) – The request object. Request message for [DataprocMetastore.CreateBackup][google.cloud.metastore.v1beta.DataprocMetastore.CreateBackup].

  • parent (str) –

    Required. The relative resource name of the service in which to create a backup of the following form:

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

    This corresponds to the parent field on the request instance; if request is provided, this should not be set.

  • backup (google.cloud.metastore_v1beta.types.Backup) –

    Required. The backup to create. The name field is ignored. The ID of the created backup must be provided in the request’s backup_id field.

    This corresponds to the backup field on the request instance; if request is provided, this should not be set.

  • 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 backup_id field on the request instance; if request is provided, this should not be set.

  • 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

An object representing a long-running operation.

The result type for the operation will be google.cloud.metastore_v1beta.types.Backup The details of a backup resource.

Return type

google.api_core.operation_async.AsyncOperation

async create_metadata_import(request: Optional[google.cloud.metastore_v1beta.types.metastore.CreateMetadataImportRequest] = None, *, parent: Optional[str] = None, metadata_import: Optional[google.cloud.metastore_v1beta.types.metastore.MetadataImport] = None, metadata_import_id: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.api_core.operation_async.AsyncOperation[source]

Creates a new MetadataImport in a given project and location.

Parameters
  • request (google.cloud.metastore_v1beta.types.CreateMetadataImportRequest) – The request object. Request message for [DataprocMetastore.CreateMetadataImport][google.cloud.metastore.v1beta.DataprocMetastore.CreateMetadataImport].

  • parent (str) –

    Required. The relative resource name of the service in which to create a metastore import, in the following form:

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

    This corresponds to the parent field on the request instance; if request is provided, this should not be set.

  • metadata_import (google.cloud.metastore_v1beta.types.MetadataImport) –

    Required. The metadata import to create. The name field is ignored. The ID of the created metadata import must be provided in the request’s metadata_import_id field.

    This corresponds to the metadata_import field on the request instance; if request is provided, this should not be set.

  • 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 metadata_import_id field on the request instance; if request is provided, this should not be set.

  • 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

An object representing a long-running operation.

The result type for the operation will be google.cloud.metastore_v1beta.types.MetadataImport A metastore resource that imports metadata.

Return type

google.api_core.operation_async.AsyncOperation

async create_service(request: Optional[google.cloud.metastore_v1beta.types.metastore.CreateServiceRequest] = None, *, parent: Optional[str] = None, service: Optional[google.cloud.metastore_v1beta.types.metastore.Service] = None, service_id: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.api_core.operation_async.AsyncOperation[source]

Creates a metastore service in a project and location.

Parameters
  • request (google.cloud.metastore_v1beta.types.CreateServiceRequest) – The request object. Request message for [DataprocMetastore.CreateService][google.cloud.metastore.v1beta.DataprocMetastore.CreateService].

  • parent (str) –

    Required. The relative resource name of the location in which to create a metastore service, in the following form:

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

    This corresponds to the parent field on the request instance; if request is provided, this should not be set.

  • service (google.cloud.metastore_v1beta.types.Service) –

    Required. The Metastore service to create. The name field is ignored. The ID of the created metastore service must be provided in the request’s service_id field.

    This corresponds to the service field on the request instance; if request is provided, this should not be set.

  • 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 service_id field on the request instance; if request is provided, this should not be set.

  • 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

An object representing a long-running operation.

The result type for the operation will be google.cloud.metastore_v1beta.types.Service A managed metastore service that serves metadata queries.

Return type

google.api_core.operation_async.AsyncOperation

async delete_backup(request: Optional[google.cloud.metastore_v1beta.types.metastore.DeleteBackupRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.api_core.operation_async.AsyncOperation[source]

Deletes a single backup.

Parameters
  • request (google.cloud.metastore_v1beta.types.DeleteBackupRequest) – The request object. Request message for [DataprocMetastore.DeleteBackup][google.cloud.metastore.v1beta.DataprocMetastore.DeleteBackup].

  • name (str) –

    Required. The relative resource name of the backup to delete, in the following form:

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

    This corresponds to the name field on the request instance; if request is provided, this should not be set.

  • 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

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

Return type

google.api_core.operation_async.AsyncOperation

async delete_service(request: Optional[google.cloud.metastore_v1beta.types.metastore.DeleteServiceRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.api_core.operation_async.AsyncOperation[source]

Deletes a single service.

Parameters
  • request (google.cloud.metastore_v1beta.types.DeleteServiceRequest) – The request object. Request message for [DataprocMetastore.DeleteService][google.cloud.metastore.v1beta.DataprocMetastore.DeleteService].

  • name (str) –

    Required. The relative resource name of the metastore service to delete, in the following form:

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

    This corresponds to the name field on the request instance; if request is provided, this should not be set.

  • 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

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

Return type

google.api_core.operation_async.AsyncOperation

async export_metadata(request: Optional[google.cloud.metastore_v1beta.types.metastore.ExportMetadataRequest] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.api_core.operation_async.AsyncOperation[source]

Exports metadata from a service.

Parameters
Returns

An object representing a long-running operation.

The result type for the operation will be google.cloud.metastore_v1beta.types.MetadataExport The details of a metadata export operation.

Return type

google.api_core.operation_async.AsyncOperation

classmethod from_service_account_file(filename: str, *args, **kwargs)[source]
Creates an instance of this client using the provided credentials

file.

Parameters
  • filename (str) – The path to the service account private key json file.

  • args – Additional arguments to pass to the constructor.

  • kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

DataprocMetastoreAsyncClient

classmethod from_service_account_info(info: dict, *args, **kwargs)[source]
Creates an instance of this client using the provided credentials

info.

Parameters
  • info (dict) – The service account private key info.

  • args – Additional arguments to pass to the constructor.

  • kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

DataprocMetastoreAsyncClient

classmethod from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials

file.

Parameters
  • filename (str) – The path to the service account private key json file.

  • args – Additional arguments to pass to the constructor.

  • kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

DataprocMetastoreAsyncClient

async get_backup(request: Optional[google.cloud.metastore_v1beta.types.metastore.GetBackupRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.metastore_v1beta.types.metastore.Backup[source]

Gets details of a single backup.

Parameters
  • request (google.cloud.metastore_v1beta.types.GetBackupRequest) – The request object. Request message for [DataprocMetastore.GetBackup][google.cloud.metastore.v1beta.DataprocMetastore.GetBackup].

  • name (str) –

    Required. The relative resource name of the backup to retrieve, in the following form:

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

    This corresponds to the name field on the request instance; if request is provided, this should not be set.

  • 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

The details of a backup resource.

Return type

google.cloud.metastore_v1beta.types.Backup

async get_metadata_import(request: Optional[google.cloud.metastore_v1beta.types.metastore.GetMetadataImportRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.metastore_v1beta.types.metastore.MetadataImport[source]

Gets details of a single import.

Parameters
  • request (google.cloud.metastore_v1beta.types.GetMetadataImportRequest) – The request object. Request message for [DataprocMetastore.GetMetadataImport][google.cloud.metastore.v1beta.DataprocMetastore.GetMetadataImport].

  • name (str) –

    Required. The relative resource name of the metadata import to retrieve, in the following form:

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

    This corresponds to the name field on the request instance; if request is provided, this should not be set.

  • 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

A metastore resource that imports metadata.

Return type

google.cloud.metastore_v1beta.types.MetadataImport

async get_service(request: Optional[google.cloud.metastore_v1beta.types.metastore.GetServiceRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.metastore_v1beta.types.metastore.Service[source]

Gets the details of a single service.

Parameters
  • request (google.cloud.metastore_v1beta.types.GetServiceRequest) – The request object. Request message for [DataprocMetastore.GetService][google.cloud.metastore.v1beta.DataprocMetastore.GetService].

  • name (str) –

    Required. The relative resource name of the metastore service to retrieve, in the following form:

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

    This corresponds to the name field on the request instance; if request is provided, this should not be set.

  • 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

A managed metastore service that serves metadata queries.

Return type

google.cloud.metastore_v1beta.types.Service

get_transport_class()Type[google.cloud.metastore_v1beta.services.dataproc_metastore.transports.base.DataprocMetastoreTransport]

Returns an appropriate transport class.

Parameters

label – The name of the desired transport. If none is provided, then the first transport in the registry is used.

Returns

The transport class to use.

async list_backups(request: Optional[google.cloud.metastore_v1beta.types.metastore.ListBackupsRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.metastore_v1beta.services.dataproc_metastore.pagers.ListBackupsAsyncPager[source]

Lists backups in a service.

Parameters
  • request (google.cloud.metastore_v1beta.types.ListBackupsRequest) – The request object. Request message for [DataprocMetastore.ListBackups][google.cloud.metastore.v1beta.DataprocMetastore.ListBackups].

  • parent (str) –

    Required. The relative resource name of the service whose backups to list, in the following form:

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

    This corresponds to the parent field on the request instance; if request is provided, this should not be set.

  • 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

Response message for

[DataprocMetastore.ListBackups][google.cloud.metastore.v1beta.DataprocMetastore.ListBackups].

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.metastore_v1beta.services.dataproc_metastore.pagers.ListBackupsAsyncPager

async list_metadata_imports(request: Optional[google.cloud.metastore_v1beta.types.metastore.ListMetadataImportsRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.metastore_v1beta.services.dataproc_metastore.pagers.ListMetadataImportsAsyncPager[source]

Lists imports in a service.

Parameters
  • request (google.cloud.metastore_v1beta.types.ListMetadataImportsRequest) – The request object. Request message for [DataprocMetastore.ListMetadataImports][google.cloud.metastore.v1beta.DataprocMetastore.ListMetadataImports].

  • parent (str) –

    Required. The relative resource name of the service whose metadata imports to list, in the following form:

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

    This corresponds to the parent field on the request instance; if request is provided, this should not be set.

  • 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

Response message for

[DataprocMetastore.ListMetadataImports][google.cloud.metastore.v1beta.DataprocMetastore.ListMetadataImports].

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.metastore_v1beta.services.dataproc_metastore.pagers.ListMetadataImportsAsyncPager

async list_services(request: Optional[google.cloud.metastore_v1beta.types.metastore.ListServicesRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.metastore_v1beta.services.dataproc_metastore.pagers.ListServicesAsyncPager[source]

Lists services in a project and location.

Parameters
  • request (google.cloud.metastore_v1beta.types.ListServicesRequest) – The request object. Request message for [DataprocMetastore.ListServices][google.cloud.metastore.v1beta.DataprocMetastore.ListServices].

  • parent (str) –

    Required. The relative resource name of the location of metastore services to list, in the following form:

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

    This corresponds to the parent field on the request instance; if request is provided, this should not be set.

  • 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

Response message for

[DataprocMetastore.ListServices][google.cloud.metastore.v1beta.DataprocMetastore.ListServices].

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.metastore_v1beta.services.dataproc_metastore.pagers.ListServicesAsyncPager

static metadata_import_path(project: str, location: str, service: str, metadata_import: str)str

Returns a fully-qualified metadata_import string.

static network_path(project: str, network: str)str

Returns a fully-qualified network string.

static parse_backup_path(path: str)Dict[str, str]

Parses a backup path into its component segments.

static parse_common_billing_account_path(path: str)Dict[str, str]

Parse a billing_account path into its component segments.

static parse_common_folder_path(path: str)Dict[str, str]

Parse a folder path into its component segments.

static parse_common_location_path(path: str)Dict[str, str]

Parse a location path into its component segments.

static parse_common_organization_path(path: str)Dict[str, str]

Parse a organization path into its component segments.

static parse_common_project_path(path: str)Dict[str, str]

Parse a project path into its component segments.

static parse_metadata_import_path(path: str)Dict[str, str]

Parses a metadata_import path into its component segments.

static parse_network_path(path: str)Dict[str, str]

Parses a network path into its component segments.

static parse_service_path(path: str)Dict[str, str]

Parses a service path into its component segments.

async restore_service(request: Optional[google.cloud.metastore_v1beta.types.metastore.RestoreServiceRequest] = None, *, service: Optional[str] = None, backup: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.api_core.operation_async.AsyncOperation[source]

Restores a service from a backup.

Parameters
  • request (google.cloud.metastore_v1beta.types.RestoreServiceRequest) – 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:

    projects/{project_id}/locations/{location_id}/services/{service_id}

    This corresponds to the service field on the request instance; if request is provided, this should not be set.

  • backup (str) –

    Required. The relative resource name of the metastore service backup to restore from, in the following form:

    projects/{project_id}/locations/{location_id}/services/{service_id}/backups/{backup_id}

    This corresponds to the backup field on the request instance; if request is provided, this should not be set.

  • 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

An object representing a long-running operation.

The result type for the operation will be google.cloud.metastore_v1beta.types.Restore The details of a metadata restore operation.

Return type

google.api_core.operation_async.AsyncOperation

static service_path(project: str, location: str, service: str)str

Returns a fully-qualified service string.

property transport: google.cloud.metastore_v1beta.services.dataproc_metastore.transports.base.DataprocMetastoreTransport

Returns the transport used by the client instance.

Returns

The transport used by the client instance.

Return type

DataprocMetastoreTransport

async update_metadata_import(request: Optional[google.cloud.metastore_v1beta.types.metastore.UpdateMetadataImportRequest] = None, *, metadata_import: Optional[google.cloud.metastore_v1beta.types.metastore.MetadataImport] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.api_core.operation_async.AsyncOperation[source]

Updates a single import. Only the description field of MetadataImport is supported to be updated.

Parameters
  • request (google.cloud.metastore_v1beta.types.UpdateMetadataImportRequest) – The request object. Request message for [DataprocMetastore.UpdateMetadataImport][google.cloud.metastore.v1beta.DataprocMetastore.UpdateMetadataImport].

  • metadata_import (google.cloud.metastore_v1beta.types.MetadataImport) –

    Required. The metadata import to update. The server only merges fields in the import if they are specified in update_mask.

    The metadata import’s name field is used to identify the metastore import to be updated.

    This corresponds to the metadata_import field on the request instance; if request is provided, this should not be set.

  • 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 update_mask are relative to the resource (not to the full request). A field is overwritten if it is in the mask.

    This corresponds to the update_mask field on the request instance; if request is provided, this should not be set.

  • 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

An object representing a long-running operation.

The result type for the operation will be google.cloud.metastore_v1beta.types.MetadataImport A metastore resource that imports metadata.

Return type

google.api_core.operation_async.AsyncOperation

async update_service(request: Optional[google.cloud.metastore_v1beta.types.metastore.UpdateServiceRequest] = None, *, service: Optional[google.cloud.metastore_v1beta.types.metastore.Service] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.api_core.operation_async.AsyncOperation[source]

Updates the parameters of a single service.

Parameters
  • request (google.cloud.metastore_v1beta.types.UpdateServiceRequest) – The request object. Request message for [DataprocMetastore.UpdateService][google.cloud.metastore.v1beta.DataprocMetastore.UpdateService].

  • service (google.cloud.metastore_v1beta.types.Service) –

    Required. The metastore service to update. The server only merges fields in the service if they are specified in update_mask.

    The metastore service’s name field is used to identify the metastore service to be updated.

    This corresponds to the service field on the request instance; if request is provided, this should not be set.

  • 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 update_mask are relative to the resource (not to the full request). A field is overwritten if it is in the mask.

    This corresponds to the update_mask field on the request instance; if request is provided, this should not be set.

  • 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

An object representing a long-running operation.

The result type for the operation will be google.cloud.metastore_v1beta.types.Service A managed metastore service that serves metadata queries.

Return type

google.api_core.operation_async.AsyncOperation

class google.cloud.metastore_v1beta.services.dataproc_metastore.DataprocMetastoreClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.metastore_v1beta.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>)[source]

Configures and manages metastore services. Metastore services are fully managed, highly available, auto-scaled, auto-healing, 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}.

Instantiates the dataproc metastore client.

Parameters
  • 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 transport instance is provided. (1) The api_endpoint property can be used to override the default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT environment variable can also be used to override the endpoint: “always” (always use the default mTLS endpoint), “never” (always use the default regular endpoint) and “auto” (auto switch to the default mTLS endpoint if client certificate is present, this is the default value). However, the api_endpoint property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is “true”, then the client_cert_source property can be used to provide client certificate for mutual TLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is “false” or not set, no client certificate will be used.

  • 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 None, then default info will be used. Generally, you only need to set this if you’re developing your own client library.

Raises

google.auth.exceptions.MutualTLSChannelError – If mutual TLS transport creation failed for any reason.

__exit__(type, value, traceback)[source]

Releases underlying transport’s resources.

Warning

ONLY use as a context manager if the transport is NOT shared with other clients! Exiting the with block will CLOSE the transport and may cause errors in other clients!

static backup_path(project: str, location: str, service: str, backup: str)str[source]

Returns a fully-qualified backup string.

static common_billing_account_path(billing_account: str)str[source]

Returns a fully-qualified billing_account string.

static common_folder_path(folder: str)str[source]

Returns a fully-qualified folder string.

static common_location_path(project: str, location: str)str[source]

Returns a fully-qualified location string.

static common_organization_path(organization: str)str[source]

Returns a fully-qualified organization string.

static common_project_path(project: str)str[source]

Returns a fully-qualified project string.

create_backup(request: Optional[Union[google.cloud.metastore_v1beta.types.metastore.CreateBackupRequest, dict]] = None, *, parent: Optional[str] = None, backup: Optional[google.cloud.metastore_v1beta.types.metastore.Backup] = None, backup_id: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.api_core.operation.Operation[source]

Creates a new Backup in a given project and location.

Parameters
  • request (Union[google.cloud.metastore_v1beta.types.CreateBackupRequest, dict]) – The request object. Request message for [DataprocMetastore.CreateBackup][google.cloud.metastore.v1beta.DataprocMetastore.CreateBackup].

  • parent (str) –

    Required. The relative resource name of the service in which to create a backup of the following form:

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

    This corresponds to the parent field on the request instance; if request is provided, this should not be set.

  • backup (google.cloud.metastore_v1beta.types.Backup) –

    Required. The backup to create. The name field is ignored. The ID of the created backup must be provided in the request’s backup_id field.

    This corresponds to the backup field on the request instance; if request is provided, this should not be set.

  • 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 backup_id field on the request instance; if request is provided, this should not be set.

  • 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

An object representing a long-running operation.

The result type for the operation will be google.cloud.metastore_v1beta.types.Backup The details of a backup resource.

Return type

google.api_core.operation.Operation

create_metadata_import(request: Optional[Union[google.cloud.metastore_v1beta.types.metastore.CreateMetadataImportRequest, dict]] = None, *, parent: Optional[str] = None, metadata_import: Optional[google.cloud.metastore_v1beta.types.metastore.MetadataImport] = None, metadata_import_id: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.api_core.operation.Operation[source]

Creates a new MetadataImport in a given project and location.

Parameters
  • request (Union[google.cloud.metastore_v1beta.types.CreateMetadataImportRequest, dict]) – The request object. Request message for [DataprocMetastore.CreateMetadataImport][google.cloud.metastore.v1beta.DataprocMetastore.CreateMetadataImport].

  • parent (str) –

    Required. The relative resource name of the service in which to create a metastore import, in the following form:

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

    This corresponds to the parent field on the request instance; if request is provided, this should not be set.

  • metadata_import (google.cloud.metastore_v1beta.types.MetadataImport) –

    Required. The metadata import to create. The name field is ignored. The ID of the created metadata import must be provided in the request’s metadata_import_id field.

    This corresponds to the metadata_import field on the request instance; if request is provided, this should not be set.

  • 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 metadata_import_id field on the request instance; if request is provided, this should not be set.

  • 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

An object representing a long-running operation.

The result type for the operation will be google.cloud.metastore_v1beta.types.MetadataImport A metastore resource that imports metadata.

Return type

google.api_core.operation.Operation

create_service(request: Optional[Union[google.cloud.metastore_v1beta.types.metastore.CreateServiceRequest, dict]] = None, *, parent: Optional[str] = None, service: Optional[google.cloud.metastore_v1beta.types.metastore.Service] = None, service_id: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.api_core.operation.Operation[source]

Creates a metastore service in a project and location.

Parameters
  • request (Union[google.cloud.metastore_v1beta.types.CreateServiceRequest, dict]) – The request object. Request message for [DataprocMetastore.CreateService][google.cloud.metastore.v1beta.DataprocMetastore.CreateService].

  • parent (str) –

    Required. The relative resource name of the location in which to create a metastore service, in the following form:

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

    This corresponds to the parent field on the request instance; if request is provided, this should not be set.

  • service (google.cloud.metastore_v1beta.types.Service) –

    Required. The Metastore service to create. The name field is ignored. The ID of the created metastore service must be provided in the request’s service_id field.

    This corresponds to the service field on the request instance; if request is provided, this should not be set.

  • 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 service_id field on the request instance; if request is provided, this should not be set.

  • 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

An object representing a long-running operation.

The result type for the operation will be google.cloud.metastore_v1beta.types.Service A managed metastore service that serves metadata queries.

Return type

google.api_core.operation.Operation

delete_backup(request: Optional[Union[google.cloud.metastore_v1beta.types.metastore.DeleteBackupRequest, dict]] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.api_core.operation.Operation[source]

Deletes a single backup.

Parameters
  • request (Union[google.cloud.metastore_v1beta.types.DeleteBackupRequest, dict]) – The request object. Request message for [DataprocMetastore.DeleteBackup][google.cloud.metastore.v1beta.DataprocMetastore.DeleteBackup].

  • name (str) –

    Required. The relative resource name of the backup to delete, in the following form:

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

    This corresponds to the name field on the request instance; if request is provided, this should not be set.

  • 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

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

Return type

google.api_core.operation.Operation

delete_service(request: Optional[Union[google.cloud.metastore_v1beta.types.metastore.DeleteServiceRequest, dict]] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.api_core.operation.Operation[source]

Deletes a single service.

Parameters
  • request (Union[google.cloud.metastore_v1beta.types.DeleteServiceRequest, dict]) – The request object. Request message for [DataprocMetastore.DeleteService][google.cloud.metastore.v1beta.DataprocMetastore.DeleteService].

  • name (str) –

    Required. The relative resource name of the metastore service to delete, in the following form:

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

    This corresponds to the name field on the request instance; if request is provided, this should not be set.

  • 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

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

Return type

google.api_core.operation.Operation

export_metadata(request: Optional[Union[google.cloud.metastore_v1beta.types.metastore.ExportMetadataRequest, dict]] = None, *, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.api_core.operation.Operation[source]

Exports metadata from a service.

Parameters
Returns

An object representing a long-running operation.

The result type for the operation will be google.cloud.metastore_v1beta.types.MetadataExport The details of a metadata export operation.

Return type

google.api_core.operation.Operation

classmethod from_service_account_file(filename: str, *args, **kwargs)[source]
Creates an instance of this client using the provided credentials

file.

Parameters
  • filename (str) – The path to the service account private key json file.

  • args – Additional arguments to pass to the constructor.

  • kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

DataprocMetastoreClient

classmethod from_service_account_info(info: dict, *args, **kwargs)[source]
Creates an instance of this client using the provided credentials

info.

Parameters
  • info (dict) – The service account private key info.

  • args – Additional arguments to pass to the constructor.

  • kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

DataprocMetastoreClient

classmethod from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials

file.

Parameters
  • filename (str) – The path to the service account private key json file.

  • args – Additional arguments to pass to the constructor.

  • kwargs – Additional arguments to pass to the constructor.

Returns

The constructed client.

Return type

DataprocMetastoreClient

get_backup(request: Optional[Union[google.cloud.metastore_v1beta.types.metastore.GetBackupRequest, dict]] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.metastore_v1beta.types.metastore.Backup[source]

Gets details of a single backup.

Parameters
  • request (Union[google.cloud.metastore_v1beta.types.GetBackupRequest, dict]) – The request object. Request message for [DataprocMetastore.GetBackup][google.cloud.metastore.v1beta.DataprocMetastore.GetBackup].

  • name (str) –

    Required. The relative resource name of the backup to retrieve, in the following form:

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

    This corresponds to the name field on the request instance; if request is provided, this should not be set.

  • 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

The details of a backup resource.

Return type

google.cloud.metastore_v1beta.types.Backup

get_metadata_import(request: Optional[Union[google.cloud.metastore_v1beta.types.metastore.GetMetadataImportRequest, dict]] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.metastore_v1beta.types.metastore.MetadataImport[source]

Gets details of a single import.

Parameters
  • request (Union[google.cloud.metastore_v1beta.types.GetMetadataImportRequest, dict]) – The request object. Request message for [DataprocMetastore.GetMetadataImport][google.cloud.metastore.v1beta.DataprocMetastore.GetMetadataImport].

  • name (str) –

    Required. The relative resource name of the metadata import to retrieve, in the following form:

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

    This corresponds to the name field on the request instance; if request is provided, this should not be set.

  • 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

A metastore resource that imports metadata.

Return type

google.cloud.metastore_v1beta.types.MetadataImport

get_service(request: Optional[Union[google.cloud.metastore_v1beta.types.metastore.GetServiceRequest, dict]] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.metastore_v1beta.types.metastore.Service[source]

Gets the details of a single service.

Parameters
  • request (Union[google.cloud.metastore_v1beta.types.GetServiceRequest, dict]) – The request object. Request message for [DataprocMetastore.GetService][google.cloud.metastore.v1beta.DataprocMetastore.GetService].

  • name (str) –

    Required. The relative resource name of the metastore service to retrieve, in the following form:

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

    This corresponds to the name field on the request instance; if request is provided, this should not be set.

  • 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

A managed metastore service that serves metadata queries.

Return type

google.cloud.metastore_v1beta.types.Service

list_backups(request: Optional[Union[google.cloud.metastore_v1beta.types.metastore.ListBackupsRequest, dict]] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.metastore_v1beta.services.dataproc_metastore.pagers.ListBackupsPager[source]

Lists backups in a service.

Parameters
  • request (Union[google.cloud.metastore_v1beta.types.ListBackupsRequest, dict]) – The request object. Request message for [DataprocMetastore.ListBackups][google.cloud.metastore.v1beta.DataprocMetastore.ListBackups].

  • parent (str) –

    Required. The relative resource name of the service whose backups to list, in the following form:

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

    This corresponds to the parent field on the request instance; if request is provided, this should not be set.

  • 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

Response message for

[DataprocMetastore.ListBackups][google.cloud.metastore.v1beta.DataprocMetastore.ListBackups].

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.metastore_v1beta.services.dataproc_metastore.pagers.ListBackupsPager

list_metadata_imports(request: Optional[Union[google.cloud.metastore_v1beta.types.metastore.ListMetadataImportsRequest, dict]] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.metastore_v1beta.services.dataproc_metastore.pagers.ListMetadataImportsPager[source]

Lists imports in a service.

Parameters
  • request (Union[google.cloud.metastore_v1beta.types.ListMetadataImportsRequest, dict]) – The request object. Request message for [DataprocMetastore.ListMetadataImports][google.cloud.metastore.v1beta.DataprocMetastore.ListMetadataImports].

  • parent (str) –

    Required. The relative resource name of the service whose metadata imports to list, in the following form:

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

    This corresponds to the parent field on the request instance; if request is provided, this should not be set.

  • 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

Response message for

[DataprocMetastore.ListMetadataImports][google.cloud.metastore.v1beta.DataprocMetastore.ListMetadataImports].

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.metastore_v1beta.services.dataproc_metastore.pagers.ListMetadataImportsPager

list_services(request: Optional[Union[google.cloud.metastore_v1beta.types.metastore.ListServicesRequest, dict]] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.cloud.metastore_v1beta.services.dataproc_metastore.pagers.ListServicesPager[source]

Lists services in a project and location.

Parameters
  • request (Union[google.cloud.metastore_v1beta.types.ListServicesRequest, dict]) – The request object. Request message for [DataprocMetastore.ListServices][google.cloud.metastore.v1beta.DataprocMetastore.ListServices].

  • parent (str) –

    Required. The relative resource name of the location of metastore services to list, in the following form:

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

    This corresponds to the parent field on the request instance; if request is provided, this should not be set.

  • 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

Response message for

[DataprocMetastore.ListServices][google.cloud.metastore.v1beta.DataprocMetastore.ListServices].

Iterating over this object will yield results and resolve additional pages automatically.

Return type

google.cloud.metastore_v1beta.services.dataproc_metastore.pagers.ListServicesPager

static metadata_import_path(project: str, location: str, service: str, metadata_import: str)str[source]

Returns a fully-qualified metadata_import string.

static network_path(project: str, network: str)str[source]

Returns a fully-qualified network string.

static parse_backup_path(path: str)Dict[str, str][source]

Parses a backup path into its component segments.

static parse_common_billing_account_path(path: str)Dict[str, str][source]

Parse a billing_account path into its component segments.

static parse_common_folder_path(path: str)Dict[str, str][source]

Parse a folder path into its component segments.

static parse_common_location_path(path: str)Dict[str, str][source]

Parse a location path into its component segments.

static parse_common_organization_path(path: str)Dict[str, str][source]

Parse a organization path into its component segments.

static parse_common_project_path(path: str)Dict[str, str][source]

Parse a project path into its component segments.

static parse_metadata_import_path(path: str)Dict[str, str][source]

Parses a metadata_import path into its component segments.

static parse_network_path(path: str)Dict[str, str][source]

Parses a network path into its component segments.

static parse_service_path(path: str)Dict[str, str][source]

Parses a service path into its component segments.

restore_service(request: Optional[Union[google.cloud.metastore_v1beta.types.metastore.RestoreServiceRequest, dict]] = None, *, service: Optional[str] = None, backup: Optional[str] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.api_core.operation.Operation[source]

Restores a service from a backup.

Parameters
  • request (Union[google.cloud.metastore_v1beta.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:

    projects/{project_id}/locations/{location_id}/services/{service_id}

    This corresponds to the service field on the request instance; if request is provided, this should not be set.

  • backup (str) –

    Required. The relative resource name of the metastore service backup to restore from, in the following form:

    projects/{project_id}/locations/{location_id}/services/{service_id}/backups/{backup_id}

    This corresponds to the backup field on the request instance; if request is provided, this should not be set.

  • 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

An object representing a long-running operation.

The result type for the operation will be google.cloud.metastore_v1beta.types.Restore The details of a metadata restore operation.

Return type

google.api_core.operation.Operation

static service_path(project: str, location: str, service: str)str[source]

Returns a fully-qualified service string.

property transport: google.cloud.metastore_v1beta.services.dataproc_metastore.transports.base.DataprocMetastoreTransport

Returns the transport used by the client instance.

Returns

The transport used by the client

instance.

Return type

DataprocMetastoreTransport

update_metadata_import(request: Optional[Union[google.cloud.metastore_v1beta.types.metastore.UpdateMetadataImportRequest, dict]] = None, *, metadata_import: Optional[google.cloud.metastore_v1beta.types.metastore.MetadataImport] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.api_core.operation.Operation[source]

Updates a single import. Only the description field of MetadataImport is supported to be updated.

Parameters
  • request (Union[google.cloud.metastore_v1beta.types.UpdateMetadataImportRequest, dict]) – The request object. Request message for [DataprocMetastore.UpdateMetadataImport][google.cloud.metastore.v1beta.DataprocMetastore.UpdateMetadataImport].

  • metadata_import (google.cloud.metastore_v1beta.types.MetadataImport) –

    Required. The metadata import to update. The server only merges fields in the import if they are specified in update_mask.

    The metadata import’s name field is used to identify the metastore import to be updated.

    This corresponds to the metadata_import field on the request instance; if request is provided, this should not be set.

  • 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 update_mask are relative to the resource (not to the full request). A field is overwritten if it is in the mask.

    This corresponds to the update_mask field on the request instance; if request is provided, this should not be set.

  • 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

An object representing a long-running operation.

The result type for the operation will be google.cloud.metastore_v1beta.types.MetadataImport A metastore resource that imports metadata.

Return type

google.api_core.operation.Operation

update_service(request: Optional[Union[google.cloud.metastore_v1beta.types.metastore.UpdateServiceRequest, dict]] = None, *, service: Optional[google.cloud.metastore_v1beta.types.metastore.Service] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: google.api_core.retry.Retry = <object object>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())google.api_core.operation.Operation[source]

Updates the parameters of a single service.

Parameters
  • request (Union[google.cloud.metastore_v1beta.types.UpdateServiceRequest, dict]) – The request object. Request message for [DataprocMetastore.UpdateService][google.cloud.metastore.v1beta.DataprocMetastore.UpdateService].

  • service (google.cloud.metastore_v1beta.types.Service) –

    Required. The metastore service to update. The server only merges fields in the service if they are specified in update_mask.

    The metastore service’s name field is used to identify the metastore service to be updated.

    This corresponds to the service field on the request instance; if request is provided, this should not be set.

  • 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 update_mask are relative to the resource (not to the full request). A field is overwritten if it is in the mask.

    This corresponds to the update_mask field on the request instance; if request is provided, this should not be set.

  • 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

An object representing a long-running operation.

The result type for the operation will be google.cloud.metastore_v1beta.types.Service A managed metastore service that serves metadata queries.

Return type

google.api_core.operation.Operation

class google.cloud.metastore_v1beta.services.dataproc_metastore.pagers.ListBackupsAsyncPager(method: Callable[[...], Awaitable[google.cloud.metastore_v1beta.types.metastore.ListBackupsResponse]], request: google.cloud.metastore_v1beta.types.metastore.ListBackupsRequest, response: google.cloud.metastore_v1beta.types.metastore.ListBackupsResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_backups requests.

This class thinly wraps an initial google.cloud.metastore_v1beta.types.ListBackupsResponse object, and provides an __aiter__ method to iterate through its backups field.

If there are more pages, the __aiter__ method will make additional ListBackups requests and continue to iterate through the backups field on the corresponding responses.

All the usual google.cloud.metastore_v1beta.types.ListBackupsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiates the pager.

Parameters
class google.cloud.metastore_v1beta.services.dataproc_metastore.pagers.ListBackupsPager(method: Callable[[...], google.cloud.metastore_v1beta.types.metastore.ListBackupsResponse], request: google.cloud.metastore_v1beta.types.metastore.ListBackupsRequest, response: google.cloud.metastore_v1beta.types.metastore.ListBackupsResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_backups requests.

This class thinly wraps an initial google.cloud.metastore_v1beta.types.ListBackupsResponse object, and provides an __iter__ method to iterate through its backups field.

If there are more pages, the __iter__ method will make additional ListBackups requests and continue to iterate through the backups field on the corresponding responses.

All the usual google.cloud.metastore_v1beta.types.ListBackupsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters
class google.cloud.metastore_v1beta.services.dataproc_metastore.pagers.ListMetadataImportsAsyncPager(method: Callable[[...], Awaitable[google.cloud.metastore_v1beta.types.metastore.ListMetadataImportsResponse]], request: google.cloud.metastore_v1beta.types.metastore.ListMetadataImportsRequest, response: google.cloud.metastore_v1beta.types.metastore.ListMetadataImportsResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_metadata_imports requests.

This class thinly wraps an initial google.cloud.metastore_v1beta.types.ListMetadataImportsResponse object, and provides an __aiter__ method to iterate through its metadata_imports field.

If there are more pages, the __aiter__ method will make additional ListMetadataImports requests and continue to iterate through the metadata_imports field on the corresponding responses.

All the usual google.cloud.metastore_v1beta.types.ListMetadataImportsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiates the pager.

Parameters
class google.cloud.metastore_v1beta.services.dataproc_metastore.pagers.ListMetadataImportsPager(method: Callable[[...], google.cloud.metastore_v1beta.types.metastore.ListMetadataImportsResponse], request: google.cloud.metastore_v1beta.types.metastore.ListMetadataImportsRequest, response: google.cloud.metastore_v1beta.types.metastore.ListMetadataImportsResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_metadata_imports requests.

This class thinly wraps an initial google.cloud.metastore_v1beta.types.ListMetadataImportsResponse object, and provides an __iter__ method to iterate through its metadata_imports field.

If there are more pages, the __iter__ method will make additional ListMetadataImports requests and continue to iterate through the metadata_imports field on the corresponding responses.

All the usual google.cloud.metastore_v1beta.types.ListMetadataImportsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters
class google.cloud.metastore_v1beta.services.dataproc_metastore.pagers.ListServicesAsyncPager(method: Callable[[...], Awaitable[google.cloud.metastore_v1beta.types.metastore.ListServicesResponse]], request: google.cloud.metastore_v1beta.types.metastore.ListServicesRequest, response: google.cloud.metastore_v1beta.types.metastore.ListServicesResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_services requests.

This class thinly wraps an initial google.cloud.metastore_v1beta.types.ListServicesResponse object, and provides an __aiter__ method to iterate through its services field.

If there are more pages, the __aiter__ method will make additional ListServices requests and continue to iterate through the services field on the corresponding responses.

All the usual google.cloud.metastore_v1beta.types.ListServicesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiates the pager.

Parameters
class google.cloud.metastore_v1beta.services.dataproc_metastore.pagers.ListServicesPager(method: Callable[[...], google.cloud.metastore_v1beta.types.metastore.ListServicesResponse], request: google.cloud.metastore_v1beta.types.metastore.ListServicesRequest, response: google.cloud.metastore_v1beta.types.metastore.ListServicesResponse, *, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_services requests.

This class thinly wraps an initial google.cloud.metastore_v1beta.types.ListServicesResponse object, and provides an __iter__ method to iterate through its services field.

If there are more pages, the __iter__ method will make additional ListServices requests and continue to iterate through the services field on the corresponding responses.

All the usual google.cloud.metastore_v1beta.types.ListServicesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Instantiate the pager.

Parameters