Package com.google.cloud.metastore.v1 (2.6.0)

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);
 }

Classes

Backup

The details of a backup resource.

Protobuf type google.cloud.metastore.v1.Backup

Backup.Builder

The details of a backup resource.

Protobuf type google.cloud.metastore.v1.Backup

BackupName

BackupName.Builder

Builder for projects/{project}/locations/{location}/services/{service}/backups/{backup}.

CreateBackupRequest

Request message for DataprocMetastore.CreateBackup.

Protobuf type google.cloud.metastore.v1.CreateBackupRequest

CreateBackupRequest.Builder

Request message for DataprocMetastore.CreateBackup.

Protobuf type google.cloud.metastore.v1.CreateBackupRequest

CreateMetadataImportRequest

Request message for DataprocMetastore.CreateMetadataImport.

Protobuf type google.cloud.metastore.v1.CreateMetadataImportRequest

CreateMetadataImportRequest.Builder

Request message for DataprocMetastore.CreateMetadataImport.

Protobuf type google.cloud.metastore.v1.CreateMetadataImportRequest

CreateServiceRequest

Request message for DataprocMetastore.CreateService.

Protobuf type google.cloud.metastore.v1.CreateServiceRequest

CreateServiceRequest.Builder

Request message for DataprocMetastore.CreateService.

Protobuf type google.cloud.metastore.v1.CreateServiceRequest

DatabaseDumpSpec

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

Protobuf type google.cloud.metastore.v1.DatabaseDumpSpec

DatabaseDumpSpec.Builder

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

Protobuf type google.cloud.metastore.v1.DatabaseDumpSpec

DataprocMetastoreClient

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

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:


 // 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);
 }

Note: close() needs to be called on the DataprocMetastoreClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

The surface of this class includes several types of Java methods for each of the API's methods:

A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of DataprocMetastoreSettings to create(). For example:

To customize credentials:


 // 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
 DataprocMetastoreSettings dataprocMetastoreSettings =
     DataprocMetastoreSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 DataprocMetastoreClient dataprocMetastoreClient =
     DataprocMetastoreClient.create(dataprocMetastoreSettings);

To customize the endpoint:


 // 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
 DataprocMetastoreSettings dataprocMetastoreSettings =
     DataprocMetastoreSettings.newBuilder().setEndpoint(myEndpoint).build();
 DataprocMetastoreClient dataprocMetastoreClient =
     DataprocMetastoreClient.create(dataprocMetastoreSettings);

To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:


 // 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
 DataprocMetastoreSettings dataprocMetastoreSettings =
     DataprocMetastoreSettings.newBuilder()
         .setTransportChannelProvider(
             DataprocMetastoreSettings.defaultHttpJsonTransportProviderBuilder().build())
         .build();
 DataprocMetastoreClient dataprocMetastoreClient =
     DataprocMetastoreClient.create(dataprocMetastoreSettings);

Please refer to the GitHub repository's samples for more quickstart code snippets.

DataprocMetastoreClient.ListBackupsFixedSizeCollection

DataprocMetastoreClient.ListBackupsPage

DataprocMetastoreClient.ListBackupsPagedResponse

DataprocMetastoreClient.ListMetadataImportsFixedSizeCollection

DataprocMetastoreClient.ListMetadataImportsPage

DataprocMetastoreClient.ListMetadataImportsPagedResponse

DataprocMetastoreClient.ListServicesFixedSizeCollection

DataprocMetastoreClient.ListServicesPage

DataprocMetastoreClient.ListServicesPagedResponse

DataprocMetastoreGrpc

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

DataprocMetastoreGrpc.DataprocMetastoreBlockingStub

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

DataprocMetastoreGrpc.DataprocMetastoreFutureStub

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

DataprocMetastoreGrpc.DataprocMetastoreImplBase

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

DataprocMetastoreGrpc.DataprocMetastoreStub

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

DataprocMetastoreSettings

Settings class to configure an instance of DataprocMetastoreClient.

The default instance has everything set to sensible defaults:

The default service address (metastore.googleapis.com) and default port (443) are used.
Credentials are acquired automatically through Application Default Credentials.
Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the total timeout of getService to 30 seconds:


 // 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
 DataprocMetastoreSettings.Builder dataprocMetastoreSettingsBuilder =
     DataprocMetastoreSettings.newBuilder();
 dataprocMetastoreSettingsBuilder
     .getServiceSettings()
     .setRetrySettings(
         dataprocMetastoreSettingsBuilder.getServiceSettings().getRetrySettings().toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 DataprocMetastoreSettings dataprocMetastoreSettings = dataprocMetastoreSettingsBuilder.build();

DataprocMetastoreSettings.Builder

Builder for DataprocMetastoreSettings.

DeleteBackupRequest

Request message for DataprocMetastore.DeleteBackup.

Protobuf type google.cloud.metastore.v1.DeleteBackupRequest

DeleteBackupRequest.Builder

Request message for DataprocMetastore.DeleteBackup.

Protobuf type google.cloud.metastore.v1.DeleteBackupRequest

DeleteServiceRequest

Request message for DataprocMetastore.DeleteService.

Protobuf type google.cloud.metastore.v1.DeleteServiceRequest

DeleteServiceRequest.Builder

Request message for DataprocMetastore.DeleteService.

Protobuf type google.cloud.metastore.v1.DeleteServiceRequest

ExportMetadataRequest

Request message for DataprocMetastore.ExportMetadata.

Protobuf type google.cloud.metastore.v1.ExportMetadataRequest

ExportMetadataRequest.Builder

Request message for DataprocMetastore.ExportMetadata.

Protobuf type google.cloud.metastore.v1.ExportMetadataRequest

GetBackupRequest

Request message for DataprocMetastore.GetBackup.

Protobuf type google.cloud.metastore.v1.GetBackupRequest

GetBackupRequest.Builder

Request message for DataprocMetastore.GetBackup.

Protobuf type google.cloud.metastore.v1.GetBackupRequest

GetMetadataImportRequest

Request message for DataprocMetastore.GetMetadataImport.

Protobuf type google.cloud.metastore.v1.GetMetadataImportRequest

GetMetadataImportRequest.Builder

Request message for DataprocMetastore.GetMetadataImport.

Protobuf type google.cloud.metastore.v1.GetMetadataImportRequest

GetServiceRequest

Request message for DataprocMetastore.GetService.

Protobuf type google.cloud.metastore.v1.GetServiceRequest

GetServiceRequest.Builder

Request message for DataprocMetastore.GetService.

Protobuf type google.cloud.metastore.v1.GetServiceRequest

HiveMetastoreConfig

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

Protobuf type google.cloud.metastore.v1.HiveMetastoreConfig

HiveMetastoreConfig.Builder

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

Protobuf type google.cloud.metastore.v1.HiveMetastoreConfig

KerberosConfig

Configuration information for a Kerberos principal.

Protobuf type google.cloud.metastore.v1.KerberosConfig

KerberosConfig.Builder

Configuration information for a Kerberos principal.

Protobuf type google.cloud.metastore.v1.KerberosConfig

ListBackupsRequest

Request message for DataprocMetastore.ListBackups.

Protobuf type google.cloud.metastore.v1.ListBackupsRequest

ListBackupsRequest.Builder

Request message for DataprocMetastore.ListBackups.

Protobuf type google.cloud.metastore.v1.ListBackupsRequest

ListBackupsResponse

Response message for DataprocMetastore.ListBackups.

Protobuf type google.cloud.metastore.v1.ListBackupsResponse

ListBackupsResponse.Builder

Response message for DataprocMetastore.ListBackups.

Protobuf type google.cloud.metastore.v1.ListBackupsResponse

ListMetadataImportsRequest

Request message for DataprocMetastore.ListMetadataImports.

Protobuf type google.cloud.metastore.v1.ListMetadataImportsRequest

ListMetadataImportsRequest.Builder

Request message for DataprocMetastore.ListMetadataImports.

Protobuf type google.cloud.metastore.v1.ListMetadataImportsRequest

ListMetadataImportsResponse

Response message for DataprocMetastore.ListMetadataImports.

Protobuf type google.cloud.metastore.v1.ListMetadataImportsResponse

ListMetadataImportsResponse.Builder

Response message for DataprocMetastore.ListMetadataImports.

Protobuf type google.cloud.metastore.v1.ListMetadataImportsResponse

ListServicesRequest

Request message for DataprocMetastore.ListServices.

Protobuf type google.cloud.metastore.v1.ListServicesRequest

ListServicesRequest.Builder

Request message for DataprocMetastore.ListServices.

Protobuf type google.cloud.metastore.v1.ListServicesRequest

ListServicesResponse

Response message for DataprocMetastore.ListServices.

Protobuf type google.cloud.metastore.v1.ListServicesResponse

ListServicesResponse.Builder

Response message for DataprocMetastore.ListServices.

Protobuf type google.cloud.metastore.v1.ListServicesResponse

LocationMetadata

Metadata about the service in a location.

Protobuf type google.cloud.metastore.v1.LocationMetadata

LocationMetadata.Builder

Metadata about the service in a location.

Protobuf type google.cloud.metastore.v1.LocationMetadata

LocationMetadata.HiveMetastoreVersion

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

Protobuf type google.cloud.metastore.v1.LocationMetadata.HiveMetastoreVersion

LocationMetadata.HiveMetastoreVersion.Builder

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

Protobuf type google.cloud.metastore.v1.LocationMetadata.HiveMetastoreVersion

LocationName

LocationName.Builder

Builder for projects/{project}/locations/{location}.

MaintenanceWindow

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

Protobuf type google.cloud.metastore.v1.MaintenanceWindow

MaintenanceWindow.Builder

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

Protobuf type google.cloud.metastore.v1.MaintenanceWindow

MetadataExport

The details of a metadata export operation.

Protobuf type google.cloud.metastore.v1.MetadataExport

MetadataExport.Builder

The details of a metadata export operation.

Protobuf type google.cloud.metastore.v1.MetadataExport

MetadataImport

A metastore resource that imports metadata.

Protobuf type google.cloud.metastore.v1.MetadataImport

MetadataImport.Builder

A metastore resource that imports metadata.

Protobuf type google.cloud.metastore.v1.MetadataImport

MetadataImport.DatabaseDump

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

Protobuf type google.cloud.metastore.v1.MetadataImport.DatabaseDump

MetadataImport.DatabaseDump.Builder

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

Protobuf type google.cloud.metastore.v1.MetadataImport.DatabaseDump

MetadataImportName

MetadataImportName.Builder

Builder for projects/{project}/locations/{location}/services/{service}/metadataImports/{metadata_import}.

MetadataManagementActivity

The metadata management activities of the metastore service.

Protobuf type google.cloud.metastore.v1.MetadataManagementActivity

MetadataManagementActivity.Builder

The metadata management activities of the metastore service.

Protobuf type google.cloud.metastore.v1.MetadataManagementActivity

MetastoreProto

OperationMetadata

Represents the metadata of a long-running operation.

Protobuf type google.cloud.metastore.v1.OperationMetadata

OperationMetadata.Builder

Represents the metadata of a long-running operation.

Protobuf type google.cloud.metastore.v1.OperationMetadata

Restore

The details of a metadata restore operation.

Protobuf type google.cloud.metastore.v1.Restore

Restore.Builder

The details of a metadata restore operation.

Protobuf type google.cloud.metastore.v1.Restore

RestoreServiceRequest

Request message for [DataprocMetastore.Restore][].

Protobuf type google.cloud.metastore.v1.RestoreServiceRequest

RestoreServiceRequest.Builder

Request message for [DataprocMetastore.Restore][].

Protobuf type google.cloud.metastore.v1.RestoreServiceRequest

Secret

A securely stored value.

Protobuf type google.cloud.metastore.v1.Secret

Secret.Builder

A securely stored value.

Protobuf type google.cloud.metastore.v1.Secret

Service

A managed metastore service that serves metadata queries.

Protobuf type google.cloud.metastore.v1.Service

Service.Builder

A managed metastore service that serves metadata queries.

Protobuf type google.cloud.metastore.v1.Service

ServiceName

ServiceName.Builder

Builder for projects/{project}/locations/{location}/services/{service}.

UpdateMetadataImportRequest

Request message for DataprocMetastore.UpdateMetadataImport.

Protobuf type google.cloud.metastore.v1.UpdateMetadataImportRequest

UpdateMetadataImportRequest.Builder

Request message for DataprocMetastore.UpdateMetadataImport.

Protobuf type google.cloud.metastore.v1.UpdateMetadataImportRequest

UpdateServiceRequest

Request message for DataprocMetastore.UpdateService.

Protobuf type google.cloud.metastore.v1.UpdateServiceRequest

UpdateServiceRequest.Builder

Request message for DataprocMetastore.UpdateService.

Protobuf type google.cloud.metastore.v1.UpdateServiceRequest

Package com.google.cloud.metastore.v1 (2.6.0)

DataprocMetastoreClient

Classes

Interfaces

Enums