## Index

- `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.DataprocMetastore` (interface)
- `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.DataprocMetastoreFederation` (interface)
- `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.AlterMetadataResourceLocationRequest` (message)
- `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.AlterMetadataResourceLocationResponse` (message)
- `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.AlterTablePropertiesRequest` (message)
- `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.AlterTablePropertiesResponse` (message)
- `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.AutoscalingConfig` (message)
- `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.AuxiliaryVersionConfig` (message)
- `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.BackendMetastore` (message)
- `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.BackendMetastore.MetastoreType` (enum)
- `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.Backup` (message)
- `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.Backup.State` (enum)
- `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.CancelMigrationRequest` (message)
- `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.CancelMigrationResponse` (message)
- `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.CatalogReport` (message)
- `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.CatalogReport.CatalogType` (enum)
- `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.CatalogSummary` (message)
- `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.CompleteMigrationRequest` (message)
- `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.CompleteMigrationResponse` (message)
- `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.CreateBackupRequest` (message)
- `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.CreateFederationRequest` (message)
- `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.CreateMetadataImportRequest` (message)
- `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.CreateServiceRequest` (message)
- `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.DataCatalogConfig` (message)
- `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.DatabaseDumpSpec` (message)
- `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.DatabaseDumpSpec.Type` (enum)
- `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.DatabaseReport` (message)
- `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.DatabaseSummary` (message)
- `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.DataplexConfig` (message)
- `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.DeleteBackupRequest` (message)
- `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.DeleteFederationRequest` (message)
- `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.DeleteMigrationExecutionRequest` (message)
- `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.DeleteServiceRequest` (message)
- `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.EncryptionConfig` (message)
- `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.ErrorDetails` (message)
- `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.ExecutionPlan` (message)
- `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.ExecutionPlan.Action` (enum)
- `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.ExecutionPlan.ValueDiff` (message)
- `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.ExecutionResult` (message)
- `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.ExecutionResult.State` (enum)
- `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.ExportMetadataRequest` (message)
- `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.Federation` (message)
- `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.Federation.State` (enum)
- `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.GetBackupRequest` (message)
- `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.GetFederationRequest` (message)
- `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.GetMetadataImportRequest` (message)
- `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.GetMigrationExecutionRequest` (message)
- `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.GetServiceRequest` (message)
- `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.HiveMetastoreConfig` (message)
- `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.HiveMetastoreConfig.EndpointProtocol` (enum)
- `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.KerberosConfig` (message)
- `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.Lake` (message)
- `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.LatestBackup` (message)
- `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.LatestBackup.State` (enum)
- `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.LimitConfig` (message)
- `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.ListBackupsRequest` (message)
- `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.ListBackupsResponse` (message)
- `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.ListFederationsRequest` (message)
- `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.ListFederationsResponse` (message)
- `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.ListMetadataImportsRequest` (message)
- `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.ListMetadataImportsResponse` (message)
- `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.ListMigrationExecutionsRequest` (message)
- `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.ListMigrationExecutionsResponse` (message)
- `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.ListServicesRequest` (message)
- `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.ListServicesResponse` (message)
- `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.LocationMetadata` (message)
- `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.LocationMetadata.CustomRegionMetadata` (message) **(deprecated)**
- `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.LocationMetadata.HiveMetastoreVersion` (message)
- `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.LocationMetadata.MultiRegionMetadata` (message) **(deprecated)**
- `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.MaintenanceWindow` (message)
- `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.MetadataExport` (message)
- `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.MetadataExport.State` (enum)
- `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.MetadataImport` (message)
- `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.MetadataImport.DatabaseDump` (message)
- `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.MetadataImport.DatabaseDump.DatabaseType` (enum)
- `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.MetadataImport.State` (enum)
- `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.MetadataIntegration` (message)
- `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.MetadataManagementActivity` (message)
- `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.MigrationExecution` (message)
- `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.MigrationExecution.BigLakeMetastoreMigrationConfig` (message)
- `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.MigrationExecution.BigLakeMetastoreMigrationConfig.BackfillStatus` (message)
- `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.MigrationExecution.BigLakeMetastoreMigrationConfig.BackfillStatus.State` (enum)
- `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.MigrationExecution.BigLakeMetastoreMigrationConfig.ConflictPolicy` (enum)
- `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.MigrationExecution.BigLakeMetastoreMigrationConfig.HiveConfig` (message)
- `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.MigrationExecution.BigLakeMetastoreMigrationConfig.IcebergConfig` (message)
- `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.MigrationExecution.BigLakeMetastoreMigrationConfig.MigrationMode` (enum)
- `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.MigrationExecution.Phase` (enum)
- `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.MigrationExecution.State` (enum)
- `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.MigrationReport` (message)
- `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.MigrationSummary` (message)
- `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.MoveTableToDatabaseRequest` (message)
- `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.MoveTableToDatabaseResponse` (message)
- `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.MultiRegionConfig` (message) **(deprecated)**
- `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.MultiRegionConfig.CustomRegionConfig` (message) **(deprecated)**
- `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.MultiRegionConfig.RootCACertificate` (message) **(deprecated)**
- `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.NetworkConfig` (message)
- `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.NetworkConfig.Consumer` (message)
- `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.OperationMetadata` (message)
- `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.PartitionReport` (message)
- `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.PartitionReport.State` (enum)
- `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.QueryMetadataRequest` (message)
- `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.QueryMetadataResponse` (message)
- `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.RemoveIamPolicyRequest` (message)
- `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.RemoveIamPolicyResponse` (message)
- `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.Restore` (message)
- `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.Restore.RestoreType` (enum)
- `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.Restore.State` (enum)
- `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.RestoreServiceRequest` (message)
- `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.ScalingConfig` (message)
- `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.ScalingConfig.InstanceSize` (enum)
- `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.ScheduledBackup` (message)
- `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.Secret` (message)
- `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.Service` (message)
- `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.Service.DatabaseType` (enum)
- `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.Service.ReleaseChannel` (enum)
- `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.Service.State` (enum)
- `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.Service.Tier` (enum)
- `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.StartMigrationRequest` (message)
- `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.TableReport` (message)
- `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.TableSummary` (message)
- `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.TelemetryConfig` (message)
- `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.TelemetryConfig.LogFormat` (enum)
- `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.UpdateFederationRequest` (message)
- `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.UpdateMetadataImportRequest` (message)
- `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.UpdateServiceRequest` (message)

## DataprocMetastore

Configures and manages metastore services. Metastore services are fully managed, highly available, autoscaled, autohealing, OSS-native deployments of technical metadata management software. Each metastore service exposes a network endpoint through which metadata queries are served. Metadata queries can originate from a variety of sources, including Apache Hive, Apache Presto, and Apache Spark.

The Dataproc Metastore API defines the following resource model:

- The service works with a collection of Google Cloud projects, named: `/projects/*`
- Each project has a collection of available locations, named: `/locations/*` (a location must refer to a Google Cloud `region`)
- Each location has a collection of services, named: `/services/*`
- Dataproc Metastore services are resources with names of the form:

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

| AlterMetadataResourceLocation |
|---|
| `` rpc AlterMetadataResourceLocation(`https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.AlterMetadataResourceLocationRequest`) returns (`https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.longrunning#google.longrunning.Operation`) `` Alter metadata resource location. The metadata resource can be a database, table, or partition. This functionality only updates the parent directory for the respective metadata resource and does not transfer any existing data to the new location. Authorization scopes :   Requires the following OAuth scope: - `https://www.googleapis.com/auth/cloud-platform` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). |

| AlterTableProperties |
|---|
| `` rpc AlterTableProperties(`https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.AlterTablePropertiesRequest`) returns (`https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.longrunning#google.longrunning.Operation`) `` Alter metadata table properties. Authorization scopes :   Requires the following OAuth scope: - `https://www.googleapis.com/auth/cloud-platform` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). |

| CancelMigration |
|---|
| `` rpc CancelMigration(`https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.CancelMigrationRequest`) returns (`https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.longrunning#google.longrunning.Operation`) `` Cancels the ongoing Managed Migration process. Authorization scopes :   Requires the following OAuth scope: - `https://www.googleapis.com/auth/cloud-platform` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). |

| CompleteMigration |
|---|
| `` rpc CompleteMigration(`https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.CompleteMigrationRequest`) returns (`https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.longrunning#google.longrunning.Operation`) `` Completes the managed migration process. The Dataproc Metastore service will switch to using its own backend database after successful migration. Authorization scopes :   Requires the following OAuth scope: - `https://www.googleapis.com/auth/cloud-platform` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). |

| CreateBackup |
|---|
| `` rpc CreateBackup(`https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.CreateBackupRequest`) returns (`https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.longrunning#google.longrunning.Operation`) `` Creates a new backup in a given project and location. Authorization scopes :   Requires the following OAuth scope: - `https://www.googleapis.com/auth/cloud-platform` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). |

| CreateMetadataImport |
|---|
| `` rpc CreateMetadataImport(`https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.CreateMetadataImportRequest`) returns (`https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.longrunning#google.longrunning.Operation`) `` Creates a new MetadataImport in a given project and location. Authorization scopes :   Requires the following OAuth scope: - `https://www.googleapis.com/auth/cloud-platform` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). |

| CreateService |
|---|
| `` rpc CreateService(`https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.CreateServiceRequest`) returns (`https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.longrunning#google.longrunning.Operation`) `` Creates a metastore service in a project and location. Authorization scopes :   Requires the following OAuth scope: - `https://www.googleapis.com/auth/cloud-platform` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). |

| DeleteBackup |
|---|
| `` rpc DeleteBackup(`https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.DeleteBackupRequest`) returns (`https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.longrunning#google.longrunning.Operation`) `` Deletes a single backup. Authorization scopes :   Requires the following OAuth scope: - `https://www.googleapis.com/auth/cloud-platform` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). |

| DeleteMigrationExecution |
|---|
| `` rpc DeleteMigrationExecution(`https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.DeleteMigrationExecutionRequest`) returns (`https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.longrunning#google.longrunning.Operation`) `` Deletes a single migration execution. Authorization scopes :   Requires the following OAuth scope: - `https://www.googleapis.com/auth/cloud-platform` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). |

| DeleteService |
|---|
| `` rpc DeleteService(`https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.DeleteServiceRequest`) returns (`https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.longrunning#google.longrunning.Operation`) `` Deletes a single service. Authorization scopes :   Requires the following OAuth scope: - `https://www.googleapis.com/auth/cloud-platform` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). |

| ExportMetadata |
|---|
| `` rpc ExportMetadata(`https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.ExportMetadataRequest`) returns (`https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.longrunning#google.longrunning.Operation`) `` Exports metadata from a service. Authorization scopes :   Requires the following OAuth scope: - `https://www.googleapis.com/auth/cloud-platform` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). |

| GetBackup |
|---|
| `` rpc GetBackup(`https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.GetBackupRequest`) returns (`https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.Backup`) `` Gets details of a single backup. Authorization scopes :   Requires the following OAuth scope: - `https://www.googleapis.com/auth/cloud-platform` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). |

| GetMetadataImport |
|---|
| `` rpc GetMetadataImport(`https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.GetMetadataImportRequest`) returns (`https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.MetadataImport`) `` Gets details of a single import. Authorization scopes :   Requires the following OAuth scope: - `https://www.googleapis.com/auth/cloud-platform` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). |

