Package Classes (1.15.4)

Summary of entries of Classes for metastore.

Classes

DataprocMetastoreAsyncClient

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

DataprocMetastoreClient

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

ListBackupsAsyncPager

A pager for iterating through list_backups requests.

This class thinly wraps an initial 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 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.

ListBackupsPager

A pager for iterating through list_backups requests.

This class thinly wraps an initial 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 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.

ListMetadataImportsAsyncPager

A pager for iterating through list_metadata_imports requests.

This class thinly wraps an initial 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 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.

ListMetadataImportsPager

A pager for iterating through list_metadata_imports requests.

This class thinly wraps an initial 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 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.

ListServicesAsyncPager

A pager for iterating through list_services requests.

This class thinly wraps an initial 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 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.

ListServicesPager

A pager for iterating through list_services requests.

This class thinly wraps an initial 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 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.

DataprocMetastoreFederationAsyncClient

Configures and manages metastore federation services. Dataproc Metastore Federation Service allows federating a collection of backend metastores like BigQuery, Dataplex Lakes, and other Dataproc Metastores. The Federation Service exposes a gRPC URL through which metadata from the backend metastores are served at query time.

The Dataproc Metastore Federation API defines the following resource model:

  • The service works with a collection of Google Cloud projects.
  • Each project has a collection of available locations.
  • Each location has a collection of federations.
  • Dataproc Metastore Federations are resources with names of the form: projects/{project_number}/locations/{location_id}/federations/{federation_id}.

DataprocMetastoreFederationClient

Configures and manages metastore federation services. Dataproc Metastore Federation Service allows federating a collection of backend metastores like BigQuery, Dataplex Lakes, and other Dataproc Metastores. The Federation Service exposes a gRPC URL through which metadata from the backend metastores are served at query time.

The Dataproc Metastore Federation API defines the following resource model:

  • The service works with a collection of Google Cloud projects.
  • Each project has a collection of available locations.
  • Each location has a collection of federations.
  • Dataproc Metastore Federations are resources with names of the form: projects/{project_number}/locations/{location_id}/federations/{federation_id}.

ListFederationsAsyncPager

A pager for iterating through list_federations requests.

This class thinly wraps an initial ListFederationsResponse object, and provides an __aiter__ method to iterate through its federations field.

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

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

ListFederationsPager

A pager for iterating through list_federations requests.

This class thinly wraps an initial ListFederationsResponse object, and provides an __iter__ method to iterate through its federations field.

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

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

AlterMetadataResourceLocationRequest

Request message for DataprocMetastore.AlterMetadataResourceLocation.

AlterMetadataResourceLocationResponse

Response message for DataprocMetastore.AlterMetadataResourceLocation.

AuxiliaryVersionConfig

Configuration information for the auxiliary service versions.

ConfigOverridesEntry

The abstract base class for a message.

BackendMetastore

Represents a backend metastore for the federation.

MetastoreType

The type of the backend metastore.

Backup

The details of a backup resource.

State

The current state of the backup.

CreateBackupRequest

Request message for DataprocMetastore.CreateBackup.

CreateFederationRequest

Request message for CreateFederation.

CreateMetadataImportRequest

Request message for DataprocMetastore.CreateMetadataImport.

CreateServiceRequest

Request message for DataprocMetastore.CreateService.

DatabaseDumpSpec

The specification of database dump to import from or export to.

Type

The type of the database dump.

DeleteBackupRequest

Request message for DataprocMetastore.DeleteBackup.

DeleteFederationRequest

Request message for DeleteFederation.

DeleteServiceRequest

Request message for DataprocMetastore.DeleteService.

EncryptionConfig

Encryption settings for the service.

ErrorDetails

Error details in public error message for DataprocMetastore.QueryMetadata.

DetailsEntry

The abstract base class for a message.

ExportMetadataRequest

Request message for DataprocMetastore.ExportMetadata.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Federation

Represents a federation of multiple backend metastores.

BackendMetastoresEntry

The abstract base class for a message.

LabelsEntry

