@Generated("by gapic-generator-java")
Package com.google.cloud.metastore.v1alpha
The interfaces provided are listed below, along with usage samples.
======================= DataprocMetastoreClient =======================
Service Description: 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}`.
Sample for DataprocMetastoreClient:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
ServiceName name = ServiceName.of("[PROJECT]", "[LOCATION]", "[SERVICE]");
Service response = dataprocMetastoreClient.getService(name);
}
======================= DataprocMetastoreFederationClient =======================
Service Description: 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}`.
Sample for DataprocMetastoreFederationClient:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (DataprocMetastoreFederationClient dataprocMetastoreFederationClient =
DataprocMetastoreFederationClient.create()) {
FederationName name = FederationName.of("[PROJECT]", "[LOCATION]", "[FEDERATION]");
Federation response = dataprocMetastoreFederationClient.getFederation(name);
}
-
Class Summary Class Description AlterMetadataResourceLocationRequest Request message for [DataprocMetastore.AlterMetadataResourceLocation][google.cloud.metastore.v1alpha.DataprocMetastore.AlterMetadataResourceLocation].AlterMetadataResourceLocationRequest.Builder Request message for [DataprocMetastore.AlterMetadataResourceLocation][google.cloud.metastore.v1alpha.DataprocMetastore.AlterMetadataResourceLocation].AlterMetadataResourceLocationResponse Response message for [DataprocMetastore.AlterMetadataResourceLocation][google.cloud.metastore.v1alpha.DataprocMetastore.AlterMetadataResourceLocation].AlterMetadataResourceLocationResponse.Builder Response message for [DataprocMetastore.AlterMetadataResourceLocation][google.cloud.metastore.v1alpha.DataprocMetastore.AlterMetadataResourceLocation].AuxiliaryVersionConfig Configuration information for the auxiliary service versions.AuxiliaryVersionConfig.Builder Configuration information for the auxiliary service versions.BackendMetastore Represents a backend metastore for the federation.BackendMetastore.Builder Represents a backend metastore for the federation.Backup The details of a backup resource.Backup.Builder The details of a backup resource.BackupName BackupName.Builder Builder for projects/{project}/locations/{location}/services/{service}/backups/{backup}.CreateBackupRequest Request message for [DataprocMetastore.CreateBackup][google.cloud.metastore.v1alpha.DataprocMetastore.CreateBackup].CreateBackupRequest.Builder Request message for [DataprocMetastore.CreateBackup][google.cloud.metastore.v1alpha.DataprocMetastore.CreateBackup].CreateFederationRequest Request message for CreateFederation.CreateFederationRequest.Builder Request message for CreateFederation.CreateMetadataImportRequest Request message for [DataprocMetastore.CreateMetadataImport][google.cloud.metastore.v1alpha.DataprocMetastore.CreateMetadataImport].CreateMetadataImportRequest.Builder Request message for [DataprocMetastore.CreateMetadataImport][google.cloud.metastore.v1alpha.DataprocMetastore.CreateMetadataImport].CreateServiceRequest Request message for [DataprocMetastore.CreateService][google.cloud.metastore.v1alpha.DataprocMetastore.CreateService].CreateServiceRequest.Builder Request message for [DataprocMetastore.CreateService][google.cloud.metastore.v1alpha.DataprocMetastore.CreateService].DatabaseDumpSpec The specification of database dump to import from or export to.DatabaseDumpSpec.Builder The specification of database dump to import from or export to.DataCatalogConfig Specifies how metastore metadata should be integrated with the Data Catalog service.DataCatalogConfig.Builder Specifies how metastore metadata should be integrated with the Data Catalog service.DataplexConfig Specifies how metastore metadata should be integrated with the Dataplex service.DataplexConfig.Builder Specifies how metastore metadata should be integrated with the Dataplex service.DataprocMetastoreClient Service Description: Configures and manages metastore services.DataprocMetastoreClient.ListBackupsFixedSizeCollection DataprocMetastoreClient.ListBackupsPage DataprocMetastoreClient.ListBackupsPagedResponse DataprocMetastoreClient.ListLocationsFixedSizeCollection DataprocMetastoreClient.ListLocationsPage DataprocMetastoreClient.ListLocationsPagedResponse DataprocMetastoreClient.ListMetadataImportsFixedSizeCollection DataprocMetastoreClient.ListMetadataImportsPage DataprocMetastoreClient.ListMetadataImportsPagedResponse DataprocMetastoreClient.ListServicesFixedSizeCollection DataprocMetastoreClient.ListServicesPage DataprocMetastoreClient.ListServicesPagedResponse DataprocMetastoreFederationClient Service Description: Configures and manages metastore federation services.DataprocMetastoreFederationClient.ListFederationsFixedSizeCollection DataprocMetastoreFederationClient.ListFederationsPage DataprocMetastoreFederationClient.ListFederationsPagedResponse DataprocMetastoreFederationClient.ListLocationsFixedSizeCollection DataprocMetastoreFederationClient.ListLocationsPage DataprocMetastoreFederationClient.ListLocationsPagedResponse DataprocMetastoreFederationGrpc Configures and manages metastore federation services.DataprocMetastoreFederationGrpc.DataprocMetastoreFederationBlockingStub A stub to allow clients to do synchronous rpc calls to service DataprocMetastoreFederation.DataprocMetastoreFederationGrpc.DataprocMetastoreFederationFutureStub A stub to allow clients to do ListenableFuture-style rpc calls to service DataprocMetastoreFederation.DataprocMetastoreFederationGrpc.DataprocMetastoreFederationImplBase Base class for the server implementation of the service DataprocMetastoreFederation.DataprocMetastoreFederationGrpc.DataprocMetastoreFederationStub A stub to allow clients to do asynchronous rpc calls to service DataprocMetastoreFederation.DataprocMetastoreFederationSettings Settings class to configure an instance ofDataprocMetastoreFederationClient
.DataprocMetastoreFederationSettings.Builder Builder for DataprocMetastoreFederationSettings.DataprocMetastoreGrpc Configures and manages metastore services.DataprocMetastoreGrpc.DataprocMetastoreBlockingStub A stub to allow clients to do synchronous rpc calls to service DataprocMetastore.DataprocMetastoreGrpc.DataprocMetastoreFutureStub A stub to allow clients to do ListenableFuture-style rpc calls to service DataprocMetastore.DataprocMetastoreGrpc.DataprocMetastoreImplBase Base class for the server implementation of the service DataprocMetastore.DataprocMetastoreGrpc.DataprocMetastoreStub A stub to allow clients to do asynchronous rpc calls to service DataprocMetastore.DataprocMetastoreSettings Settings class to configure an instance ofDataprocMetastoreClient
.DataprocMetastoreSettings.Builder Builder for DataprocMetastoreSettings.DeleteBackupRequest Request message for [DataprocMetastore.DeleteBackup][google.cloud.metastore.v1alpha.DataprocMetastore.DeleteBackup].DeleteBackupRequest.Builder Request message for [DataprocMetastore.DeleteBackup][google.cloud.metastore.v1alpha.DataprocMetastore.DeleteBackup].DeleteFederationRequest Request message for DeleteFederation.DeleteFederationRequest.Builder Request message for DeleteFederation.DeleteServiceRequest Request message for [DataprocMetastore.DeleteService][google.cloud.metastore.v1alpha.DataprocMetastore.DeleteService].DeleteServiceRequest.Builder Request message for [DataprocMetastore.DeleteService][google.cloud.metastore.v1alpha.DataprocMetastore.DeleteService].EncryptionConfig Encryption settings for the service.EncryptionConfig.Builder Encryption settings for the service.ErrorDetails Error details in public error message for [DataprocMetastore.QueryMetadata][google.cloud.metastore.v1alpha.DataprocMetastore.QueryMetadata].ErrorDetails.Builder Error details in public error message for [DataprocMetastore.QueryMetadata][google.cloud.metastore.v1alpha.DataprocMetastore.QueryMetadata].ExportMetadataRequest Request message for [DataprocMetastore.ExportMetadata][google.cloud.metastore.v1alpha.DataprocMetastore.ExportMetadata].ExportMetadataRequest.Builder Request message for [DataprocMetastore.ExportMetadata][google.cloud.metastore.v1alpha.DataprocMetastore.ExportMetadata].Federation Represents a federation of multiple backend metastores.Federation.Builder Represents a federation of multiple backend metastores.FederationName FederationName.Builder Builder for projects/{project}/locations/{location}/federations/{federation}.GetBackupRequest Request message for [DataprocMetastore.GetBackup][google.cloud.metastore.v1alpha.DataprocMetastore.GetBackup].GetBackupRequest.Builder Request message for [DataprocMetastore.GetBackup][google.cloud.metastore.v1alpha.DataprocMetastore.GetBackup].GetFederationRequest Request message for GetFederation.GetFederationRequest.Builder Request message for GetFederation.GetMetadataImportRequest Request message for [DataprocMetastore.GetMetadataImport][google.cloud.metastore.v1alpha.DataprocMetastore.GetMetadataImport].GetMetadataImportRequest.Builder Request message for [DataprocMetastore.GetMetadataImport][google.cloud.metastore.v1alpha.DataprocMetastore.GetMetadataImport].GetServiceRequest Request message for [DataprocMetastore.GetService][google.cloud.metastore.v1alpha.DataprocMetastore.GetService].GetServiceRequest.Builder Request message for [DataprocMetastore.GetService][google.cloud.metastore.v1alpha.DataprocMetastore.GetService].HiveMetastoreConfig Specifies configuration information specific to running Hive metastore software as the metastore service.HiveMetastoreConfig.Builder Specifies configuration information specific to running Hive metastore software as the metastore service.KerberosConfig Configuration information for a Kerberos principal.KerberosConfig.Builder Configuration information for a Kerberos principal.Lake Represents a Lake resourceLake.Builder Represents a Lake resourceListBackupsRequest Request message for [DataprocMetastore.ListBackups][google.cloud.metastore.v1alpha.DataprocMetastore.ListBackups].ListBackupsRequest.Builder Request message for [DataprocMetastore.ListBackups][google.cloud.metastore.v1alpha.DataprocMetastore.ListBackups].ListBackupsResponse Response message for [DataprocMetastore.ListBackups][google.cloud.metastore.v1alpha.DataprocMetastore.ListBackups].ListBackupsResponse.Builder Response message for [DataprocMetastore.ListBackups][google.cloud.metastore.v1alpha.DataprocMetastore.ListBackups].ListFederationsRequest Request message for ListFederations.ListFederationsRequest.Builder Request message for ListFederations.ListFederationsResponse Response message for ListFederationsListFederationsResponse.Builder Response message for ListFederationsListMetadataImportsRequest Request message for [DataprocMetastore.ListMetadataImports][google.cloud.metastore.v1alpha.DataprocMetastore.ListMetadataImports].ListMetadataImportsRequest.Builder Request message for [DataprocMetastore.ListMetadataImports][google.cloud.metastore.v1alpha.DataprocMetastore.ListMetadataImports].ListMetadataImportsResponse Response message for [DataprocMetastore.ListMetadataImports][google.cloud.metastore.v1alpha.DataprocMetastore.ListMetadataImports].ListMetadataImportsResponse.Builder Response message for [DataprocMetastore.ListMetadataImports][google.cloud.metastore.v1alpha.DataprocMetastore.ListMetadataImports].ListServicesRequest Request message for [DataprocMetastore.ListServices][google.cloud.metastore.v1alpha.DataprocMetastore.ListServices].ListServicesRequest.Builder Request message for [DataprocMetastore.ListServices][google.cloud.metastore.v1alpha.DataprocMetastore.ListServices].ListServicesResponse Response message for [DataprocMetastore.ListServices][google.cloud.metastore.v1alpha.DataprocMetastore.ListServices].ListServicesResponse.Builder Response message for [DataprocMetastore.ListServices][google.cloud.metastore.v1alpha.DataprocMetastore.ListServices].LocationMetadata Metadata about the service in a location.LocationMetadata.Builder Metadata about the service in a location.LocationMetadata.HiveMetastoreVersion A specification of a supported version of the Hive Metastore software.LocationMetadata.HiveMetastoreVersion.Builder A specification of a supported version of the Hive Metastore software.LocationName LocationName.Builder Builder for projects/{project}/locations/{location}.MaintenanceWindow Maintenance window.MaintenanceWindow.Builder Maintenance window.MetadataExport The details of a metadata export operation.MetadataExport.Builder The details of a metadata export operation.MetadataImport A metastore resource that imports metadata.MetadataImport.Builder A metastore resource that imports metadata.MetadataImport.DatabaseDump A specification of the location of and metadata about a database dump from a relational database management system.MetadataImport.DatabaseDump.Builder A specification of the location of and metadata about a database dump from a relational database management system.MetadataImportName MetadataImportName.Builder Builder for projects/{project}/locations/{location}/services/{service}/metadataImports/{metadata_import}.MetadataIntegration Specifies how metastore metadata should be integrated with external services.MetadataIntegration.Builder Specifies how metastore metadata should be integrated with external services.MetadataManagementActivity The metadata management activities of the metastore service.MetadataManagementActivity.Builder The metadata management activities of the metastore service.MetastoreFederationProto MetastoreProto MoveTableToDatabaseRequest Request message for [DataprocMetastore.MoveTableToDatabase][google.cloud.metastore.v1alpha.DataprocMetastore.MoveTableToDatabase].MoveTableToDatabaseRequest.Builder Request message for [DataprocMetastore.MoveTableToDatabase][google.cloud.metastore.v1alpha.DataprocMetastore.MoveTableToDatabase].MoveTableToDatabaseResponse Response message for [DataprocMetastore.MoveTableToDatabase][google.cloud.metastore.v1alpha.DataprocMetastore.MoveTableToDatabase].MoveTableToDatabaseResponse.Builder Response message for [DataprocMetastore.MoveTableToDatabase][google.cloud.metastore.v1alpha.DataprocMetastore.MoveTableToDatabase].NetworkConfig Network configuration for the Dataproc Metastore service.NetworkConfig.Builder Network configuration for the Dataproc Metastore service.NetworkConfig.Consumer Contains information of the customer's network configurations.NetworkConfig.Consumer.Builder Contains information of the customer's network configurations.OperationMetadata Represents the metadata of a long-running operation.OperationMetadata.Builder Represents the metadata of a long-running operation.QueryMetadataRequest Request message for [DataprocMetastore.QueryMetadata][google.cloud.metastore.v1alpha.DataprocMetastore.QueryMetadata].QueryMetadataRequest.Builder Request message for [DataprocMetastore.QueryMetadata][google.cloud.metastore.v1alpha.DataprocMetastore.QueryMetadata].QueryMetadataResponse Response message for [DataprocMetastore.QueryMetadata][google.cloud.metastore.v1alpha.DataprocMetastore.QueryMetadata].QueryMetadataResponse.Builder Response message for [DataprocMetastore.QueryMetadata][google.cloud.metastore.v1alpha.DataprocMetastore.QueryMetadata].RemoveIamPolicyRequest Request message for [DataprocMetastore.RemoveIamPolicy][google.cloud.metastore.v1alpha.DataprocMetastore.RemoveIamPolicy].RemoveIamPolicyRequest.Builder Request message for [DataprocMetastore.RemoveIamPolicy][google.cloud.metastore.v1alpha.DataprocMetastore.RemoveIamPolicy].RemoveIamPolicyResponse Response message for [DataprocMetastore.RemoveIamPolicy][google.cloud.metastore.v1alpha.DataprocMetastore.RemoveIamPolicy].RemoveIamPolicyResponse.Builder Response message for [DataprocMetastore.RemoveIamPolicy][google.cloud.metastore.v1alpha.DataprocMetastore.RemoveIamPolicy].Restore The details of a metadata restore operation.Restore.Builder The details of a metadata restore operation.RestoreServiceRequest Request message for [DataprocMetastore.Restore][].RestoreServiceRequest.Builder Request message for [DataprocMetastore.Restore][].ScalingConfig Represents the scaling configuration of a metastore service.ScalingConfig.Builder Represents the scaling configuration of a metastore service.Secret A securely stored value.Secret.Builder A securely stored value.Service A managed metastore service that serves metadata queries.Service.Builder A managed metastore service that serves metadata queries.ServiceName ServiceName.Builder Builder for projects/{project}/locations/{location}/services/{service}.TelemetryConfig Telemetry Configuration for the Dataproc Metastore service.TelemetryConfig.Builder Telemetry Configuration for the Dataproc Metastore service.UpdateFederationRequest Request message for UpdateFederation.UpdateFederationRequest.Builder Request message for UpdateFederation.UpdateMetadataImportRequest Request message for [DataprocMetastore.UpdateMetadataImport][google.cloud.metastore.v1alpha.DataprocMetastore.UpdateMetadataImport].UpdateMetadataImportRequest.Builder Request message for [DataprocMetastore.UpdateMetadataImport][google.cloud.metastore.v1alpha.DataprocMetastore.UpdateMetadataImport].UpdateServiceRequest Request message for [DataprocMetastore.UpdateService][google.cloud.metastore.v1alpha.DataprocMetastore.UpdateService].UpdateServiceRequest.Builder Request message for [DataprocMetastore.UpdateService][google.cloud.metastore.v1alpha.DataprocMetastore.UpdateService]. -
Enum Summary Enum Description BackendMetastore.MetastoreType The type of the backend metastore.Backup.State The current state of the backup.DatabaseDumpSpec.Type The type of the database dump.ExportMetadataRequest.DestinationCase Federation.State The current state of the federation.HiveMetastoreConfig.EndpointProtocol Protocols available for serving the metastore service endpoint.MetadataExport.DestinationCase MetadataExport.State The current state of the metadata export.MetadataImport.DatabaseDump.DatabaseType The type of the database.MetadataImport.MetadataCase MetadataImport.State The current state of the metadata import.NetworkConfig.Consumer.VpcResourceCase Restore.RestoreType The type of restore.Restore.State The current state of the restore.ScalingConfig.InstanceSize Metastore instance sizes.ScalingConfig.ScalingModelCase Secret.ValueCase Service.DatabaseType The backend database type for the metastore service.Service.MetastoreConfigCase Service.ReleaseChannel Release channels bundle features of varying levels of stability.Service.State The current state of the metastore service.Service.Tier Available service tiers.TelemetryConfig.LogFormat Protobuf enumgoogle.cloud.metastore.v1alpha.TelemetryConfig.LogFormat