| GetMigrationExecution |
|---|
| `` rpc GetMigrationExecution(`https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.GetMigrationExecutionRequest`) returns (`https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.MigrationExecution`) `` Gets details of a single migration execution. Authorization scopes :   Requires the following OAuth scope: - `https://www.googleapis.com/auth/cloud-platform` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). |

| GetService |
|---|
| `` rpc GetService(`https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.GetServiceRequest`) returns (`https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.Service`) `` Gets the details of a single service. Authorization scopes :   Requires the following OAuth scope: - `https://www.googleapis.com/auth/cloud-platform` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). |

| ListBackups |
|---|
| `` rpc ListBackups(`https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.ListBackupsRequest`) returns (`https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.ListBackupsResponse`) `` Lists backups in a service. Authorization scopes :   Requires the following OAuth scope: - `https://www.googleapis.com/auth/cloud-platform` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). |

| ListMetadataImports |
|---|
| `` rpc ListMetadataImports(`https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.ListMetadataImportsRequest`) returns (`https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.ListMetadataImportsResponse`) `` Lists imports in a service. Authorization scopes :   Requires the following OAuth scope: - `https://www.googleapis.com/auth/cloud-platform` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). |

| ListMigrationExecutions |
|---|
| `` rpc ListMigrationExecutions(`https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.ListMigrationExecutionsRequest`) returns (`https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.ListMigrationExecutionsResponse`) `` Lists migration executions on a service. Authorization scopes :   Requires the following OAuth scope: - `https://www.googleapis.com/auth/cloud-platform` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). |

| ListServices |
|---|
| `` rpc ListServices(`https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.ListServicesRequest`) returns (`https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.ListServicesResponse`) `` Lists services in a project and location. Authorization scopes :   Requires the following OAuth scope: - `https://www.googleapis.com/auth/cloud-platform` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). |

| MoveTableToDatabase |
|---|
| `` rpc MoveTableToDatabase(`https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.MoveTableToDatabaseRequest`) returns (`https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.longrunning#google.longrunning.Operation`) `` Move a table to another database. Authorization scopes :   Requires the following OAuth scope: - `https://www.googleapis.com/auth/cloud-platform` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). |

| QueryMetadata |
|---|
| `` rpc QueryMetadata(`https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.QueryMetadataRequest`) returns (`https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.longrunning#google.longrunning.Operation`) `` Query Dataproc Metastore metadata. Authorization scopes :   Requires the following OAuth scope: - `https://www.googleapis.com/auth/cloud-platform` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). |

| RemoveIamPolicy |
|---|
| `` rpc RemoveIamPolicy(`https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.RemoveIamPolicyRequest`) returns (`https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.RemoveIamPolicyResponse`) `` Removes the attached IAM policies for a resource Authorization scopes :   Requires the following OAuth scope: - `https://www.googleapis.com/auth/cloud-platform` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). |

| RestoreService |
|---|
| `` rpc RestoreService(`https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.RestoreServiceRequest`) returns (`https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.longrunning#google.longrunning.Operation`) `` Restores a service from a backup. Authorization scopes :   Requires the following OAuth scope: - `https://www.googleapis.com/auth/cloud-platform` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). |

| StartMigration |
|---|
| `` rpc StartMigration(`https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.StartMigrationRequest`) returns (`https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.longrunning#google.longrunning.Operation`) `` Starts the Managed Migration process. Authorization scopes :   Requires the following OAuth scope: - `https://www.googleapis.com/auth/cloud-platform` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). |

| UpdateMetadataImport |
|---|
| `` rpc UpdateMetadataImport(`https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.UpdateMetadataImportRequest`) returns (`https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.longrunning#google.longrunning.Operation`) `` Updates a single import. Only the description field of MetadataImport is supported to be updated. Authorization scopes :   Requires the following OAuth scope: - `https://www.googleapis.com/auth/cloud-platform` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). |

| UpdateService |
|---|
| `` rpc UpdateService(`https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.UpdateServiceRequest`) returns (`https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.longrunning#google.longrunning.Operation`) `` Updates the parameters of a single service. Authorization scopes :   Requires the following OAuth scope: - `https://www.googleapis.com/auth/cloud-platform` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). |

## DataprocMetastoreFederation

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

The Dataproc Metastore Federation API defines the following resource model: \* The service works with a collection of Google Cloud projects. \* Each project has a collection of available locations. \* Each location has a collection of federations. \* Dataproc Metastore Federations are resources with names of the form: `projects/{project_number}/locations/{location_id}/federations/{federation_id}`.

| CreateFederation |
|---|
| `` rpc CreateFederation(`https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.CreateFederationRequest`) returns (`https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.longrunning#google.longrunning.Operation`) `` Creates a metastore federation in a project and location. Authorization scopes :   Requires the following OAuth scope: - `https://www.googleapis.com/auth/cloud-platform` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). |

| DeleteFederation |
|---|
| `` rpc DeleteFederation(`https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.DeleteFederationRequest`) returns (`https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.longrunning#google.longrunning.Operation`) `` Deletes a single federation. Authorization scopes :   Requires the following OAuth scope: - `https://www.googleapis.com/auth/cloud-platform` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). |

| GetFederation |
|---|
| `` rpc GetFederation(`https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.GetFederationRequest`) returns (`https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.Federation`) `` Gets the details of a single federation. Authorization scopes :   Requires the following OAuth scope: - `https://www.googleapis.com/auth/cloud-platform` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). |

| ListFederations |
|---|
| `` rpc ListFederations(`https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.ListFederationsRequest`) returns (`https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.ListFederationsResponse`) `` Lists federations in a project and location. Authorization scopes :   Requires the following OAuth scope: - `https://www.googleapis.com/auth/cloud-platform` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). |