The abstract base class for a message.

State

The current state of the federation.

GetBackupRequest

Request message for DataprocMetastore.GetBackup.

GetFederationRequest

Request message for GetFederation.

GetMetadataImportRequest

Request message for DataprocMetastore.GetMetadataImport.

GetServiceRequest

Request message for DataprocMetastore.GetService.

HiveMetastoreConfig

Specifies configuration information specific to running Hive metastore software as the metastore service.

AuxiliaryVersionsEntry

The abstract base class for a message.

ConfigOverridesEntry

The abstract base class for a message.

EndpointProtocol

Protocols available for serving the metastore service endpoint.

KerberosConfig

Configuration information for a Kerberos principal.

ListBackupsRequest

Request message for DataprocMetastore.ListBackups.

ListBackupsResponse

Response message for DataprocMetastore.ListBackups.

ListFederationsRequest

Request message for ListFederations.

ListFederationsResponse

Response message for ListFederations

ListMetadataImportsRequest

Request message for DataprocMetastore.ListMetadataImports.

ListMetadataImportsResponse

Response message for DataprocMetastore.ListMetadataImports.

ListServicesRequest

Request message for DataprocMetastore.ListServices.

ListServicesResponse

Response message for DataprocMetastore.ListServices.

LocationMetadata

Metadata about the service in a location.

HiveMetastoreVersion

A specification of a supported version of the Hive Metastore software.

MaintenanceWindow

Maintenance window. This specifies when Dataproc Metastore may perform system maintenance operation to the service.

MetadataExport

The details of a metadata export operation.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

State

The current state of the metadata export.

MetadataImport

A metastore resource that imports metadata.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

DatabaseDump

A specification of the location of and metadata about a database dump from a relational database management system.

DatabaseType

The type of the database.

State

The current state of the metadata import.

MetadataManagementActivity

The metadata management activities of the metastore service.

MoveTableToDatabaseRequest

Request message for DataprocMetastore.MoveTableToDatabase.

MoveTableToDatabaseResponse

Response message for DataprocMetastore.MoveTableToDatabase.

NetworkConfig

Network configuration for the Dataproc Metastore service.

Next available ID: 4

Consumer

Contains information of the customer's network configurations. Next available ID: 5

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

OperationMetadata

Represents the metadata of a long-running operation.

QueryMetadataRequest

Request message for DataprocMetastore.QueryMetadata.

QueryMetadataResponse

Response message for DataprocMetastore.QueryMetadata.

Restore

The details of a metadata restore operation.

RestoreType

The type of restore. If unspecified, defaults to METADATA_ONLY.

State

The current state of the restore.

RestoreServiceRequest

Request message for [DataprocMetastore.Restore][].

ScalingConfig

Represents the scaling configuration of a metastore service.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

InstanceSize

Metastore instance sizes.

Secret

A securely stored value.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Service

A managed metastore service that serves metadata queries.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

DatabaseType

The backend database type for the metastore service.

LabelsEntry

The abstract base class for a message.

ReleaseChannel

Release channels bundle features of varying levels of stability. Newer features may be introduced initially into less stable release channels and can be automatically promoted into more stable release channels.

State

The current state of the metastore service.

Tier

Available service tiers.

TelemetryConfig

Telemetry Configuration for the Dataproc Metastore service.

LogFormat

UpdateFederationRequest

Request message for UpdateFederation.

UpdateMetadataImportRequest

Request message for DataprocMetastore.UpdateMetadataImport.

UpdateServiceRequest

Request message for DataprocMetastore.UpdateService.

DataprocMetastoreAsyncClient

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

DataprocMetastoreClient

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

ListBackupsAsyncPager

A pager for iterating through list_backups requests.

This class thinly wraps an initial 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 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.

ListBackupsPager

A pager for iterating through list_backups requests.

This class thinly wraps an initial 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 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.

ListMetadataImportsAsyncPager

A pager for iterating through list_metadata_imports requests.

This class thinly wraps an initial 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 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.

ListMetadataImportsPager

