Class DataprocMetastoreAsyncClient (1.5.1)

DataprocMetastoreAsyncClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Union[str, google.cloud.metastore_v1.services.dataproc_metastore.transports.base.DataprocMetastoreTransport] = 'grpc_asyncio', 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 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}.

Properties

transport

Returns the transport used by the client instance.

Returns
Type	Description
`DataprocMetastoreTransport`	The transport used by the client instance.

Methods

DataprocMetastoreAsyncClient

DataprocMetastoreAsyncClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Union[str, google.cloud.metastore_v1.services.dataproc_metastore.transports.base.DataprocMetastoreTransport] = 'grpc_asyncio', 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`	`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.

Exceptions
Type	Description
`google.auth.exceptions.MutualTlsChannelError`	If mutual TLS transport creation failed for any reason.

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: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Creates a new backup in a given project and location.

from google.cloud import metastore_v1

async def sample_create_backup():
    # Create a client
    client = metastore_v1.DataprocMetastoreAsyncClient()

    # Initialize request argument(s)
    request = metastore_v1.CreateBackupRequest(
        parent="parent_value",
        backup_id="backup_id_value",
    )

    # Make the request
    operation = client.create_backup(request=request)

    print("Waiting for operation to complete...")

    response = await operation.result()

    # Handle the response
    print(response)

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: `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`	`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
Type	Description
`google.api_core.operation_async.AsyncOperation`	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: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Creates a new MetadataImport in a given project and location.

from google.cloud import metastore_v1

async def sample_create_metadata_import():
    # Create a client
    client = metastore_v1.DataprocMetastoreAsyncClient()

    # Initialize request argument(s)
    request = metastore_v1.CreateMetadataImportRequest(
        parent="parent_value",
        metadata_import_id="metadata_import_id_value",
    )

    # Make the request
    operation = client.create_metadata_import(request=request)

    print("Waiting for operation to complete...")

    response = await operation.result()

    # Handle the response
    print(response)

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: `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`	`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
Type	Description
`google.api_core.operation_async.AsyncOperation`	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: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Creates a metastore service in a project and location.

from google.cloud import metastore_v1

async def sample_create_service():
    # Create a client
    client = metastore_v1.DataprocMetastoreAsyncClient()

    # Initialize request argument(s)
    request = metastore_v1.CreateServiceRequest(
        parent="parent_value",
        service_id="service_id_value",
    )

    # Make the request
    operation = client.create_service(request=request)

    print("Waiting for operation to complete...")

    response = await operation.result()

    # Handle the response
    print(response)

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: `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`	`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
Type	Description
`google.api_core.operation_async.AsyncOperation`	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: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Deletes a single backup.

from google.cloud import metastore_v1

async def sample_delete_backup():
    # Create a client
    client = metastore_v1.DataprocMetastoreAsyncClient()

    # Initialize request argument(s)
    request = metastore_v1.DeleteBackupRequest(
        name="name_value",
    )

    # Make the request
    operation = client.delete_backup(request=request)

    print("Waiting for operation to complete...")

    response = await operation.result()

    # Handle the response
    print(response)

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: `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

Type Description

google.api_core.operation_async.AsyncOperation 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: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Deletes a single service.

from google.cloud import metastore_v1

async def sample_delete_service():
    # Create a client
    client = metastore_v1.DataprocMetastoreAsyncClient()

    # Initialize request argument(s)
    request = metastore_v1.DeleteServiceRequest(
        name="name_value",
    )

    # Make the request
    operation = client.delete_service(request=request)

    print("Waiting for operation to complete...")

    response = await operation.result()

    # Handle the response
    print(response)

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: `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

Type Description

export_metadata

export_metadata(request: Optional[Union[google.cloud.metastore_v1.types.metastore.ExportMetadataRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Exports metadata from a service.

from google.cloud import metastore_v1

async def sample_export_metadata():
    # Create a client
    client = metastore_v1.DataprocMetastoreAsyncClient()

    # Initialize request argument(s)
    request = metastore_v1.ExportMetadataRequest(
        destination_gcs_folder="destination_gcs_folder_value",
        service="service_value",
    )

    # Make the request
    operation = client.export_metadata(request=request)

    print("Waiting for operation to complete...")

    response = await operation.result()

    # Handle the response
    print(response)

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_async.AsyncOperation`	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
`DataprocMetastoreAsyncClient`	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
`DataprocMetastoreAsyncClient`	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
`DataprocMetastoreAsyncClient`	The constructed client.

get_backup

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

Gets details of a single backup.

from google.cloud import metastore_v1

async def sample_get_backup():
    # Create a client
    client = metastore_v1.DataprocMetastoreAsyncClient()

    # Initialize request argument(s)
    request = metastore_v1.GetBackupRequest(
        name="name_value",
    )

    # Make the request
    response = await client.get_backup(request=request)

    # Handle the response
    print(response)

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: `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
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: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Gets details of a single import.

from google.cloud import metastore_v1

async def sample_get_metadata_import():
    # Create a client
    client = metastore_v1.DataprocMetastoreAsyncClient()

    # Initialize request argument(s)
    request = metastore_v1.GetMetadataImportRequest(
        name="name_value",
    )

    # Make the request
    response = await client.get_metadata_import(request=request)

    # Handle the response
    print(response)

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: `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
Type	Description
`google.cloud.metastore_v1.types.MetadataImport`	A metastore resource that imports metadata.