| UpdateFederation |
|---|
| `` rpc UpdateFederation(`https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.UpdateFederationRequest`) returns (`https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.longrunning#google.longrunning.Operation`) `` Updates the fields of a federation. Authorization scopes :   Requires the following OAuth scope: - `https://www.googleapis.com/auth/cloud-platform` For more information, see the [Authentication Overview](https://docs.cloud.google.com/docs/authentication#authorization-gcp). |

## AlterMetadataResourceLocationRequest

Request message for `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.DataprocMetastore.AlterMetadataResourceLocation`.

| Fields ||
|---|---|
| `service` | `string` Required. The relative resource name of the metastore service to mutate metadata, in the following format: `projects/{project_id}/locations/{location_id}/services/{service_id}`. Authorization requires the following [IAM](https://cloud.google.com/iam/docs/) permission on the specified resource `service`: - `metastore.services.mutateMetadata` |
| `resource_name` | `string` Required. The relative metadata resource name in the following format. `databases/{database_id}` or `databases/{database_id}/tables/{table_id}` or `databases/{database_id}/tables/{table_id}/partitions/{partition_id}` |
| `location_uri` | `string` Required. The new location URI for the metadata resource. |

## AlterMetadataResourceLocationResponse

This type has no fields.
Response message for `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.DataprocMetastore.AlterMetadataResourceLocation`.

## AlterTablePropertiesRequest

Request message for `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.DataprocMetastore.AlterTableProperties`.

| Fields ||
|---|---|
| `service` | `string` Required. The relative resource name of the Dataproc Metastore service that's being used to mutate metadata table properties, in the following format: `projects/{project_id}/locations/{location_id}/services/{service_id}`. Authorization requires the following [IAM](https://cloud.google.com/iam/docs/) permission on the specified resource `service`: - `metastore.services.mutateMetadata` |
| `table_name` | `string` Required. The name of the table containing the properties you're altering in the following format. `databases/{database_id}/tables/{table_id}` |
| `update_mask` | `https://protobuf.dev/reference/protobuf/google.protobuf#field-mask` A field mask that specifies the metadata table properties that are overwritten 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. For example, given the target properties: properties { a: 1 b: 2 } And an update properties: properties { a: 2 b: 3 c: 4 } then if the field mask is: paths: \["properties.b", "properties.c"\] then the result will be: properties { a: 1 b: 3 c: 4 } |
| `properties` | `map<string, string>` A map that describes the desired values to mutate. If update_mask is empty, the properties will not update. Otherwise, the properties only alters the value whose associated paths exist in the update mask |

## AlterTablePropertiesResponse

This type has no fields.
Response message for `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.DataprocMetastore.AlterTableProperties`.

## AutoscalingConfig

Represents the autoscaling configuration of a metastore service.

| Fields ||
|---|---|
| `autoscaling_factor` | `float` Output only. The scaling factor of a service with autoscaling enabled. |
| `autoscaling_enabled` | `bool` Optional. Whether or not autoscaling is enabled for this service. |
| `limit_config` | `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.LimitConfig` Optional. The LimitConfig of the service. |

## AuxiliaryVersionConfig

Configuration information for the auxiliary service versions.

| Fields ||
|---|---|
| `version` | `string` Optional. The Hive metastore version of the auxiliary service. It must be less than the primary Hive metastore service's version. |
| `config_overrides` | `map<string, string>` Optional. A mapping of Hive metastore configuration key-value pairs to apply to the auxiliary Hive metastore (configured in `hive-site.xml`) in addition to the primary version's overrides. If keys are present in both the auxiliary version's overrides and the primary version's overrides, the value from the auxiliary version's overrides takes precedence. |
| `network_config` | `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.NetworkConfig` Output only. The network configuration contains the endpoint URI(s) of the auxiliary Hive metastore service. |

## BackendMetastore

Represents a backend metastore for the federation.

| Fields ||
|---|---|
| `name` | `string` The relative resource name of the metastore that is being federated. The formats of the relative resource names for the currently supported metastores are listed below: - BigQuery - `projects/{project_id}` - Dataproc Metastore - `projects/{project_id}/locations/{location}/services/{service_id}` |
| `metastore_type` | `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.BackendMetastore.MetastoreType` The type of the backend metastore. |

## MetastoreType

The type of the backend metastore.

| Enums ||
|---|---|
| `METASTORE_TYPE_UNSPECIFIED` | The metastore type is not set. |
| `DATAPLEX` | The backend metastore is Dataplex. |
| `BIGQUERY` | The backend metastore is BigQuery. |
| `DATAPROC_METASTORE` | The backend metastore is Dataproc Metastore. |

## Backup

The details of a backup resource.

| Fields ||
|---|---|
| `name` | `string` Immutable. Identifier. The relative resource name of the backup, in the following form: `projects/{project_number}/locations/{location_id}/services/{service_id}/backups/{backup_id}` |
| `create_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Output only. The time when the backup was started. |
| `end_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Output only. The time when the backup finished creating. |
| `state` | `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.Backup.State` Output only. The current state of the backup. |
| `service_revision` | `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.Service` Output only. The revision of the service at the time of backup. |
| `description` | `string` Optional. The description of the backup. |
| `restoring_services[]` | `string` Output only. Services that are restoring from the backup. |

## State

The current state of the backup.

| Enums ||
|---|---|
| `STATE_UNSPECIFIED` | The state of the backup is unknown. |
| `CREATING` | The backup is being created. |
| `DELETING` | The backup is being deleted. |
| `ACTIVE` | The backup is active and ready to use. |
| `FAILED` | The backup failed. |
| `RESTORING` | The backup is being restored. |

## CancelMigrationRequest

Request message for `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.DataprocMetastore.CancelMigration`.

| Fields ||
|---|---|
| `service` | `string` Required. The relative resource name of the metastore service to cancel the ongoing migration to, in the following format: `projects/{project_id}/locations/{location_id}/services/{service_id}`. Authorization requires the following [IAM](https://cloud.google.com/iam/docs/) permission on the specified resource `service`: - `metastore.migrations.cancel` |

## CancelMigrationResponse

Response message for `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.DataprocMetastore.CancelMigration`.

| Fields ||
|---|---|
| `migration_execution` | `string` The relative resource name of the migration execution, in the following form: `projects/{project_number}/locations/{location_id}/services/{service_id}/migrationExecutions/{migration_execution_id}`. |

## CatalogReport

Aggregated report at the catalog level.

| Fields ||
|---|---|
| `catalog_type` | `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.CatalogReport.CatalogType` The type of catalog. |
| `catalog` | `string` The name of the catalog (format: projects/\*/catalogs/\*). |
| `database_reports` | ``map<string, `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.DatabaseReport`>`` A map of database names to their respective reports. |

## CatalogType

The type of catalog.

| Enums ||
|---|---|
| `CATALOG_TYPE_UNSPECIFIED` | The catalog type is unspecified. |
| `HIVE` | BigLake Metastore Hive catalog. |
| `ICEBERG` | BigLake Metastore Iceberg REST catalog. |

## CatalogSummary

Summary of results for a specific destination catalog.

| Fields ||
|---|---|
| `catalog` | `string` Output only. The catalog resource name (format: projects/\*/catalogs/\*). |
| `catalog_type` | `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.CatalogReport.CatalogType` Output only. The type of the catalog. |
| `database_summaries[]` | `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.DatabaseSummary` Output only. Summary of results for each database in the catalog. |

## CompleteMigrationRequest

Request message for `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.DataprocMetastore.CompleteMigration`.

| Fields ||
|---|---|
| `service` | `string` Required. The relative resource name of the metastore service to complete the migration to, in the following format: `projects/{project_id}/locations/{location_id}/services/{service_id}`. Authorization requires the following [IAM](https://cloud.google.com/iam/docs/) permission on the specified resource `service`: - `metastore.migrations.complete` |

## CompleteMigrationResponse

Response message for `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.DataprocMetastore.CompleteMigration`.

| Fields ||
|---|---|
| `migration_execution` | `string` The relative resource name of the migration execution, in the following form: `projects/{project_number}/locations/{location_id}/services/{service_id}/migrationExecutions/{migration_execution_id}`. |

## CreateBackupRequest

Request message for `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.DataprocMetastore.CreateBackup`.

| Fields ||
|---|---|
| `parent` | `string` 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}`. Authorization requires the following [IAM](https://cloud.google.com/iam/docs/) permission on the specified resource `parent`: - `metastore.backups.create` |
| `backup_id` | `string` 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. |
| `backup` | `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.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. |
| `request_id` | `string` Optional. A request ID. Specify a unique request ID to allow the server to ignore the request if it has completed. The server will ignore subsequent requests that provide a duplicate request ID for at least 60 minutes after the first request. For example, if an initial request times out, followed by another request with the same request ID, the server ignores the second request to prevent the creation of duplicate commitments. The request ID must be a valid [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier#Format) A zero UUID (00000000-0000-0000-0000-000000000000) is not supported. |

## CreateFederationRequest

Request message for CreateFederation.

| Fields ||
|---|---|
| `parent` | `string` Required. The relative resource name of the location in which to create a federation service, in the following form: `projects/{project_number}/locations/{location_id}`. Authorization requires the following [IAM](https://cloud.google.com/iam/docs/) permission on the specified resource `parent`: - `metastore.federations.create` |
| `federation_id` | `string` Required. The ID of the metastore federation, which is used as the final component of the metastore federation'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. |
| `federation` | `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.Federation` Required. The Metastore Federation to create. The `name` field is ignored. The ID of the created metastore federation must be provided in the request's `federation_id` field. |
| `request_id` | `string` Optional. A request ID. Specify a unique request ID to allow the server to ignore the request if it has completed. The server will ignore subsequent requests that provide a duplicate request ID for at least 60 minutes after the first request. For example, if an initial request times out, followed by another request with the same request ID, the server ignores the second request to prevent the creation of duplicate commitments. The request ID must be a valid [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier#Format) A zero UUID (00000000-0000-0000-0000-000000000000) is not supported. |

## CreateMetadataImportRequest

Request message for `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.DataprocMetastore.CreateMetadataImport`.

| Fields ||
|---|---|
| `parent` | `string` 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}`. Authorization requires the following [IAM](https://cloud.google.com/iam/docs/) permission on the specified resource `parent`: - `metastore.imports.create` |
| `metadata_import_id` | `string` 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. |
| `metadata_import` | `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.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. |
| `request_id` | `string` Optional. A request ID. Specify a unique request ID to allow the server to ignore the request if it has completed. The server will ignore subsequent requests that provide a duplicate request ID for at least 60 minutes after the first request. For example, if an initial request times out, followed by another request with the same request ID, the server ignores the second request to prevent the creation of duplicate commitments. The request ID must be a valid [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier#Format) A zero UUID (00000000-0000-0000-0000-000000000000) is not supported. |

## CreateServiceRequest

Request message for `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.DataprocMetastore.CreateService`.

| Fields ||
|---|---|
| `parent` | `string` 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}`. Authorization requires the following [IAM](https://cloud.google.com/iam/docs/) permission on the specified resource `parent`: - `metastore.services.create` |
| `service_id` | `string` 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. |
| `service` | `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.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. |
| `request_id` | `string` Optional. A request ID. Specify a unique request ID to allow the server to ignore the request if it has completed. The server will ignore subsequent requests that provide a duplicate request ID for at least 60 minutes after the first request. For example, if an initial request times out, followed by another request with the same request ID, the server ignores the second request to prevent the creation of duplicate commitments. The request ID must be a valid [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier#Format) A zero UUID (00000000-0000-0000-0000-000000000000) is not supported. |

## DataCatalogConfig

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

| Fields ||
|---|---|
| `enabled` | `bool` Optional. Defines whether the metastore metadata should be synced to Data Catalog. The default value is to disable syncing metastore metadata to Data Catalog. |

## DatabaseDumpSpec

This type has no fields.
The specification of database dump to import from or export to.

## Type

The type of the database dump.

| Enums ||
|---|---|
| `TYPE_UNSPECIFIED` | The type of the database dump is unknown. |
| `MYSQL` | Database dump is a MySQL dump file. |
| `AVRO` | Database dump contains Avro files. |

## DatabaseReport

Aggregated report at the database level.

| Fields ||
|---|---|
| `database` | `string` The name of the database. |
| `execution_plan` | `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.ExecutionPlan` The discovered intent for the database (what we found and what we planned). |
| `execution_result` | `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.ExecutionResult` The actual outcome of the database migration. |
| `table_reports` | ``map<string, `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.TableReport`>`` A map of table names to their respective reports. |

## DatabaseSummary

Summary of results for a specific database in a catalog.

| Fields ||
|---|---|
| `database` | `string` Output only. The name of the database. |
| `plan_action` | `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.ExecutionPlan.Action` Output only. The migration plan action for the database. |
| `result_status` | `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.ExecutionResult.State` Output only. The migration result status for the database. This is only set if the migration is not a dry run. |
| `table_summary` | `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.TableSummary` Output only. Aggregated summary of results for all tables in the database. |

## DataplexConfig

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

| Fields ||
|---|---|
| `lake_resources` | ``map<string, `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.Lake`>`` Optional. A reference to the Lake resources that this metastore service is attached to. The key is the lake resource name. Example: `projects/{project_number}/locations/{location_id}/lakes/{lake_id}`. |

## DeleteBackupRequest

Request message for `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.DataprocMetastore.DeleteBackup`.

| Fields ||
|---|---|
| `name` | `string` 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}`. Authorization requires the following [IAM](https://cloud.google.com/iam/docs/) permission on the specified resource `name`: - `metastore.backups.delete` |
| `request_id` | `string` Optional. A request ID. Specify a unique request ID to allow the server to ignore the request if it has completed. The server will ignore subsequent requests that provide a duplicate request ID for at least 60 minutes after the first request. For example, if an initial request times out, followed by another request with the same request ID, the server ignores the second request to prevent the creation of duplicate commitments. The request ID must be a valid [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier#Format) A zero UUID (00000000-0000-0000-0000-000000000000) is not supported. |

## DeleteFederationRequest

Request message for DeleteFederation.

| Fields ||
|---|---|
| `name` | `string` Required. The relative resource name of the metastore federation to delete, in the following form: `projects/{project_number}/locations/{location_id}/federations/{federation_id}`. Authorization requires the following [IAM](https://cloud.google.com/iam/docs/) permission on the specified resource `name`: - `metastore.federations.delete` |
| `request_id` | `string` Optional. A request ID. Specify a unique request ID to allow the server to ignore the request if it has completed. The server will ignore subsequent requests that provide a duplicate request ID for at least 60 minutes after the first request. For example, if an initial request times out, followed by another request with the same request ID, the server ignores the second request to prevent the creation of duplicate commitments. The request ID must be a valid [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier#Format) A zero UUID (00000000-0000-0000-0000-000000000000) is not supported. |

## DeleteMigrationExecutionRequest

Request message for `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.DataprocMetastore.DeleteMigrationExecution`.

| Fields ||
|---|---|
| `name` | `string` Required. The relative resource name of the migrationExecution to delete, in the following form: `projects/{project_number}/locations/{location_id}/services/{service_id}/migrationExecutions/{migration_execution_id}`. Authorization requires the following [IAM](https://cloud.google.com/iam/docs/) permission on the specified resource `name`: - `metastore.migrations.delete` |
| `request_id` | `string` Optional. A request ID. Specify a unique request ID to allow the server to ignore the request if it has completed. The server will ignore subsequent requests that provide a duplicate request ID for at least 60 minutes after the first request. For example, if an initial request times out, followed by another request with the same request ID, the server ignores the second request to prevent the creation of duplicate commitments. The request ID must be a valid [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier#Format) A zero UUID (00000000-0000-0000-0000-000000000000) is not supported. |

## DeleteServiceRequest

Request message for `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.DataprocMetastore.DeleteService`.

| Fields ||
|---|---|
| `name` | `string` Required. The relative resource name of the metastore service to delete, in the following form: `projects/{project_number}/locations/{location_id}/services/{service_id}`. Authorization requires the following [IAM](https://cloud.google.com/iam/docs/) permission on the specified resource `name`: - `metastore.services.delete` |
| `request_id` | `string` Optional. A request ID. Specify a unique request ID to allow the server to ignore the request if it has completed. The server will ignore subsequent requests that provide a duplicate request ID for at least 60 minutes after the first request. For example, if an initial request times out, followed by another request with the same request ID, the server ignores the second request to prevent the creation of duplicate commitments. The request ID must be a valid [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier#Format) A zero UUID (00000000-0000-0000-0000-000000000000) is not supported. |

## EncryptionConfig

Encryption settings for the service.

| Fields ||
|---|---|
| `kms_key` | `string` Optional. The fully qualified customer provided Cloud KMS key name to use for customer data encryption, in the following format: `projects/{project_number}/locations/{location_id}/keyRings/{key_ring_id}/cryptoKeys/{crypto_key_id}`. |
| `kms_keys[]` | `string` Optional. The list of fully qualified customer provided Cloud KMS key names for the multi-regional service. Each key must be in the following format: `projects/{project_number}/locations/{location_id}/keyRings/{key_ring_id}/cryptoKeys/{crypto_key_id}`. |

## ErrorDetails

Error details in public error message for `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.DataprocMetastore.QueryMetadata`.

| Fields ||
|---|---|
| `details` | `map<string, string>` Additional structured details about this error. Keys define the failure items. Value describes the exception or details of the item. |

## ExecutionPlan

Represents the migration plan for a specific resource (e.g. Database, Table).

| Fields ||
|---|---|
| `action` | `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.ExecutionPlan.Action` The action that will be taken for a resource during migration. |
| `reason` | `string` A human-readable string explaining why the action was chosen. |
| `diffs` | ``map<string, `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.ExecutionPlan.ValueDiff`>`` A map of field names to their respective value diff. |

## Action

The action that will be taken for a resource during migration.

| Enums ||
|---|---|
| `ACTION_UNSPECIFIED` | The action is unspecified. |
| `CREATE` | Resource missing; will be created. |
| `UPDATE` | Resource exists at the target, but differs from the source; will be updated. |
| `SKIP` | Resource exists at the target; no changes will be made. |
| `DEPENDENCY_FAILURE` | Resource cannot be migrated due to a dependency failure (e.g., parent resource missing). |
| `ERROR` | Resource cannot be migrated due to an error during discovery. |

## ValueDiff

A field-level metadata mismatch for a resource between the source and target.

| Fields ||
|---|---|
| `source_value` | `string` The value of the field at the source. |
| `target_value` | `string` The value of the field at the target. |

## ExecutionResult

Represents the actual migration result for a specific resource (e.g. Database, Table).

| Fields ||
|---|---|
| `state` | `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.ExecutionResult.State` Output only. The state of the migration for a resource. |
| `error_message` | `string` Description of the error if the state is FAILED. |
| `remediation` | `string` Remediation steps for the error if the state is FAILED. |

## State

The state of the migration for a resource.

| Enums ||
|---|---|
| `STATE_UNSPECIFIED` | The state is unspecified. |
| `SUCCEEDED` | The resource was migrated successfully. |
| `FAILED` | The resource failed to migrate. |
| `SKIPPED` | The resource was skipped and will not be migrated. |

## ExportMetadataRequest

Request message for `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.DataprocMetastore.ExportMetadata`.

| Fields ||
|---|---|
| `service` | `string` Required. The relative resource name of the metastore service to run export, in the following form: `projects/{project_id}/locations/{location_id}/services/{service_id}`. Authorization requires the following [IAM](https://cloud.google.com/iam/docs/) permission on the specified resource `service`: - `metastore.services.export` |
| `request_id` | `string` Optional. A request ID. Specify a unique request ID to allow the server to ignore the request if it has completed. The server will ignore subsequent requests that provide a duplicate request ID for at least 60 minutes after the first request. For example, if an initial request times out, followed by another request with the same request ID, the server ignores the second request to prevent the creation of duplicate commitments. The request ID must be a valid [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier#Format). A zero UUID (00000000-0000-0000-0000-000000000000) is not supported. |
| `database_dump_type` | `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.DatabaseDumpSpec.Type` Optional. The type of the database dump. If unspecified, defaults to `MYSQL`. |
| Union field `destination`. Required. Destination that metadata is exported to. `destination` can be only one of the following: ||
| `destination_gcs_folder` | `string` A Cloud Storage URI of a folder, in the format `gs://<bucket_name>/<path_inside_bucket>`. A sub-folder `<export_folder>` containing exported files will be created below it. |

## Federation

Represents a federation of multiple backend metastores.

| Fields ||
|---|---|
| `name` | `string` Immutable. The relative resource name of the federation, of the form: projects/{project_number}/locations/{location_id}/federations/{federation_id}\`. |
| `create_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Output only. The time when the metastore federation was created. |
| `update_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Output only. The time when the metastore federation was last updated. |
| `labels` | `map<string, string>` User-defined labels for the metastore federation. |
| `version` | `string` Immutable. The Apache Hive metastore version of the federation. All backend metastore versions must be compatible with the federation version. |
| `backend_metastores` | ``map<int32, `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.BackendMetastore`>`` A map from `BackendMetastore` rank to `BackendMetastore`s from which the federation service serves metadata at query time. The map key represents the order in which `BackendMetastore`s should be evaluated to resolve database names at query time and should be greater than or equal to zero. A `BackendMetastore` with a lower number will be evaluated before a `BackendMetastore` with a higher number. |
| `endpoint_uri` | `string` Output only. The federation endpoint. |
| `state` | `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.Federation.State` Output only. The current state of the federation. |
| `state_message` | `string` Output only. Additional information about the current state of the metastore federation, if available. |
| `uid` | `string` Output only. The globally unique resource identifier of the metastore federation. |
| `tags` | `map<string, string>` Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing" |

## State

The current state of the federation.

| Enums ||
|---|---|
| `STATE_UNSPECIFIED` | The state of the metastore federation is unknown. |
| `CREATING` | The metastore federation is in the process of being created. |
| `ACTIVE` | The metastore federation is running and ready to serve queries. |
| `UPDATING` | The metastore federation is being updated. It remains usable but cannot accept additional update requests or be deleted at this time. |
| `DELETING` | The metastore federation is undergoing deletion. It cannot be used. |
| `ERROR` | The metastore federation has encountered an error and cannot be used. The metastore federation should be deleted. |

## GetBackupRequest

Request message for `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.DataprocMetastore.GetBackup`.

| Fields ||
|---|---|
| `name` | `string` 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}`. Authorization requires the following [IAM](https://cloud.google.com/iam/docs/) permission on the specified resource `name`: - `metastore.backups.get` |

## GetFederationRequest

Request message for GetFederation.

| Fields ||
|---|---|
| `name` | `string` Required. The relative resource name of the metastore federation to retrieve, in the following form: `projects/{project_number}/locations/{location_id}/federations/{federation_id}`. Authorization requires the following [IAM](https://cloud.google.com/iam/docs/) permission on the specified resource `name`: - `metastore.federations.get` |

## GetMetadataImportRequest

Request message for `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.DataprocMetastore.GetMetadataImport`.

| Fields ||
|---|---|
| `name` | `string` 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}`. Authorization requires the following [IAM](https://cloud.google.com/iam/docs/) permission on the specified resource `name`: - `metastore.imports.get` |

## GetMigrationExecutionRequest

Request message for `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.DataprocMetastore.GetMigrationExecution`.

| Fields ||
|---|---|
| `name` | `string` Required. The relative resource name of the migration execution to retrieve, in the following form: `projects/{project_number}/locations/{location_id}/services/{service_id}/migrationExecutions/{migration_execution_id}`. Authorization requires the following [IAM](https://cloud.google.com/iam/docs/) permission on the specified resource `name`: - `metastore.migrations.get` |

## GetServiceRequest

Request message for `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.DataprocMetastore.GetService`.

| Fields ||
|---|---|
| `name` | `string` Required. The relative resource name of the metastore service to retrieve, in the following form: `projects/{project_number}/locations/{location_id}/services/{service_id}`. Authorization requires the following [IAM](https://cloud.google.com/iam/docs/) permission on the specified resource `name`: - `metastore.services.get` |

## HiveMetastoreConfig

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

| Fields ||
|---|---|
| `version` | `string` Immutable. The Hive metastore schema version. |
| `config_overrides` | `map<string, string>` Optional. A mapping of Hive metastore configuration key-value pairs to apply to the Hive metastore (configured in `hive-site.xml`). The mappings override system defaults (some keys cannot be overridden). These overrides are also applied to auxiliary versions and can be further customized in the auxiliary version's `AuxiliaryVersionConfig`. |
| `kerberos_config` | `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.KerberosConfig` Optional. Information used to configure the Hive metastore service as a service principal in a Kerberos realm. To disable Kerberos, use the `UpdateService` method and specify this field's path (`hive_metastore_config.kerberos_config`) in the request's `update_mask` while omitting this field from the request's `service`. |
| `endpoint_protocol` | `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.HiveMetastoreConfig.EndpointProtocol` Optional. The protocol to use for the metastore service endpoint. If unspecified, defaults to `THRIFT`. |
| `auxiliary_versions` | ``map<string, `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.AuxiliaryVersionConfig`>`` Optional. A mapping of Hive metastore version to the auxiliary version configuration. When specified, a secondary Hive metastore service is created along with the primary service. All auxiliary versions must be less than the service's primary version. The key is the auxiliary service name and it must match the regular expression [a-z](https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/[-a-z0-9]*[a-z0-9])?. This means that the first character must be a lowercase letter, and all the following characters must be hyphens, lowercase letters, or digits, except the last character, which cannot be a hyphen. |

## EndpointProtocol

Protocols available for serving the metastore service endpoint.

| Enums ||
|---|---|
| `ENDPOINT_PROTOCOL_UNSPECIFIED` | The protocol is not set. |
| `THRIFT` | Use the legacy Apache Thrift protocol for the metastore service endpoint. |
| `GRPC` | Use the modernized gRPC protocol for the metastore service endpoint. |

## KerberosConfig

Configuration information for a Kerberos principal.

| Fields ||
|---|---|
| `keytab` | `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.Secret` Optional. A Kerberos keytab file that can be used to authenticate a service principal with a Kerberos Key Distribution Center (KDC). |
| `principal` | `string` Optional. A Kerberos principal that exists in the both the keytab the KDC to authenticate as. A typical principal is of the form `primary/instance@REALM`, but there is no exact format. |
| `krb5_config_gcs_uri` | `string` Optional. A Cloud Storage URI that specifies the path to a krb5.conf file. It is of the form `gs://{bucket_name}/path/to/krb5.conf`, although the file does not need to be named krb5.conf explicitly. |

## Lake

Represents a Lake resource

| Fields ||
|---|---|
| `name` | `string` The Lake resource name. Example: `projects/{project_number}/locations/{location_id}/lakes/{lake_id}` |

## LatestBackup

The details of the latest scheduled backup.

| Fields ||
|---|---|
| `backup_id` | `string` Output only. The ID of an in-progress scheduled backup. Empty if no backup is in progress. |
| `start_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Output only. The time when the backup was started. |
| `state` | `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.LatestBackup.State` Output only. The current state of the backup. |
| `duration` | `https://protobuf.dev/reference/protobuf/google.protobuf#duration` Output only. The duration of the backup completion. |

## State

The current state of the backup.

| Enums ||
|---|---|
| `STATE_UNSPECIFIED` | The state of the backup is unknown. |
| `IN_PROGRESS` | The backup is in progress. |
| `SUCCEEDED` | The backup completed. |
| `FAILED` | The backup failed. |

## LimitConfig

Represents the autoscaling limit configuration of a metastore service.

| Fields ||
|---|---|
| `max_scaling_factor` | `float` Optional. The highest scaling factor that the service should be autoscaled to. |
| `min_scaling_factor` | `float` Optional. The lowest scaling factor that the service should be autoscaled to. |

## ListBackupsRequest

Request message for `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.DataprocMetastore.ListBackups`.

| Fields ||
|---|---|
| `parent` | `string` 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`. Authorization requires the following [IAM](https://cloud.google.com/iam/docs/) permission on the specified resource `parent`: - `metastore.backups.list` |
| `page_size` | `int32` Optional. The maximum number of backups to return. The response may contain less than the maximum number. If unspecified, no more than 500 backups are returned. The maximum value is 1000; values above 1000 are changed to 1000. |
| `page_token` | `string` Optional. A page token, received from a previous `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.DataprocMetastore.ListBackups` call. Provide this token to retrieve the subsequent page. To retrieve the first page, supply an empty page token. When paginating, other parameters provided to `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.DataprocMetastore.ListBackups` must match the call that provided the page token. |
| `filter` | `string` Optional. The filter to apply to list results. |
| `order_by` | `string` Optional. Specify the ordering of results as described in [Sorting Order](https://cloud.google.com/apis/design/design_patterns#sorting_order). If not specified, the results will be sorted in the default order. |

## ListBackupsResponse

Response message for `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.DataprocMetastore.ListBackups`.

| Fields ||
|---|---|
| `backups[]` | `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.Backup` The backups of the specified service. |
| `next_page_token` | `string` A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. |
| `unreachable[]` | `string` Locations that could not be reached. |

## ListFederationsRequest

Request message for ListFederations.

| Fields ||
|---|---|
| `parent` | `string` Required. The relative resource name of the location of metastore federations to list, in the following form: `projects/{project_number}/locations/{location_id}`. Authorization requires the following [IAM](https://cloud.google.com/iam/docs/) permission on the specified resource `parent`: - `metastore.federations.list` |
| `page_size` | `int32` Optional. The maximum number of federations to return. The response may contain less than the maximum number. If unspecified, no more than 500 services are returned. The maximum value is 1000; values above 1000 are changed to 1000. |
| `page_token` | `string` Optional. A page token, received from a previous ListFederationServices call. Provide this token to retrieve the subsequent page. To retrieve the first page, supply an empty page token. When paginating, other parameters provided to ListFederationServices must match the call that provided the page token. |
| `filter` | `string` Optional. The filter to apply to list results. |
| `order_by` | `string` Optional. Specify the ordering of results as described in [Sorting Order](https://cloud.google.com/apis/design/design_patterns#sorting_order). If not specified, the results will be sorted in the default order. |

## ListFederationsResponse

Response message for ListFederations

| Fields ||
|---|---|
| `federations[]` | `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.Federation` The services in the specified location. |
| `next_page_token` | `string` A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. |
| `unreachable[]` | `string` Locations that could not be reached. |

## ListMetadataImportsRequest

Request message for `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.DataprocMetastore.ListMetadataImports`.

| Fields ||
|---|---|
| `parent` | `string` 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`. Authorization requires the following [IAM](https://cloud.google.com/iam/docs/) permission on the specified resource `parent`: - `metastore.imports.list` |
| `page_size` | `int32` Optional. The maximum number of imports to return. The response may contain less than the maximum number. If unspecified, no more than 500 imports are returned. The maximum value is 1000; values above 1000 are changed to 1000. |
| `page_token` | `string` Optional. A page token, received from a previous `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.DataprocMetastore.ListServices` call. Provide this token to retrieve the subsequent page. To retrieve the first page, supply an empty page token. When paginating, other parameters provided to `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.DataprocMetastore.ListServices` must match the call that provided the page token. |
| `filter` | `string` Optional. The filter to apply to list results. |
| `order_by` | `string` Optional. Specify the ordering of results as described in [Sorting Order](https://cloud.google.com/apis/design/design_patterns#sorting_order). If not specified, the results will be sorted in the default order. |

## ListMetadataImportsResponse

Response message for `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.DataprocMetastore.ListMetadataImports`.

| Fields ||
|---|---|
| `metadata_imports[]` | `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.MetadataImport` The imports in the specified service. |
| `next_page_token` | `string` A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. |
| `unreachable[]` | `string` Locations that could not be reached. |

## ListMigrationExecutionsRequest

Request message for `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.DataprocMetastore.ListMigrationExecutions`.

| Fields ||
|---|---|
| `parent` | `string` Required. The relative resource name of the service whose migration executions to list, in the following form: `projects/{project_number}/locations/{location_id}/services/{service_id}/migrationExecutions`. Authorization requires the following [IAM](https://cloud.google.com/iam/docs/) permission on the specified resource `parent`: - `metastore.migrations.list` |
| `page_size` | `int32` Optional. The maximum number of migration executions to return. The response may contain less than the maximum number. If unspecified, no more than 500 migration executions are returned. The maximum value is 1000; values above 1000 are changed to 1000. |
| `page_token` | `string` Optional. A page token, received from a previous `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.DataprocMetastore.ListMigrationExecutions` call. Provide this token to retrieve the subsequent page. To retrieve the first page, supply an empty page token. When paginating, other parameters provided to `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.DataprocMetastore.ListMigrationExecutions` must match the call that provided the page token. |
| `filter` | `string` Optional. The filter to apply to list results. |
| `order_by` | `string` Optional. Specify the ordering of results as described in [Sorting Order](https://cloud.google.com/apis/design/design_patterns#sorting_order). If not specified, the results will be sorted in the default order. |

## ListMigrationExecutionsResponse

Response message for `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.DataprocMetastore.ListMigrationExecutions`.

| Fields ||
|---|---|
| `migration_executions[]` | `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.MigrationExecution` The migration executions on the specified service. |
| `next_page_token` | `string` A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. |
| `unreachable[]` | `string` Locations that could not be reached. |

## ListServicesRequest

Request message for `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.DataprocMetastore.ListServices`.

| Fields ||
|---|---|
| `parent` | `string` Required. The relative resource name of the location of metastore services to list, in the following form: `projects/{project_number}/locations/{location_id}`. Authorization requires the following [IAM](https://cloud.google.com/iam/docs/) permission on the specified resource `parent`: - `metastore.services.list` |
| `page_size` | `int32` Optional. The maximum number of services to return. The response may contain less than the maximum number. If unspecified, no more than 500 services are returned. The maximum value is 1000; values above 1000 are changed to 1000. |
| `page_token` | `string` Optional. A page token, received from a previous `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.DataprocMetastore.ListServices` call. Provide this token to retrieve the subsequent page. To retrieve the first page, supply an empty page token. When paginating, other parameters provided to `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.DataprocMetastore.ListServices` must match the call that provided the page token. |
| `filter` | `string` Optional. The filter to apply to list results. |
| `order_by` | `string` Optional. Specify the ordering of results as described in [Sorting Order](https://cloud.google.com/apis/design/design_patterns#sorting_order). If not specified, the results will be sorted in the default order. |

## ListServicesResponse

Response message for `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.DataprocMetastore.ListServices`.

| Fields ||
|---|---|
| `services[]` | `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.Service` The services in the specified location. |
| `next_page_token` | `string` A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. |
| `unreachable[]` | `string` Locations that could not be reached. |

## LocationMetadata

Metadata about the service in a location.

| Fields ||
|---|---|
| `supported_hive_metastore_versions[]` | `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.LocationMetadata.HiveMetastoreVersion` The versions of Hive Metastore that can be used when creating a new metastore service in this location. The server guarantees that exactly one `HiveMetastoreVersion` in the list will set `is_default`. |
| `multi_region_metadata (deprecated)` | `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.LocationMetadata.MultiRegionMetadata` > [!WARNING] > This item is deprecated! Deprecated: Use a single region service instead. The multi-region metadata if the current region is a multi-region. |
| `custom_region_metadata[] (deprecated)` | `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.LocationMetadata.CustomRegionMetadata` > [!WARNING] > This item is deprecated! Deprecated: Use a single region service instead. Possible configurations supported if the current region is a custom region. |

## CustomRegionMetadata

> [!WARNING]
> This item is deprecated!

Deprecated: Use a single region service instead. Metadata about a custom region. This is only populated if the region is a custom region. For single/multi regions, it will be empty.

| Fields ||
|---|---|
| `required_read_write_regions[]` | `string` The read-write regions for this custom region. |
| `optional_read_only_regions[]` | `string` The read-only regions for this custom region. |
| `witness_region` | `string` The Spanner witness region for this custom region. |

## HiveMetastoreVersion

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

| Fields ||
|---|---|
| `version` | `string` The semantic version of the Hive Metastore software. |
| `is_default` | `bool` Whether `version` will be chosen by the server if a metastore service is created with a `HiveMetastoreConfig` that omits the `version`. |

## MultiRegionMetadata

> [!WARNING]
> This item is deprecated!

Deprecated: Use a single region service instead. The metadata for the multi-region that includes the constituent regions. The metadata is only populated if the region is multi-region. For single region or custom dual region, it will be empty.

| Fields ||
|---|---|
| `constituent_regions[]` | `string` The regions constituting the multi-region. |
| `witness_region` | `string` The Spanner witness region for this multi-region. |
| `continent` | `string` The continent for this multi-region. |

## MaintenanceWindow

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

| Fields ||
|---|---|
| `hour_of_day` | `https://protobuf.dev/reference/protobuf/google.protobuf#int32-value` Optional. The hour of day (0-23) when the window starts. |
| `day_of_week` | `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.type#google.type.DayOfWeek` Optional. The day of week, when the window starts. |

## MetadataExport

The details of a metadata export operation.

| Fields ||
|---|---|
| `start_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Output only. The time when the export started. |
| `end_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Output only. The time when the export ended. |
| `state` | `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.MetadataExport.State` Output only. The current state of the export. |
| `database_dump_type` | `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.DatabaseDumpSpec.Type` Output only. The type of the database dump. |
| Union field `destination`. `destination` can be only one of the following: ||
| `destination_gcs_uri` | `string` Output only. A Cloud Storage URI of a folder that metadata are exported to, in the form of `gs://<bucket_name>/<path_inside_bucket>/<export_folder>`, where `<export_folder>` is automatically generated. |

## State

The current state of the metadata export.

| Enums ||
|---|---|
| `STATE_UNSPECIFIED` | The state of the metadata export is unknown. |
| `RUNNING` | The metadata export is running. |
| `SUCCEEDED` | The metadata export completed successfully. |
| `FAILED` | The metadata export failed. |
| `CANCELLED` | The metadata export is cancelled. |

## MetadataImport

A metastore resource that imports metadata.

| Fields ||
|---|---|
| `name` | `string` Immutable. Identifier. The relative resource name of the metadata import, of the form: `projects/{project_number}/locations/{location_id}/services/{service_id}/metadataImports/{metadata_import_id}`. |
| `description` | `string` Optional. The description of the metadata import. |
| `create_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Output only. The time when the metadata import was started. |
| `update_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Output only. The time when the metadata import was last updated. |
| `end_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Output only. The time when the metadata import finished. |
| `state` | `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.MetadataImport.State` Output only. The current state of the metadata import. |
| Union field `metadata`. The metadata to be imported. `metadata` can be only one of the following: ||
| `database_dump` | `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.MetadataImport.DatabaseDump` Immutable. A database dump from a pre-existing metastore's database. |

## DatabaseDump

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

| Fields ||
|---|---|
| `database_type (deprecated)` | `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.MetadataImport.DatabaseDump.DatabaseType` > [!WARNING] > This item is deprecated! The type of the database. |
| `gcs_uri` | `string` Optional. A Cloud Storage object or folder URI that specifies the source from which to import metadata. It must begin with `gs://`. |
| `source_database (deprecated)` | `string` > [!WARNING] > This item is deprecated! Optional. The name of the source database. |
| `type` | `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.DatabaseDumpSpec.Type` Optional. The type of the database dump. If unspecified, defaults to `MYSQL`. |

## DatabaseType

The type of the database.

| Enums ||
|---|---|
| `DATABASE_TYPE_UNSPECIFIED` | The type of the source database is unknown. |
| `MYSQL` | The type of the source database is MySQL. |

## State

The current state of the metadata import.

| Enums ||
|---|---|
| `STATE_UNSPECIFIED` | The state of the metadata import is unknown. |
| `RUNNING` | The metadata import is running. |
| `SUCCEEDED` | The metadata import completed successfully. |
| `UPDATING` | The metadata import is being updated. |
| `FAILED` | The metadata import failed, and attempted metadata changes were rolled back. |

## MetadataIntegration

Specifies how metastore metadata should be integrated with external services.

| Fields ||
|---|---|
| `data_catalog_config` | `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.DataCatalogConfig` Optional. The integration config for the Data Catalog service. |
| `dataplex_config` | `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.DataplexConfig` Optional. The integration config for the Dataplex service. |

## MetadataManagementActivity

The metadata management activities of the metastore service.

| Fields ||
|---|---|
| `metadata_exports[]` | `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.MetadataExport` Output only. The latest metadata exports of the metastore service. |
| `restores[]` | `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.Restore` Output only. The latest restores of the metastore service. |

## MigrationExecution

The details of a migration execution resource.

| Fields ||
|---|---|
| `name` | `string` Output only. The relative resource name of the migration execution, in the following form: `projects/{project_number}/locations/{location_id}/services/{service_id}/migrationExecutions/{migration_execution_id}` |
| `create_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Output only. The time when the migration execution was started. |
| `end_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Output only. The time when the migration execution finished. |
| `state` | `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.MigrationExecution.State` Output only. The current state of the migration execution. |
| `phase (deprecated)` | `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.MigrationExecution.Phase` > [!WARNING] > This item is deprecated! Output only. Deprecated: Phase was designed for incoming migrations to Dataproc Metastore, not applicable when migrating away from it. The current phase of the migration execution. |
| `state_message` | `string` Output only. Additional information about the current state of the migration execution. |
| Union field `migration_config`. Configuration information required by Dataproc Metastore for starting the migration process `migration_config` can be only one of the following: ||
| `biglake_metastore_migration_config` | `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.MigrationExecution.BigLakeMetastoreMigrationConfig` Configuration information specific to migrating from Dataproc Metastore to BigLake Metastore. |

## BigLakeMetastoreMigrationConfig

Defines the configuration required to migrate metadata from a Dataproc Metastore service to BigLake Metastore.

| Fields ||
|---|---|
| `mode` | `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.MigrationExecution.BigLakeMetastoreMigrationConfig.MigrationMode` Required. Defines the behavior of the migration execution. |
| `dry_run` | `bool` Optional. If true, performs discovery of requested resources and analysis against the target catalog to come up with a plan for each resource (e.g. Create, Update, Skip, etc.). No metadata is actually migrated. |
| `report_path` | `string` Optional. The Cloud Storage path where the backfill / dry run report should be written. If not provided, the report will be generated in the service's artifacts bucket. Format: "gs://path/to/folder" |
| `hive_config` | `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.MigrationExecution.BigLakeMetastoreMigrationConfig.HiveConfig` Optional. At least one of `hive_config` or `iceberg_config` must be provided, otherwise, a validation error will be thrown. If only one is provided, the service only migrates tables of that specific type. If both are provided, both Hive and Iceberg tables will be migrated. Configuration for migrating Hive tables to a BigLake Hive catalog. |
| `iceberg_config` | `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.MigrationExecution.BigLakeMetastoreMigrationConfig.IcebergConfig` Optional. Configuration for migrating Iceberg tables to a BigLake Iceberg REST catalog. |
| `backfill_status` | `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.MigrationExecution.BigLakeMetastoreMigrationConfig.BackfillStatus` Output only. |
| `conflict_policy` | `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.MigrationExecution.BigLakeMetastoreMigrationConfig.ConflictPolicy` Optional. The policy to handle conflicts when migrating resources, defaults to SKIP if not specified. |

## BackfillStatus

Backfill status for the migration execution.

| Fields ||
|---|---|
| `state` | `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.MigrationExecution.BigLakeMetastoreMigrationConfig.BackfillStatus.State` Output only. The current state of the backfill (or dry run). |
| `report_path` | `string` Output only. The Cloud Storage path where the backfill or dry run report is written. Format: "gs://path-to-report". |
| `migration_summary` | `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.MigrationSummary` Output only. Summary of the migration results. This is populated after the backfill or dry run is finished. |

## State

The backfill state.

| Enums ||
|---|---|
| `STATE_UNSPECIFIED` | The backfill state is unspecified. |
| `PENDING` | Waiting to start. |
| `RUNNING` | Backfill in progress. |
| `SUCCEEDED` | Backfill complete, report is available |
| `FAILED` | Backfill failed; check report for details |

## ConflictPolicy

The policy to handle conflicts when migrating resources to Lakehouse.

| Enums ||
|---|---|
| `CONFLICT_POLICY_UNSPECIFIED` | The conflict policy is unspecified. |
| `SKIP` | Skip migrating resources that already exist in the target catalog. |
| `OVERWRITE` | Update resources that already exist in the target catalog. |

## HiveConfig

Configuration for migrating Hive metadata.

| Fields ||
|---|---|
| `catalog` | `string` Required. The target catalog for migrated databases and tables. Format: "projects/{project_id_or_number}/catalogs/{catalog_id}" |
| `databases[]` | `string` Required. The list of databases to migrate to the Hive catalog. Use "\*" to migrate all databases. Note: If Iceberg tables exist in these databases, they will only be migrated if `iceberg_config` is also specified. |

## IcebergConfig

Configuration for migrating Iceberg metadata.

| Fields ||
|---|---|
| `catalog` | `string` Required. The target catalog for migrated Iceberg metadata. Format: "projects/{project_id_or_number}/catalogs/{catalog_id}" |
| `namespaces[]` | `string` Required. The list of namespaces to migrate to the Iceberg REST catalog. Use "\*" to migrate all namespaces. Note: If Hive tables exist in these namespaces, they will only be migrated if `hive_config` is also specified. |

## MigrationMode

The execution mode of the migration.

| Enums ||
|---|---|
| `MIGRATION_MODE_UNSPECIFIED` | The migration mode is unspecified. |
| `BACKFILL` | Performs the metadata migration of requested resources. The migration completes once the backfill is finished. |
| `INCREMENTAL_SYNC` | Performs the initial backfill, then transitions to an incremental synchronization state to replicate ongoing source writes. Requires an explicit CompleteMigration or CancelMigration call to end the migration. Note: Supported only for Iceberg migrations. |

## Phase

Deprecated: Phase was designed for incoming migrations to Dataproc Metastore, not applicable when migrating away from it. The current phase of the migration execution.

| Enums ||
|---|---|
| `PHASE_UNSPECIFIED` | The phase of the migration execution is unknown. |
| `REPLICATION` | Replication phase refers to the migration phase when Dataproc Metastore is running a pipeline to replicate changes in the customer database to its backend database. During this phase, Dataproc Metastore uses the customer database as the hive metastore backend database. |
| `CUTOVER` | Cutover phase refers to the migration phase when Dataproc Metastore switches to using its own backend database. Migration enters this phase when customer is done migrating all their clusters/workloads to Dataproc Metastore and triggers `CompleteMigration`. |

## State

The current state of the migration execution.

| Enums ||
|---|---|
| `STATE_UNSPECIFIED` | The state of the migration execution is unknown. |
| `STARTING` | The migration execution is starting. |
| `RUNNING` | The migration execution is running. |
| `CANCELLING` | The migration execution is in the process of being cancelled. |
| `AWAITING_USER_ACTION` | The migration execution is awaiting user action. |
| `SUCCEEDED` | The migration execution has completed successfully. |
| `FAILED` | The migration execution has failed. |
| `CANCELLED` | The migration execution is cancelled. |
| `DELETING` | The migration execution is being deleted. |
| `ROLLED_BACK` | The migration execution has been rolled back. This occurs when CancelMigration is invoked after the migration has completed and the metastore service is in the PROXY state, returning the service to the ACTIVE state. This enables rollback support when the customer wants to resume using DPMS after a successful migration. |

## MigrationReport

Report containing the results of a migration run. This report is generated at the specified path in the `BigLakeMetastoreMigrationConfig` after the backfill is complete, or when a dry run is executed.

| Fields ||
|---|---|
| `summary` | `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.MigrationSummary` Output only. High-level summary of the migration results. |
| `catalog_reports[]` | `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.CatalogReport` Output only. Detailed results for each catalog involved in the migration. |

## MigrationSummary

Summary of the migration results.

| Fields ||
|---|---|
| `create_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Output only. The UTC time when this report was finalized. |
| `service` | `string` Output only. The Dataproc Metastore service name (format: projects/\*/locations/\*/services/\*) on which the migration was executed. |
| `dry_run` | `bool` Output only. Whether the migration was a dry run. |
| `catalog_summaries[]` | `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.CatalogSummary` Output only. Summary of results for each catalog involved in the migration. |

## MoveTableToDatabaseRequest

Request message for `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.DataprocMetastore.MoveTableToDatabase`.

| Fields ||
|---|---|
| `service` | `string` Required. The relative resource name of the metastore service to mutate metadata, in the following format: `projects/{project_id}/locations/{location_id}/services/{service_id}`. Authorization requires the following [IAM](https://cloud.google.com/iam/docs/) permission on the specified resource `service`: - `metastore.services.mutateMetadata` |
| `table_name` | `string` Required. The name of the table to be moved. |
| `db_name` | `string` Required. The name of the database where the table resides. |
| `destination_db_name` | `string` Required. The name of the database where the table should be moved. |

## MoveTableToDatabaseResponse

This type has no fields.
Response message for `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.DataprocMetastore.MoveTableToDatabase`.

## MultiRegionConfig

> [!WARNING]
> This item is deprecated!

Deprecated: Use a single region service instead. The multi-region config for the Dataproc Metastore service.

| Fields ||
|---|---|
| `certificates[] (deprecated)` | `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.MultiRegionConfig.RootCACertificate` > [!WARNING] > This item is deprecated! Output only. Deprecated: Use a single region service instead. The list of root CA certificates that a gRPC client uses to connect to a multi-regional Dataproc Metastore service. |
| `custom_region_config (deprecated)` | `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.MultiRegionConfig.CustomRegionConfig` > [!WARNING] > This item is deprecated! Immutable. Deprecated: Use a single region service instead. |

## CustomRegionConfig

> [!WARNING]
> This item is deprecated!

Deprecated: Use a single region service instead. Custom configuration used to specify regions that the metastore service runs in. Currently only supported in the `us` multi-region.

| Fields ||
|---|---|
| `read_write_regions[]` | `string` Required. The list of read-write regions where the metastore service runs in. These regions should be part (or subset) of the multi-region. |
| `read_only_regions[]` | `string` Optional. The list of read-only regions where the metastore service runs in. These regions should be part (or subset) of the multi-region. |

## RootCACertificate

> [!WARNING]
> This item is deprecated!

Deprecated: Use a single region service instead. A gRPC client must install all root CA certificates to connect to a multi-regional Dataproc Metastore service and achieve failover.

| Fields ||
|---|---|
| `certificate (deprecated)` | `string` > [!WARNING] > This item is deprecated! Deprecated: Use a single region service instead. The root CA certificate in PEM format. The maximum length is 65536 bytes. |
| `expiration_time (deprecated)` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` > [!WARNING] > This item is deprecated! Deprecated: Use a single region service instead. The certificate expiration time in timestamp format. |

## NetworkConfig

Network configuration for the Dataproc Metastore service.

| Fields ||
|---|---|
| `consumers[]` | `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.NetworkConfig.Consumer` Immutable. The consumer-side network configuration for the Dataproc Metastore instance. |
| `custom_routes_enabled` | `bool` Optional. Enables custom routes to be imported and exported for the Dataproc Metastore service's peered VPC network. |

## Consumer

Contains information of the customer's network configurations.

| Fields ||
|---|---|
| `endpoint_uri` | `string` Output only. The URI of the endpoint used to access the metastore service. |
| `endpoint_location` | `string` Output only. The location of the endpoint URI. Format: `projects/{project}/locations/{location}`. |
| Union field `vpc_resource`. `vpc_resource` can be only one of the following: ||
| `subnetwork` | `string` Immutable. The subnetwork of the customer project from which an IP address is reserved and used as the Dataproc Metastore service's endpoint. It is accessible to hosts in the subnet and to all hosts in a subnet in the same region and same network. There must be at least one IP address available in the subnet's primary range. The subnet is specified in the following form: `projects/{project_number}/regions/{region_id}/subnetworks/{subnetwork_id}` |

## OperationMetadata

Represents the metadata of a long-running operation.

| Fields ||
|---|---|
| `create_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Output only. The time the operation was created. |
| `end_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Output only. The time the operation finished running. |
| `target` | `string` Output only. Server-defined resource path for the target of the operation. |
| `verb` | `string` Output only. Name of the verb executed by the operation. |
| `status_message` | `string` Output only. Human-readable status of the operation, if any. |
| `requested_cancellation` | `bool` Output only. Identifies whether the caller has requested cancellation of the operation. Operations that have successfully been cancelled have `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.longrunning#google.longrunning.Operation.FIELDS.google.rpc.Status.google.longrunning.Operation.error` value with a `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.rpc#google.rpc.Status.FIELDS.int32.google.rpc.Status.code` of 1, corresponding to `Code.CANCELLED`. |
| `api_version` | `string` Output only. API version used to start the operation. |

## PartitionReport

Partition migration report for a Hive table.

| Fields ||
|---|---|
| `state` | `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.PartitionReport.State` Output only. The state of the partition migration. |
| `partition_success_count` | `int64` The number of partitions successfully migrated at the target. |
| `partition_failed_count` | `int64` The number of partitions that failed to migrate at the target. |

## State

The state of the partition migration.

| Enums ||
|---|---|
| `STATE_UNSPECIFIED` | The state is unspecified. |
| `SUCCEEDED` | All partitions migrated successfully at the target. |
| `PARTIALLY_SUCCEEDED` | Some partitions migrated successfully at the target, but others failed. |
| `FAILED` | All partitions failed to migrate at the target. |

## QueryMetadataRequest

Request message for `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.DataprocMetastore.QueryMetadata`.

| Fields ||
|---|---|
| `service` | `string` Required. The relative resource name of the metastore service to query metadata, in the following format: `projects/{project_id}/locations/{location_id}/services/{service_id}`. Authorization requires the following [IAM](https://cloud.google.com/iam/docs/) permission on the specified resource `service`: - `metastore.services.queryMetadata` |
| `query` | `string` Required. A read-only SQL query to execute against the metadata database. The query cannot change or mutate the data. |

## QueryMetadataResponse

Response message for `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.DataprocMetastore.QueryMetadata`.

| Fields ||
|---|---|
| `result_manifest_uri` | `string` The manifest URI is link to a JSON instance in Cloud Storage. This instance manifests immediately along with QueryMetadataResponse. The content of the URI is not retriable until the long-running operation query against the metadata finishes. |

## RemoveIamPolicyRequest

Request message for `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.DataprocMetastore.RemoveIamPolicy`.

| Fields ||
|---|---|
| `resource` | `string` Required. The relative resource name of the dataplane resource to remove IAM policy, in the following form: `projects/{project_id}/locations/{location_id}/services/{service_id}/databases/{database_id}` or `projects/{project_id}/locations/{location_id}/services/{service_id}/databases/{database_id}/tables/{table_id}`. |
| `asynchronous` | `bool` Optional. Removes IAM policy attached to database or table asynchronously when it is set. The default is false. |

## RemoveIamPolicyResponse

Response message for `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.DataprocMetastore.RemoveIamPolicy`.

| Fields ||
|---|---|
| `success` | `bool` True if the policy is successfully removed. |

## Restore

The details of a metadata restore operation.

| Fields ||
|---|---|
| `start_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Output only. The time when the restore started. |
| `end_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Output only. The time when the restore ended. |
| `state` | `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.Restore.State` Output only. The current state of the restore. |
| `backup` | `string` Output only. 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}`. |
| `type` | `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.Restore.RestoreType` Output only. The type of restore. |
| `details` | `string` Output only. The restore details containing the revision of the service to be restored to, in format of JSON. |
| `backup_location` | `string` Optional. A Cloud Storage URI specifying where the backup artifacts are stored, in the format `gs://<bucket_name>/<path_inside_bucket>`. |

## RestoreType

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

| Enums ||
|---|---|
| `RESTORE_TYPE_UNSPECIFIED` | The restore type is unknown. |
| `FULL` | The service's metadata and configuration are restored. |
| `METADATA_ONLY` | Only the service's metadata is restored. |

## State

The current state of the restore.

| Enums ||
|---|---|
| `STATE_UNSPECIFIED` | The state of the metadata restore is unknown. |
| `RUNNING` | The metadata restore is running. |
| `SUCCEEDED` | The metadata restore completed successfully. |
| `FAILED` | The metadata restore failed. |
| `CANCELLED` | The metadata restore is cancelled. |

## RestoreServiceRequest

Request message for `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.DataprocMetastore.RestoreService`.

| Fields ||
|---|---|
| `service` | `string` 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}`. Authorization requires the following [IAM](https://cloud.google.com/iam/docs/) permission on the specified resource `service`: - `metastore.services.restore` |
| `backup` | `string` Optional. 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}`. Mutually exclusive with `backup_location`, and exactly one of the two must be set. Authorization requires the following [IAM](https://cloud.google.com/iam/docs/) permission on the specified resource `backup`: - `metastore.backups.use` |
| `backup_location` | `string` Optional. A Cloud Storage URI specifying the location of the backup artifacts, namely - backup avro files under "avro/", backup_metastore.json and service.json, in the following form: `gs://<path_to_backup>`. Mutually exclusive with `backup`, and exactly one of the two must be set. |
| `restore_type` | `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.Restore.RestoreType` Optional. The type of restore. If unspecified, defaults to `METADATA_ONLY`. |
| `request_id` | `string` Optional. A request ID. Specify a unique request ID to allow the server to ignore the request if it has completed. The server will ignore subsequent requests that provide a duplicate request ID for at least 60 minutes after the first request. For example, if an initial request times out, followed by another request with the same request ID, the server ignores the second request to prevent the creation of duplicate commitments. The request ID must be a valid [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier#Format). A zero UUID (00000000-0000-0000-0000-000000000000) is not supported. |

## ScalingConfig

Represents the scaling configuration of a metastore service.

| Fields ||
|---|---|
| `autoscaling_config` | `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.AutoscalingConfig` Optional. The autoscaling configuration. |
| Union field `scaling_model`. Represents either a predetermined instance size or a numeric scaling factor. `scaling_model` can be only one of the following: ||
| `instance_size` | `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.ScalingConfig.InstanceSize` An enum of readable instance sizes, with each instance size mapping to a float value (e.g. InstanceSize.EXTRA_SMALL = scaling_factor(0.1)) |
| `scaling_factor` | `float` Scaling factor, increments of 0.1 for values less than 1.0, and increments of 1.0 for values greater than 1.0. |

## InstanceSize

Metastore instance sizes.

| Enums ||
|---|---|
| `INSTANCE_SIZE_UNSPECIFIED` | Unspecified instance size |
| `EXTRA_SMALL` | Extra small instance size, maps to a scaling factor of 0.1. |
| `SMALL` | Small instance size, maps to a scaling factor of 0.5. |
| `MEDIUM` | Medium instance size, maps to a scaling factor of 1.0. |
| `LARGE` | Large instance size, maps to a scaling factor of 3.0. |
| `EXTRA_LARGE` | Extra large instance size, maps to a scaling factor of 6.0. |

## ScheduledBackup

This specifies the configuration of scheduled backup.

| Fields ||
|---|---|
| `enabled` | `bool` Optional. Defines whether the scheduled backup is enabled. The default value is false. |
| `cron_schedule` | `string` Optional. The scheduled interval in Cron format, see <https://en.wikipedia.org/wiki/Cron> The default is empty: scheduled backup is not enabled. Must be specified to enable scheduled backups. |
| `time_zone` | `string` Optional. Specifies the time zone to be used when interpreting cron_schedule. Must be a time zone name from the time zone database (<https://en.wikipedia.org/wiki/List_of_tz_database_time_zones)>, e.g. America/Los_Angeles or Africa/Abidjan. If left unspecified, the default is UTC. |
| `next_scheduled_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Output only. The time when the next backups execution is scheduled to start. |
| `backup_location` | `string` Optional. A Cloud Storage URI of a folder, in the format `gs://<bucket_name>/<path_inside_bucket>`. A sub-folder `<backup_folder>` containing backup files will be stored below it. |
| `latest_backup` | `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.LatestBackup` Output only. The details of the latest scheduled backup. |

## Secret

A securely stored value.

| Fields ||
|---|---|
| Union field `value`. `value` can be only one of the following: ||
| `cloud_secret` | `string` Optional. The relative resource name of a Secret Manager secret version, in the following form: `projects/{project_number}/secrets/{secret_id}/versions/{version_id}`. |

## Service

A managed metastore service that serves metadata queries.

| Fields ||
|---|---|
| `name` | `string` Immutable. Identifier. The relative resource name of the metastore service, in the following format: `projects/{project_number}/locations/{location_id}/services/{service_id}`. |
| `create_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Output only. The time when the metastore service was created. |
| `update_time` | `https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` Output only. The time when the metastore service was last updated. |
| `labels` | `map<string, string>` User-defined labels for the metastore service. |
| `network` | `string` Immutable. The relative resource name of the VPC network on which the instance can be accessed. It is specified in the following form: `projects/{project_number}/global/networks/{network_id}`. |
| `endpoint_uri` | `string` Output only. The URI of the endpoint used to access the metastore service. |
| `port` | `int32` Optional. The TCP port at which the metastore service is reached. Default: 9083. |
| `state` | `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.Service.State` Output only. The current state of the metastore service. |
| `state_message` | `string` Output only. Additional information about the current state of the metastore service, if available. |
| `artifact_gcs_uri` | `string` Output only. A Cloud Storage URI (starting with `gs://`) that specifies where artifacts related to the metastore service are stored. |
| `tier` | `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.Service.Tier` Optional. The tier of the service. |
| `metadata_integration` | `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.MetadataIntegration` Optional. The setting that defines how metastore metadata should be integrated with external services and systems. |
| `maintenance_window` | `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.MaintenanceWindow` Optional. The one hour maintenance window of the metastore service. This specifies when the service can be restarted for maintenance purposes in UTC time. Maintenance window is not needed for services with the SPANNER database type. |
| `uid` | `string` Output only. The globally unique resource identifier of the metastore service. |
| `metadata_management_activity` | `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.MetadataManagementActivity` Output only. The metadata management activities of the metastore service. |
| `release_channel` | `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.Service.ReleaseChannel` Immutable. The release channel of the service. If unspecified, defaults to `STABLE`. |
| `encryption_config` | `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.EncryptionConfig` Immutable. Information used to configure the Dataproc Metastore service to encrypt customer data at rest. Cannot be updated. |
| `network_config` | `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.NetworkConfig` Optional. The configuration specifying the network settings for the Dataproc Metastore service. |
| `database_type` | `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.Service.DatabaseType` Immutable. The database type that the Metastore service stores its data. |
| `telemetry_config` | `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.TelemetryConfig` Optional. The configuration specifying telemetry settings for the Dataproc Metastore service. If unspecified defaults to `JSON`. |
| `scaling_config` | `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.ScalingConfig` Optional. Scaling configuration of the metastore service. |
| `multi_region_config (deprecated)` | `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.MultiRegionConfig` > [!WARNING] > This item is deprecated! Optional. Deprecated: Use a single region service instead. Specifies the multi-region configuration information for the Hive metastore service. |
| `scheduled_backup` | `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.ScheduledBackup` Optional. The configuration of scheduled backup for the metastore service. |
| `deletion_protection` | `bool` Optional. Indicates if the dataproc metastore should be protected against accidental deletions. |
| `tags` | `map<string, string>` Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing" |
| Union field `metastore_config`. Configuration properties specific to the underlying metastore service technology (the software that serves metastore queries). `metastore_config` can be only one of the following: ||
| `hive_metastore_config` | `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.HiveMetastoreConfig` Configuration information specific to running Hive metastore software as the metastore service. |

## DatabaseType

The backend database type for the metastore service.

| Enums ||
|---|---|
| `DATABASE_TYPE_UNSPECIFIED` | The DATABASE_TYPE is not set. |
| `MYSQL` | MySQL is used to persist the metastore data. |
| `SPANNER` | Spanner is used to persist the metastore data. |

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

| Enums ||
|---|---|
| `RELEASE_CHANNEL_UNSPECIFIED` | Release channel is not specified. |
| `CANARY` | The `CANARY` release channel contains the newest features, which may be unstable and subject to unresolved issues with no known workarounds. Services using the `CANARY` release channel are not subject to any SLAs. |
| `STABLE` | The `STABLE` release channel contains features that are considered stable and have been validated for production use. |

## State

The current state of the metastore service.

| Enums ||
|---|---|
| `STATE_UNSPECIFIED` | The state of the metastore service is unknown. |
| `CREATING` | The metastore service is in the process of being created. |
| `ACTIVE` | The metastore service is running and ready to serve queries. |
| `SUSPENDING` | The metastore service is entering suspension. Its query-serving availability may cease unexpectedly. |
| `SUSPENDED` | The metastore service is suspended and unable to serve queries. |
| `UPDATING` | The metastore service is being updated. It remains usable but cannot accept additional update requests or be deleted at this time. |
| `DELETING` | The metastore service is undergoing deletion. It cannot be used. |
| `ERROR` | The metastore service has encountered an error and cannot be used. The metastore service should be deleted. |
| `AUTOSCALING` | The Dataproc Metastore service 2 is being scaled up or down. |
| `MIGRATING` | The metastore service is processing a managed migration. |
| `PROXY` | The metastore service has completed managed migration and is now proxying requests to the Lakehouse runtime catalog. |

## Tier

Available service tiers.

| Enums ||
|---|---|
| `TIER_UNSPECIFIED` | The tier is not set. |
| `DEVELOPER` | The developer tier provides limited scalability and no fault tolerance. Good for low-cost proof-of-concept. |
| `ENTERPRISE` | The enterprise tier provides multi-zone high availability, and sufficient scalability for enterprise-level Dataproc Metastore workloads. |

## StartMigrationRequest

Request message for `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.DataprocMetastore.StartMigration`.

| Fields ||
|---|---|
| `service` | `string` Required. The relative resource name of the metastore service to start migrating to, in the following format: `projects/{project_id}/locations/{location_id}/services/{service_id}`. Authorization requires the following [IAM](https://cloud.google.com/iam/docs/) permission on the specified resource `service`: - `metastore.migrations.start` |
| `migration_execution` | `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.MigrationExecution` Required. The configuration details for the migration. |
| `migration_execution_id` | `string` Optional. The ID to use for the migration execution, which will become the final component of the migration execution's resource name. If not specified, a UUID will be generated. This value must be between 2 and 63 characters long inclusive, begin with a letter, end with a letter or number, and valid characters are \[a-z0-9-\]. |
| `request_id` | `string` Optional. A request ID. Specify a unique request ID to allow the server to ignore the request if it has completed. The server will ignore subsequent requests that provide a duplicate request ID for at least 60 minutes after the first request. For example, if an initial request times out, followed by another request with the same request ID, the server ignores the second request to prevent the creation of duplicate commitments. The request ID must be a valid [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier#Format) A zero UUID (00000000-0000-0000-0000-000000000000) is not supported. |

## TableReport

Aggregated report at the table level.

| Fields ||
|---|---|
| `table` | `string` The name of the table. |
| `execution_plan` | `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.ExecutionPlan` The discovered intent for the table (what we found and what we planned). |
| `execution_result` | `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.ExecutionResult` The actual outcome of the table migration. |
| `partition_discovered_count` | `int64` The total number of partitions identified at the source during discovery. This is only relevant for Hive Partitioned tables. |
| `partition_report` | `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.PartitionReport` Report containing the results of partition migration for this table. This is only relevant for Hive Partitioned tables. |

## TableSummary

Aggregated summary of results for all tables in a database.

| Fields ||
|---|---|
| `plan_counts` | `map<string, int64>` Output only. Number of tables with a specific migration plan action. The key is the action name (e.g. CREATE, UPDATE, SKIP, etc.). |
| `result_counts` | `map<string, int64>` Output only. Number of tables with a specific migration result status. The key is the status name (e.g. SUCCEEDED, FAILED, SKIPPED, etc.). This is only set if the migration is not a dry run. |
| `partition_discovered_count` | `int64` Output only. Partition migration summary across all Hive tables in the database. The total number of partitions discovered at the source. |
| `partition_success_count` | `int64` Output only. The total number of partitions successfully migrated at the target. |
| `partition_failed_count` | `int64` Output only. The total number of partitions that failed to migrate at the target. |

## TelemetryConfig

Telemetry Configuration for the Dataproc Metastore service.

| Fields ||
|---|---|
| `log_format` | `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.TelemetryConfig.LogFormat` Optional. The output format of the Dataproc Metastore service's logs. |

## LogFormat

| Enums ||
|---|---|
| `LOG_FORMAT_UNSPECIFIED` | The LOG_FORMAT is not set. |
| `LEGACY` | Logging output uses the legacy `textPayload` format. |
| `JSON` | Logging output uses the `jsonPayload` format. |

## UpdateFederationRequest

Request message for UpdateFederation.

| Fields ||
|---|---|
| `update_mask` | `https://protobuf.dev/reference/protobuf/google.protobuf#field-mask` Required. A field mask used to specify the fields to be overwritten in the metastore federation 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. |
| `federation` | `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.Federation` Required. The metastore federation to update. The server only merges fields in the service if they are specified in `update_mask`. The metastore federation's `name` field is used to identify the metastore service to be updated. Authorization requires the following [IAM](https://cloud.google.com/iam/docs/) permission on the specified resource `federation`: - `metastore.federations.update` |
| `request_id` | `string` Optional. A request ID. Specify a unique request ID to allow the server to ignore the request if it has completed. The server will ignore subsequent requests that provide a duplicate request ID for at least 60 minutes after the first request. For example, if an initial request times out, followed by another request with the same request ID, the server ignores the second request to prevent the creation of duplicate commitments. The request ID must be a valid [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier#Format) A zero UUID (00000000-0000-0000-0000-000000000000) is not supported. |

## UpdateMetadataImportRequest

Request message for `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.DataprocMetastore.UpdateMetadataImport`.

| Fields ||
|---|---|
| `update_mask` | `https://protobuf.dev/reference/protobuf/google.protobuf#field-mask` 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. |
| `metadata_import` | `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.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. Authorization requires the following [IAM](https://cloud.google.com/iam/docs/) permission on the specified resource `metadataImport`: - `metastore.imports.update` |
| `request_id` | `string` Optional. A request ID. Specify a unique request ID to allow the server to ignore the request if it has completed. The server will ignore subsequent requests that provide a duplicate request ID for at least 60 minutes after the first request. For example, if an initial request times out, followed by another request with the same request ID, the server ignores the second request to prevent the creation of duplicate commitments. The request ID must be a valid [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier#Format) A zero UUID (00000000-0000-0000-0000-000000000000) is not supported. |

## UpdateServiceRequest

Request message for `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.DataprocMetastore.UpdateService`.

| Fields ||
|---|---|
| `update_mask` | `https://protobuf.dev/reference/protobuf/google.protobuf#field-mask` 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. |
| `service` | `https://docs.cloud.google.com/dataproc-metastore/docs/reference/rpc/google.cloud.metastore.v1alpha#google.cloud.metastore.v1alpha.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. Authorization requires the following [IAM](https://cloud.google.com/iam/docs/) permission on the specified resource `service`: - `metastore.services.update` |
| `request_id` | `string` Optional. A request ID. Specify a unique request ID to allow the server to ignore the request if it has completed. The server will ignore subsequent requests that provide a duplicate request ID for at least 60 minutes after the first request. For example, if an initial request times out, followed by another request with the same request ID, the server ignores the second request to prevent the creation of duplicate commitments. The request ID must be a valid [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier#Format) A zero UUID (00000000-0000-0000-0000-000000000000) is not supported. |