A pager for iterating through list_metadata_imports requests.

This class thinly wraps an initial 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 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.

ListServicesAsyncPager

A pager for iterating through list_services requests.

This class thinly wraps an initial 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 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.

ListServicesPager

A pager for iterating through list_services requests.

This class thinly wraps an initial 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 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.

DataprocMetastoreFederationAsyncClient

Configures and manages metastore federation services. Dataproc Metastore Federation Service allows federating a collection of backend metastores like BigQuery, Dataplex Lakes, and other Dataproc Metastores. The Federation Service exposes a gRPC URL through which metadata from the backend metastores are served at query time.

The Dataproc Metastore Federation API defines the following resource model:

  • The service works with a collection of Google Cloud projects.
  • Each project has a collection of available locations.
  • Each location has a collection of federations.
  • Dataproc Metastore Federations are resources with names of the form: projects/{project_number}/locations/{location_id}/federations/{federation_id}.

DataprocMetastoreFederationClient

Configures and manages metastore federation services. Dataproc Metastore Federation Service allows federating a collection of backend metastores like BigQuery, Dataplex Lakes, and other Dataproc Metastores. The Federation Service exposes a gRPC URL through which metadata from the backend metastores are served at query time.

The Dataproc Metastore Federation API defines the following resource model:

  • The service works with a collection of Google Cloud projects.
  • Each project has a collection of available locations.
  • Each location has a collection of federations.
  • Dataproc Metastore Federations are resources with names of the form: projects/{project_number}/locations/{location_id}/federations/{federation_id}.

ListFederationsAsyncPager

A pager for iterating through list_federations requests.

This class thinly wraps an initial ListFederationsResponse object, and provides an __aiter__ method to iterate through its federations field.

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

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

ListFederationsPager

A pager for iterating through list_federations requests.

This class thinly wraps an initial ListFederationsResponse object, and provides an __iter__ method to iterate through its federations field.

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

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

AlterMetadataResourceLocationRequest

Request message for DataprocMetastore.AlterMetadataResourceLocation.

AlterMetadataResourceLocationResponse

Response message for DataprocMetastore.AlterMetadataResourceLocation.

AuxiliaryVersionConfig

Configuration information for the auxiliary service versions.

ConfigOverridesEntry

The abstract base class for a message.

BackendMetastore

Represents a backend metastore for the federation.

MetastoreType

The type of the backend metastore.

Backup

The details of a backup resource.

State

The current state of the backup.

CreateBackupRequest

Request message for DataprocMetastore.CreateBackup.

CreateFederationRequest

Request message for CreateFederation.

CreateMetadataImportRequest

Request message for DataprocMetastore.CreateMetadataImport.

CreateServiceRequest

Request message for DataprocMetastore.CreateService.

DataCatalogConfig

Specifies how metastore metadata should be integrated with the Data Catalog service.

DatabaseDumpSpec

The specification of database dump to import from or export to.

Type

The type of the database dump.

DataplexConfig

Specifies how metastore metadata should be integrated with the Dataplex service.

LakeResourcesEntry

The abstract base class for a message.

DeleteBackupRequest

Request message for DataprocMetastore.DeleteBackup.

DeleteFederationRequest

Request message for DeleteFederation.

DeleteServiceRequest

Request message for DataprocMetastore.DeleteService.

EncryptionConfig

Encryption settings for the service.

ErrorDetails

Error details in public error message for DataprocMetastore.QueryMetadata.

DetailsEntry

The abstract base class for a message.

ExportMetadataRequest

Request message for DataprocMetastore.ExportMetadata.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Federation

Represents a federation of multiple backend metastores.

BackendMetastoresEntry

The abstract base class for a message.

LabelsEntry

The abstract base class for a message.

State

The current state of the federation.

GetBackupRequest

Request message for DataprocMetastore.GetBackup.

GetFederationRequest

Request message for GetFederation.

GetMetadataImportRequest

Request message for DataprocMetastore.GetMetadataImport.

GetServiceRequest

Request message for DataprocMetastore.GetService.