get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: Optional[google.api_core.client_options.ClientOptions] = None,
)

Return the API endpoint and client cert source for mutual TLS.

The client cert source is determined in the following order: (1) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is not "true", the client cert source is None. (2) if client_options.client_cert_source is provided, use the provided one; if the default client cert source exists, use the default one; otherwise the client cert source is None.

The API endpoint is determined in the following order: (1) if client_options.api_endpoint if provided, use the provided one. (2) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "always", use the default mTLS endpoint; if the environment variabel is "never", use the default API endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise use the default API endpoint.

More details can be found at https://google.aip.dev/auth/4114.

Parameter
Name	Description
`client_options`	`google.api_core.client_options.ClientOptions` Custom options for the client. Only the `api_endpoint` and `client_cert_source` properties may be used in this method.

Exceptions
Type	Description
`google.auth.exceptions.MutualTLSChannelError`	If any errors happen.

Returns
Type	Description
`Tuple[str, Callable[[], Tuple[bytes, bytes]]]`	returns the API endpoint and the client cert source to use.

get_service

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

Gets the details of a single service.

from google.cloud import metastore_v1

async def sample_get_service():
    # Create a client
    client = metastore_v1.DataprocMetastoreAsyncClient()

    # Initialize request argument(s)
    request = metastore_v1.GetServiceRequest(
        name="name_value",
    )

    # Make the request
    response = await client.get_service(request=request)

    # Handle the response
    print(response)

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: `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
Type	Description
`google.cloud.metastore_v1.types.Service`	A managed metastore service that serves metadata queries.

get_transport_class

get_transport_class()

Returns an appropriate transport class.

list_backups

list_backups(request: Optional[Union[google.cloud.metastore_v1.types.metastore.ListBackupsRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Lists backups in a service.

from google.cloud import metastore_v1

async def sample_list_backups():
    # Create a client
    client = metastore_v1.DataprocMetastoreAsyncClient()

    # Initialize request argument(s)
    request = metastore_v1.ListBackupsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_backups(request=request)

    # Handle the response
    async for response in page_result:
        print(response)

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: `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
Type	Description
`google.cloud.metastore_v1.services.dataproc_metastore.pagers.ListBackupsAsyncPager`	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: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Lists imports in a service.

from google.cloud import metastore_v1

async def sample_list_metadata_imports():
    # Create a client
    client = metastore_v1.DataprocMetastoreAsyncClient()

    # Initialize request argument(s)
    request = metastore_v1.ListMetadataImportsRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_metadata_imports(request=request)

    # Handle the response
    async for response in page_result:
        print(response)

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: `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
Type	Description
`google.cloud.metastore_v1.services.dataproc_metastore.pagers.ListMetadataImportsAsyncPager`	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: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Lists services in a project and location.

from google.cloud import metastore_v1

async def sample_list_services():
    # Create a client
    client = metastore_v1.DataprocMetastoreAsyncClient()

    # Initialize request argument(s)
    request = metastore_v1.ListServicesRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_services(request=request)

    # Handle the response
    async for response in page_result:
        print(response)

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: `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
Type	Description
`google.cloud.metastore_v1.services.dataproc_metastore.pagers.ListServicesAsyncPager`	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: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Restores a service from a backup.

from google.cloud import metastore_v1

async def sample_restore_service():
    # Create a client
    client = metastore_v1.DataprocMetastoreAsyncClient()

    # Initialize request argument(s)
    request = metastore_v1.RestoreServiceRequest(
        service="service_value",
        backup="backup_value",
    )

    # Make the request
    operation = client.restore_service(request=request)

    print("Waiting for operation to complete...")

    response = await operation.result()

    # Handle the response
    print(response)

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: `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
Type	Description
`google.api_core.operation_async.AsyncOperation`	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: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_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.

from google.cloud import metastore_v1

async def sample_update_metadata_import():
    # Create a client
    client = metastore_v1.DataprocMetastoreAsyncClient()

    # Initialize request argument(s)
    request = metastore_v1.UpdateMetadataImportRequest(
    )

    # Make the request
    operation = client.update_metadata_import(request=request)

    print("Waiting for operation to complete...")

    response = await operation.result()

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Union[google.cloud.metastore_v1.types.UpdateMetadataImportRequest, dict]` The request object. Request message for DataprocMetastore.UpdateMetadataImport.
`metadata_import`	`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
Type	Description
`google.api_core.operation_async.AsyncOperation`	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: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Updates the parameters of a single service.

from google.cloud import metastore_v1

async def sample_update_service():
    # Create a client
    client = metastore_v1.DataprocMetastoreAsyncClient()

    # Initialize request argument(s)
    request = metastore_v1.UpdateServiceRequest(
    )

    # Make the request
    operation = client.update_service(request=request)

    print("Waiting for operation to complete...")

    response = await operation.result()

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Union[google.cloud.metastore_v1.types.UpdateServiceRequest, dict]` The request object. Request message for DataprocMetastore.UpdateService.
`service`	`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
Type	Description
`google.api_core.operation_async.AsyncOperation`	An object representing a long-running operation. The result type for the operation will be Service A managed metastore service that serves metadata queries.