HiveMetastoreConfig

Specifies configuration information specific to running Hive metastore software as the metastore service.

AuxiliaryVersionsEntry

The abstract base class for a message.

ConfigOverridesEntry

The abstract base class for a message.

EndpointProtocol

Protocols available for serving the metastore service endpoint.

KerberosConfig

Configuration information for a Kerberos principal.

Lake

Represents a Lake resource

ListBackupsRequest

Request message for DataprocMetastore.ListBackups.

ListBackupsResponse

Response message for DataprocMetastore.ListBackups.

ListFederationsRequest

Request message for ListFederations.

ListFederationsResponse

Response message for ListFederations

ListMetadataImportsRequest

Request message for DataprocMetastore.ListMetadataImports.

ListMetadataImportsResponse

Response message for DataprocMetastore.ListMetadataImports.

ListServicesRequest

Request message for DataprocMetastore.ListServices.

ListServicesResponse

Response message for DataprocMetastore.ListServices.

LocationMetadata

Metadata about the service in a location.

HiveMetastoreVersion

A specification of a supported version of the Hive Metastore software.

MaintenanceWindow

Maintenance window. This specifies when Dataproc Metastore may perform system maintenance operation to the service.

MetadataExport

The details of a metadata export operation.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

State

The current state of the metadata export.

MetadataImport

A metastore resource that imports metadata.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

DatabaseDump

A specification of the location of and metadata about a database dump from a relational database management system.

DatabaseType

The type of the database.

State

The current state of the metadata import.

MetadataIntegration

Specifies how metastore metadata should be integrated with external services.

MetadataManagementActivity

The metadata management activities of the metastore service.

MoveTableToDatabaseRequest

Request message for DataprocMetastore.MoveTableToDatabase.

MoveTableToDatabaseResponse

Response message for DataprocMetastore.MoveTableToDatabase.

NetworkConfig

Network configuration for the Dataproc Metastore service.

Next available ID: 4

Consumer

Contains information of the customer's network configurations. Next available ID: 5

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

OperationMetadata

Represents the metadata of a long-running operation.

QueryMetadataRequest

Request message for DataprocMetastore.QueryMetadata.

QueryMetadataResponse

Response message for DataprocMetastore.QueryMetadata.

RemoveIamPolicyRequest

Request message for DataprocMetastore.RemoveIamPolicy.

RemoveIamPolicyResponse

Response message for DataprocMetastore.RemoveIamPolicy.

Restore

The details of a metadata restore operation.

RestoreType

The type of restore. If unspecified, defaults to METADATA_ONLY.

State

The current state of the restore.

RestoreServiceRequest

Request message for [DataprocMetastore.Restore][].

ScalingConfig

Represents the scaling configuration of a metastore service.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

InstanceSize

Metastore instance sizes.

Secret

A securely stored value.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Service

A managed metastore service that serves metadata queries.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

DatabaseType

The backend database type for the metastore service.

LabelsEntry

The abstract base class for a message.

ReleaseChannel

Release channels bundle features of varying levels of stability. Newer features may be introduced initially into less stable release channels and can be automatically promoted into more stable release channels.

State

The current state of the metastore service.

Tier

Available service tiers.

TelemetryConfig

Telemetry Configuration for the Dataproc Metastore service.

LogFormat

UpdateFederationRequest

Request message for UpdateFederation.

UpdateMetadataImportRequest

Request message for DataprocMetastore.UpdateMetadataImport.

UpdateServiceRequest

Request message for DataprocMetastore.UpdateService.

DataprocMetastoreAsyncClient

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

DataprocMetastoreClient

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

ListBackupsAsyncPager

A pager for iterating through list_backups requests.

This class thinly wraps an initial 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 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.

ListBackupsPager

A pager for iterating through list_backups requests.

This class thinly wraps an initial 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 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.

ListMetadataImportsAsyncPager

A pager for iterating through list_metadata_imports requests.

This class thinly wraps an initial 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 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.

ListMetadataImportsPager

A pager for iterating through list_metadata_imports requests.

This class thinly wraps an initial 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 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.

ListServicesAsyncPager

A pager for iterating through list_services requests.

This class thinly wraps an initial 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 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.

ListServicesPager

A pager for iterating through list_services requests.

This class thinly wraps an initial 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 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.

DataprocMetastoreFederationAsyncClient

Configures and manages metastore federation services. Dataproc Metastore Federation Service allows federating a collection of backend metastores like BigQuery, Dataplex Lakes, and other Dataproc Metastores. The Federation Service exposes a gRPC URL through which metadata from the backend metastores are served at query time.

The Dataproc Metastore Federation API defines the following resource model:

  • The service works with a collection of Google Cloud projects.
  • Each project has a collection of available locations.
  • Each location has a collection of federations.
  • Dataproc Metastore Federations are resources with names of the form: projects/{project_number}/locations/{location_id}/federations/{federation_id}.

DataprocMetastoreFederationClient

Configures and manages metastore federation services. Dataproc Metastore Federation Service allows federating a collection of backend metastores like BigQuery, Dataplex Lakes, and other Dataproc Metastores. The Federation Service exposes a gRPC URL through which metadata from the backend metastores are served at query time.

The Dataproc Metastore Federation API defines the following resource model:

  • The service works with a collection of Google Cloud projects.
  • Each project has a collection of available locations.
  • Each location has a collection of federations.
  • Dataproc Metastore Federations are resources with names of the form: projects/{project_number}/locations/{location_id}/federations/{federation_id}.

ListFederationsAsyncPager

A pager for iterating through list_federations requests.

This class thinly wraps an initial ListFederationsResponse object, and provides an __aiter__ method to iterate through its federations field.

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

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

ListFederationsPager

A pager for iterating through list_federations requests.

This class thinly wraps an initial ListFederationsResponse object, and provides an __iter__ method to iterate through its federations field.

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

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

AlterMetadataResourceLocationRequest

Request message for DataprocMetastore.AlterMetadataResourceLocation.

AlterMetadataResourceLocationResponse

Response message for DataprocMetastore.AlterMetadataResourceLocation.

AuxiliaryVersionConfig

Configuration information for the auxiliary service versions.

ConfigOverridesEntry

The abstract base class for a message.

BackendMetastore

Represents a backend metastore for the federation.

MetastoreType

The type of the backend metastore.

Backup

The details of a backup resource.

State

The current state of the backup.

CreateBackupRequest

Request message for DataprocMetastore.CreateBackup.

CreateFederationRequest

Request message for CreateFederation.

CreateMetadataImportRequest

Request message for DataprocMetastore.CreateMetadataImport.

CreateServiceRequest

Request message for DataprocMetastore.CreateService.

DataCatalogConfig

Specifies how metastore metadata should be integrated with the Data Catalog service.

DatabaseDumpSpec

The specification of database dump to import from or export to.

Type

The type of the database dump.

DataplexConfig

Specifies how metastore metadata should be integrated with the Dataplex service.

LakeResourcesEntry

The abstract base class for a message.

DeleteBackupRequest

Request message for DataprocMetastore.DeleteBackup.

DeleteFederationRequest

Request message for DeleteFederation.

DeleteServiceRequest

Request message for DataprocMetastore.DeleteService.

EncryptionConfig

Encryption settings for the service.

ErrorDetails

Error details in public error message for DataprocMetastore.QueryMetadata.

DetailsEntry

The abstract base class for a message.

ExportMetadataRequest

Request message for DataprocMetastore.ExportMetadata.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Federation

Represents a federation of multiple backend metastores.

BackendMetastoresEntry

The abstract base class for a message.

LabelsEntry

The abstract base class for a message.

State

The current state of the federation.

GetBackupRequest

Request message for DataprocMetastore.GetBackup.

GetFederationRequest

Request message for GetFederation.

GetMetadataImportRequest

Request message for DataprocMetastore.GetMetadataImport.

GetServiceRequest

Request message for DataprocMetastore.GetService.

HiveMetastoreConfig

Specifies configuration information specific to running Hive metastore software as the metastore service.

AuxiliaryVersionsEntry

The abstract base class for a message.

ConfigOverridesEntry

The abstract base class for a message.

EndpointProtocol

Protocols available for serving the metastore service endpoint.

KerberosConfig

Configuration information for a Kerberos principal.

Lake

Represents a Lake resource

ListBackupsRequest

Request message for DataprocMetastore.ListBackups.

ListBackupsResponse

Response message for DataprocMetastore.ListBackups.

ListFederationsRequest

Request message for ListFederations.

ListFederationsResponse

Response message for ListFederations

ListMetadataImportsRequest

Request message for DataprocMetastore.ListMetadataImports.

ListMetadataImportsResponse

Response message for DataprocMetastore.ListMetadataImports.

ListServicesRequest

Request message for DataprocMetastore.ListServices.

ListServicesResponse

Response message for DataprocMetastore.ListServices.

LocationMetadata

Metadata about the service in a location.

HiveMetastoreVersion

A specification of a supported version of the Hive Metastore software.

MaintenanceWindow

Maintenance window. This specifies when Dataproc Metastore may perform system maintenance operation to the service.

MetadataExport

The details of a metadata export operation.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

State

The current state of the metadata export.

MetadataImport

A metastore resource that imports metadata.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

DatabaseDump

A specification of the location of and metadata about a database dump from a relational database management system.

DatabaseType

The type of the database.

State

The current state of the metadata import.

MetadataIntegration

Specifies how metastore metadata should be integrated with external services.

MetadataManagementActivity

The metadata management activities of the metastore service.

MoveTableToDatabaseRequest

Request message for DataprocMetastore.MoveTableToDatabase.

MoveTableToDatabaseResponse

Response message for DataprocMetastore.MoveTableToDatabase.

NetworkConfig

Network configuration for the Dataproc Metastore service.

Next available ID: 4

Consumer

Contains information of the customer's network configurations. Next available ID: 5

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

OperationMetadata

Represents the metadata of a long-running operation.

QueryMetadataRequest

Request message for DataprocMetastore.QueryMetadata.

QueryMetadataResponse

Response message for DataprocMetastore.QueryMetadata.

RemoveIamPolicyRequest

Request message for DataprocMetastore.RemoveIamPolicy.

RemoveIamPolicyResponse

Response message for DataprocMetastore.RemoveIamPolicy.

Restore

The details of a metadata restore operation.

RestoreType

The type of restore. If unspecified, defaults to METADATA_ONLY.

State

The current state of the restore.

RestoreServiceRequest

Request message for [DataprocMetastore.Restore][].

ScalingConfig

Represents the scaling configuration of a metastore service.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

InstanceSize

Metastore instance sizes.

Secret

A securely stored value.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Service

A managed metastore service that serves metadata queries.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

DatabaseType

The backend database type for the metastore service.

LabelsEntry

The abstract base class for a message.

ReleaseChannel

Release channels bundle features of varying levels of stability. Newer features may be introduced initially into less stable release channels and can be automatically promoted into more stable release channels.

State

The current state of the metastore service.

Tier

Available service tiers.

TelemetryConfig

Telemetry Configuration for the Dataproc Metastore service.

LogFormat

UpdateFederationRequest

Request message for UpdateFederation.

UpdateMetadataImportRequest

Request message for DataprocMetastore.UpdateMetadataImport.

UpdateServiceRequest

Request message for DataprocMetastore.UpdateService.

Modules

pagers

API documentation for metastore_v1.services.dataproc_metastore.pagers module.

pagers

API documentation for metastore_v1.services.dataproc_metastore_federation.pagers module.

pagers

API documentation for metastore_v1alpha.services.dataproc_metastore.pagers module.

pagers

API documentation for metastore_v1alpha.services.dataproc_metastore_federation.pagers module.

pagers

API documentation for metastore_v1beta.services.dataproc_metastore.pagers module.

pagers

API documentation for metastore_v1beta.services.dataproc_metastore_federation.pagers module.