- 2.56.0 (latest)
- 2.55.0
- 2.54.0
- 2.53.0
- 2.52.0
- 2.50.0
- 2.49.0
- 2.48.0
- 2.47.0
- 2.46.0
- 2.45.0
- 2.44.0
- 2.43.0
- 2.42.0
- 2.41.0
- 2.40.0
- 2.38.0
- 2.37.0
- 2.36.0
- 2.35.0
- 2.34.0
- 2.33.0
- 2.32.0
- 2.31.0
- 2.30.0
- 2.29.0
- 2.28.0
- 2.25.0
- 2.24.0
- 2.23.0
- 2.22.0
- 2.21.0
- 2.20.0
- 2.19.0
- 2.18.0
- 2.17.0
- 2.16.0
- 2.15.0
- 2.14.0
- 2.13.0
- 2.12.0
- 2.10.0
- 2.9.0
- 2.8.0
- 2.7.0
- 2.6.0
- 2.5.0
- 2.4.4
- 2.3.0
- 2.2.0
- 2.1.9
A client to Dataproc Metastore API
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 Cloudregion
) - 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);
}
Classes
AlterMetadataResourceLocationRequest
Request message for DataprocMetastore.AlterMetadataResourceLocation.
Protobuf type google.cloud.metastore.v1alpha.AlterMetadataResourceLocationRequest
AlterMetadataResourceLocationRequest.Builder
Request message for DataprocMetastore.AlterMetadataResourceLocation.
Protobuf type google.cloud.metastore.v1alpha.AlterMetadataResourceLocationRequest
AlterMetadataResourceLocationResponse
Response message for DataprocMetastore.AlterMetadataResourceLocation.
Protobuf type google.cloud.metastore.v1alpha.AlterMetadataResourceLocationResponse
AlterMetadataResourceLocationResponse.Builder
Response message for DataprocMetastore.AlterMetadataResourceLocation.
Protobuf type google.cloud.metastore.v1alpha.AlterMetadataResourceLocationResponse
AuxiliaryVersionConfig
Configuration information for the auxiliary service versions.
Protobuf type google.cloud.metastore.v1alpha.AuxiliaryVersionConfig
AuxiliaryVersionConfig.Builder
Configuration information for the auxiliary service versions.
Protobuf type google.cloud.metastore.v1alpha.AuxiliaryVersionConfig
BackendMetastore
Represents a backend metastore for the federation.
Protobuf type google.cloud.metastore.v1alpha.BackendMetastore
BackendMetastore.Builder
Represents a backend metastore for the federation.
Protobuf type google.cloud.metastore.v1alpha.BackendMetastore
Backup
The details of a backup resource.
Protobuf type google.cloud.metastore.v1alpha.Backup
Backup.Builder
The details of a backup resource.
Protobuf type google.cloud.metastore.v1alpha.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.v1alpha.CreateBackupRequest
CreateBackupRequest.Builder
Request message for DataprocMetastore.CreateBackup.
Protobuf type google.cloud.metastore.v1alpha.CreateBackupRequest
CreateFederationRequest
Request message for CreateFederation.
Protobuf type google.cloud.metastore.v1alpha.CreateFederationRequest
CreateFederationRequest.Builder
Request message for CreateFederation.
Protobuf type google.cloud.metastore.v1alpha.CreateFederationRequest
CreateMetadataImportRequest
Request message for DataprocMetastore.CreateMetadataImport.
Protobuf type google.cloud.metastore.v1alpha.CreateMetadataImportRequest
CreateMetadataImportRequest.Builder
Request message for DataprocMetastore.CreateMetadataImport.
Protobuf type google.cloud.metastore.v1alpha.CreateMetadataImportRequest
CreateServiceRequest
Request message for DataprocMetastore.CreateService.
Protobuf type google.cloud.metastore.v1alpha.CreateServiceRequest
CreateServiceRequest.Builder
Request message for DataprocMetastore.CreateService.
Protobuf type google.cloud.metastore.v1alpha.CreateServiceRequest
DataCatalogConfig
Specifies how metastore metadata should be integrated with the Data Catalog service.
Protobuf type google.cloud.metastore.v1alpha.DataCatalogConfig
DataCatalogConfig.Builder
Specifies how metastore metadata should be integrated with the Data Catalog service.
Protobuf type google.cloud.metastore.v1alpha.DataCatalogConfig
DatabaseDumpSpec
The specification of database dump to import from or export to.
Protobuf type google.cloud.metastore.v1alpha.DatabaseDumpSpec
DatabaseDumpSpec.Builder
The specification of database dump to import from or export to.
Protobuf type google.cloud.metastore.v1alpha.DatabaseDumpSpec
DataplexConfig
Specifies how metastore metadata should be integrated with the Dataplex service.
Protobuf type google.cloud.metastore.v1alpha.DataplexConfig
DataplexConfig.Builder
Specifies how metastore metadata should be integrated with the Dataplex service.
Protobuf type google.cloud.metastore.v1alpha.DataplexConfig
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 Cloudregion
) - 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.newHttpJsonBuilder().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
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}
.
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 (DataprocMetastoreFederationClient dataprocMetastoreFederationClient =
DataprocMetastoreFederationClient.create()) {
FederationName name = FederationName.of("[PROJECT]", "[LOCATION]", "[FEDERATION]");
Federation response = dataprocMetastoreFederationClient.getFederation(name);
}
Note: close() needs to be called on the DataprocMetastoreFederationClient 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 DataprocMetastoreFederationSettings 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
DataprocMetastoreFederationSettings dataprocMetastoreFederationSettings =
DataprocMetastoreFederationSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
DataprocMetastoreFederationClient dataprocMetastoreFederationClient =
DataprocMetastoreFederationClient.create(dataprocMetastoreFederationSettings);
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
DataprocMetastoreFederationSettings dataprocMetastoreFederationSettings =
DataprocMetastoreFederationSettings.newBuilder().setEndpoint(myEndpoint).build();
DataprocMetastoreFederationClient dataprocMetastoreFederationClient =
DataprocMetastoreFederationClient.create(dataprocMetastoreFederationSettings);
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
DataprocMetastoreFederationSettings dataprocMetastoreFederationSettings =
DataprocMetastoreFederationSettings.newHttpJsonBuilder().build();
DataprocMetastoreFederationClient dataprocMetastoreFederationClient =
DataprocMetastoreFederationClient.create(dataprocMetastoreFederationSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
DataprocMetastoreFederationClient.ListFederationsFixedSizeCollection
DataprocMetastoreFederationClient.ListFederationsPage
DataprocMetastoreFederationClient.ListFederationsPagedResponse
DataprocMetastoreFederationGrpc
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}
.
DataprocMetastoreFederationGrpc.DataprocMetastoreFederationBlockingStub
A stub to allow clients to do synchronous rpc calls to service 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}
.
DataprocMetastoreFederationGrpc.DataprocMetastoreFederationFutureStub
A stub to allow clients to do ListenableFuture-style rpc calls to service 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}
.
DataprocMetastoreFederationGrpc.DataprocMetastoreFederationImplBase
Base class for the server implementation of the service 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}
.
DataprocMetastoreFederationGrpc.DataprocMetastoreFederationStub
A stub to allow clients to do asynchronous rpc calls to service 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}
.
DataprocMetastoreFederationSettings
Settings class to configure an instance of DataprocMetastoreFederationClient.
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 getFederation 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
DataprocMetastoreFederationSettings.Builder dataprocMetastoreFederationSettingsBuilder =
DataprocMetastoreFederationSettings.newBuilder();
dataprocMetastoreFederationSettingsBuilder
.getFederationSettings()
.setRetrySettings(
dataprocMetastoreFederationSettingsBuilder
.getFederationSettings()
.getRetrySettings()
.toBuilder()
.setTotalTimeout(Duration.ofSeconds(30))
.build());
DataprocMetastoreFederationSettings dataprocMetastoreFederationSettings =
dataprocMetastoreFederationSettingsBuilder.build();
DataprocMetastoreFederationSettings.Builder
Builder for DataprocMetastoreFederationSettings.
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 Cloudregion
) - 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
A stub to allow clients to do synchronous rpc calls to service 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 Cloudregion
) - 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
A stub to allow clients to do ListenableFuture-style rpc calls to service 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 Cloudregion
) - 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
Base class for the server implementation of the service 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 Cloudregion
) - 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
A stub to allow clients to do asynchronous rpc calls to service 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 Cloudregion
) - 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.v1alpha.DeleteBackupRequest
DeleteBackupRequest.Builder
Request message for DataprocMetastore.DeleteBackup.
Protobuf type google.cloud.metastore.v1alpha.DeleteBackupRequest
DeleteFederationRequest
Request message for DeleteFederation.
Protobuf type google.cloud.metastore.v1alpha.DeleteFederationRequest
DeleteFederationRequest.Builder
Request message for DeleteFederation.
Protobuf type google.cloud.metastore.v1alpha.DeleteFederationRequest
DeleteServiceRequest
Request message for DataprocMetastore.DeleteService.
Protobuf type google.cloud.metastore.v1alpha.DeleteServiceRequest
DeleteServiceRequest.Builder
Request message for DataprocMetastore.DeleteService.
Protobuf type google.cloud.metastore.v1alpha.DeleteServiceRequest
EncryptionConfig
Encryption settings for the service.
Protobuf type google.cloud.metastore.v1alpha.EncryptionConfig
EncryptionConfig.Builder
Encryption settings for the service.
Protobuf type google.cloud.metastore.v1alpha.EncryptionConfig
ExportMetadataRequest
Request message for DataprocMetastore.ExportMetadata.
Protobuf type google.cloud.metastore.v1alpha.ExportMetadataRequest
ExportMetadataRequest.Builder
Request message for DataprocMetastore.ExportMetadata.
Protobuf type google.cloud.metastore.v1alpha.ExportMetadataRequest
Federation
Represents a federation of multiple backend metastores.
Protobuf type google.cloud.metastore.v1alpha.Federation
Federation.Builder
Represents a federation of multiple backend metastores.
Protobuf type google.cloud.metastore.v1alpha.Federation
FederationName
FederationName.Builder
Builder for projects/{project}/locations/{location}/federations/{federation}.
GetBackupRequest
Request message for DataprocMetastore.GetBackup.
Protobuf type google.cloud.metastore.v1alpha.GetBackupRequest
GetBackupRequest.Builder
Request message for DataprocMetastore.GetBackup.
Protobuf type google.cloud.metastore.v1alpha.GetBackupRequest
GetFederationRequest
Request message for GetFederation.
Protobuf type google.cloud.metastore.v1alpha.GetFederationRequest
GetFederationRequest.Builder
Request message for GetFederation.
Protobuf type google.cloud.metastore.v1alpha.GetFederationRequest
GetMetadataImportRequest
Request message for DataprocMetastore.GetMetadataImport.
Protobuf type google.cloud.metastore.v1alpha.GetMetadataImportRequest
GetMetadataImportRequest.Builder
Request message for DataprocMetastore.GetMetadataImport.
Protobuf type google.cloud.metastore.v1alpha.GetMetadataImportRequest
GetServiceRequest
Request message for DataprocMetastore.GetService.
Protobuf type google.cloud.metastore.v1alpha.GetServiceRequest
GetServiceRequest.Builder
Request message for DataprocMetastore.GetService.
Protobuf type google.cloud.metastore.v1alpha.GetServiceRequest
HiveMetastoreConfig
Specifies configuration information specific to running Hive metastore software as the metastore service.
Protobuf type google.cloud.metastore.v1alpha.HiveMetastoreConfig
HiveMetastoreConfig.Builder
Specifies configuration information specific to running Hive metastore software as the metastore service.
Protobuf type google.cloud.metastore.v1alpha.HiveMetastoreConfig
KerberosConfig
Configuration information for a Kerberos principal.
Protobuf type google.cloud.metastore.v1alpha.KerberosConfig
KerberosConfig.Builder
Configuration information for a Kerberos principal.
Protobuf type google.cloud.metastore.v1alpha.KerberosConfig
Lake
Represents a Lake resource
Protobuf type google.cloud.metastore.v1alpha.Lake
Lake.Builder
Represents a Lake resource
Protobuf type google.cloud.metastore.v1alpha.Lake
ListBackupsRequest
Request message for DataprocMetastore.ListBackups.
Protobuf type google.cloud.metastore.v1alpha.ListBackupsRequest
ListBackupsRequest.Builder
Request message for DataprocMetastore.ListBackups.
Protobuf type google.cloud.metastore.v1alpha.ListBackupsRequest
ListBackupsResponse
Response message for DataprocMetastore.ListBackups.
Protobuf type google.cloud.metastore.v1alpha.ListBackupsResponse
ListBackupsResponse.Builder
Response message for DataprocMetastore.ListBackups.
Protobuf type google.cloud.metastore.v1alpha.ListBackupsResponse
ListFederationsRequest
Request message for ListFederations.
Protobuf type google.cloud.metastore.v1alpha.ListFederationsRequest
ListFederationsRequest.Builder
Request message for ListFederations.
Protobuf type google.cloud.metastore.v1alpha.ListFederationsRequest
ListFederationsResponse
Response message for ListFederations
Protobuf type google.cloud.metastore.v1alpha.ListFederationsResponse
ListFederationsResponse.Builder
Response message for ListFederations
Protobuf type google.cloud.metastore.v1alpha.ListFederationsResponse
ListMetadataImportsRequest
Request message for DataprocMetastore.ListMetadataImports.
Protobuf type google.cloud.metastore.v1alpha.ListMetadataImportsRequest
ListMetadataImportsRequest.Builder
Request message for DataprocMetastore.ListMetadataImports.
Protobuf type google.cloud.metastore.v1alpha.ListMetadataImportsRequest
ListMetadataImportsResponse
Response message for DataprocMetastore.ListMetadataImports.
Protobuf type google.cloud.metastore.v1alpha.ListMetadataImportsResponse
ListMetadataImportsResponse.Builder
Response message for DataprocMetastore.ListMetadataImports.
Protobuf type google.cloud.metastore.v1alpha.ListMetadataImportsResponse
ListServicesRequest
Request message for DataprocMetastore.ListServices.
Protobuf type google.cloud.metastore.v1alpha.ListServicesRequest
ListServicesRequest.Builder
Request message for DataprocMetastore.ListServices.
Protobuf type google.cloud.metastore.v1alpha.ListServicesRequest
ListServicesResponse
Response message for DataprocMetastore.ListServices.
Protobuf type google.cloud.metastore.v1alpha.ListServicesResponse
ListServicesResponse.Builder
Response message for DataprocMetastore.ListServices.
Protobuf type google.cloud.metastore.v1alpha.ListServicesResponse
LocationMetadata
Metadata about the service in a location.
Protobuf type google.cloud.metastore.v1alpha.LocationMetadata
LocationMetadata.Builder
Metadata about the service in a location.
Protobuf type google.cloud.metastore.v1alpha.LocationMetadata
LocationMetadata.HiveMetastoreVersion
A specification of a supported version of the Hive Metastore software.
Protobuf type google.cloud.metastore.v1alpha.LocationMetadata.HiveMetastoreVersion
LocationMetadata.HiveMetastoreVersion.Builder
A specification of a supported version of the Hive Metastore software.
Protobuf type google.cloud.metastore.v1alpha.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.v1alpha.MaintenanceWindow
MaintenanceWindow.Builder
Maintenance window. This specifies when Dataproc Metastore may perform system maintenance operation to the service.
Protobuf type google.cloud.metastore.v1alpha.MaintenanceWindow
MetadataExport
The details of a metadata export operation.
Protobuf type google.cloud.metastore.v1alpha.MetadataExport
MetadataExport.Builder
The details of a metadata export operation.
Protobuf type google.cloud.metastore.v1alpha.MetadataExport
MetadataImport
A metastore resource that imports metadata.
Protobuf type google.cloud.metastore.v1alpha.MetadataImport
MetadataImport.Builder
A metastore resource that imports metadata.
Protobuf type google.cloud.metastore.v1alpha.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.v1alpha.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.v1alpha.MetadataImport.DatabaseDump
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.
Protobuf type google.cloud.metastore.v1alpha.MetadataIntegration
MetadataIntegration.Builder
Specifies how metastore metadata should be integrated with external services.
Protobuf type google.cloud.metastore.v1alpha.MetadataIntegration
MetadataManagementActivity
The metadata management activities of the metastore service.
Protobuf type google.cloud.metastore.v1alpha.MetadataManagementActivity
MetadataManagementActivity.Builder
The metadata management activities of the metastore service.
Protobuf type google.cloud.metastore.v1alpha.MetadataManagementActivity
MetastoreFederationProto
MetastoreProto
MoveTableToDatabaseRequest
Request message for DataprocMetastore.MoveTableToDatabase.
Protobuf type google.cloud.metastore.v1alpha.MoveTableToDatabaseRequest
MoveTableToDatabaseRequest.Builder
Request message for DataprocMetastore.MoveTableToDatabase.
Protobuf type google.cloud.metastore.v1alpha.MoveTableToDatabaseRequest
MoveTableToDatabaseResponse
Response message for DataprocMetastore.MoveTableToDatabase.
Protobuf type google.cloud.metastore.v1alpha.MoveTableToDatabaseResponse
MoveTableToDatabaseResponse.Builder
Response message for DataprocMetastore.MoveTableToDatabase.
Protobuf type google.cloud.metastore.v1alpha.MoveTableToDatabaseResponse
NetworkConfig
Network configuration for the Dataproc Metastore service.
Protobuf type google.cloud.metastore.v1alpha.NetworkConfig
NetworkConfig.Builder
Network configuration for the Dataproc Metastore service.
Protobuf type google.cloud.metastore.v1alpha.NetworkConfig
NetworkConfig.Consumer
Contains information of the customer's network configurations.
Protobuf type google.cloud.metastore.v1alpha.NetworkConfig.Consumer
NetworkConfig.Consumer.Builder
Contains information of the customer's network configurations.
Protobuf type google.cloud.metastore.v1alpha.NetworkConfig.Consumer
OperationMetadata
Represents the metadata of a long-running operation.
Protobuf type google.cloud.metastore.v1alpha.OperationMetadata
OperationMetadata.Builder
Represents the metadata of a long-running operation.
Protobuf type google.cloud.metastore.v1alpha.OperationMetadata
QueryMetadataRequest
Request message for DataprocMetastore.QueryMetadata.
Protobuf type google.cloud.metastore.v1alpha.QueryMetadataRequest
QueryMetadataRequest.Builder
Request message for DataprocMetastore.QueryMetadata.
Protobuf type google.cloud.metastore.v1alpha.QueryMetadataRequest
QueryMetadataResponse
Response message for DataprocMetastore.QueryMetadata.
Protobuf type google.cloud.metastore.v1alpha.QueryMetadataResponse
QueryMetadataResponse.Builder
Response message for DataprocMetastore.QueryMetadata.
Protobuf type google.cloud.metastore.v1alpha.QueryMetadataResponse
RemoveIamPolicyRequest
Request message for DataprocMetastore.RemoveIamPolicy.
Protobuf type google.cloud.metastore.v1alpha.RemoveIamPolicyRequest
RemoveIamPolicyRequest.Builder
Request message for DataprocMetastore.RemoveIamPolicy.
Protobuf type google.cloud.metastore.v1alpha.RemoveIamPolicyRequest
RemoveIamPolicyResponse
Response message for DataprocMetastore.RemoveIamPolicy.
Protobuf type google.cloud.metastore.v1alpha.RemoveIamPolicyResponse
RemoveIamPolicyResponse.Builder
Response message for DataprocMetastore.RemoveIamPolicy.
Protobuf type google.cloud.metastore.v1alpha.RemoveIamPolicyResponse
Restore
The details of a metadata restore operation.
Protobuf type google.cloud.metastore.v1alpha.Restore
Restore.Builder
The details of a metadata restore operation.
Protobuf type google.cloud.metastore.v1alpha.Restore
RestoreServiceRequest
Request message for [DataprocMetastore.Restore][].
Protobuf type google.cloud.metastore.v1alpha.RestoreServiceRequest
RestoreServiceRequest.Builder
Request message for [DataprocMetastore.Restore][].
Protobuf type google.cloud.metastore.v1alpha.RestoreServiceRequest
Secret
A securely stored value.
Protobuf type google.cloud.metastore.v1alpha.Secret
Secret.Builder
A securely stored value.
Protobuf type google.cloud.metastore.v1alpha.Secret
Service
A managed metastore service that serves metadata queries.
Protobuf type google.cloud.metastore.v1alpha.Service
Service.Builder
A managed metastore service that serves metadata queries.
Protobuf type google.cloud.metastore.v1alpha.Service
ServiceName
ServiceName.Builder
Builder for projects/{project}/locations/{location}/services/{service}.
TelemetryConfig
Telemetry Configuration for the Dataproc Metastore service.
Protobuf type google.cloud.metastore.v1alpha.TelemetryConfig
TelemetryConfig.Builder
Telemetry Configuration for the Dataproc Metastore service.
Protobuf type google.cloud.metastore.v1alpha.TelemetryConfig
UpdateFederationRequest
Request message for UpdateFederation.
Protobuf type google.cloud.metastore.v1alpha.UpdateFederationRequest
UpdateFederationRequest.Builder
Request message for UpdateFederation.
Protobuf type google.cloud.metastore.v1alpha.UpdateFederationRequest
UpdateMetadataImportRequest
Request message for DataprocMetastore.UpdateMetadataImport.
Protobuf type google.cloud.metastore.v1alpha.UpdateMetadataImportRequest
UpdateMetadataImportRequest.Builder
Request message for DataprocMetastore.UpdateMetadataImport.
Protobuf type google.cloud.metastore.v1alpha.UpdateMetadataImportRequest
UpdateServiceRequest
Request message for DataprocMetastore.UpdateService.
Protobuf type google.cloud.metastore.v1alpha.UpdateServiceRequest
UpdateServiceRequest.Builder
Request message for DataprocMetastore.UpdateService.
Protobuf type google.cloud.metastore.v1alpha.UpdateServiceRequest
Interfaces
AlterMetadataResourceLocationRequestOrBuilder
AlterMetadataResourceLocationResponseOrBuilder
AuxiliaryVersionConfigOrBuilder
BackendMetastoreOrBuilder
BackupOrBuilder
CreateBackupRequestOrBuilder
CreateFederationRequestOrBuilder
CreateMetadataImportRequestOrBuilder
CreateServiceRequestOrBuilder
DataCatalogConfigOrBuilder
DatabaseDumpSpecOrBuilder
DataplexConfigOrBuilder
DataprocMetastoreFederationGrpc.AsyncService
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}
.
DataprocMetastoreGrpc.AsyncService
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 Cloudregion
) - 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}
.
DeleteBackupRequestOrBuilder
DeleteFederationRequestOrBuilder
DeleteServiceRequestOrBuilder
EncryptionConfigOrBuilder
ExportMetadataRequestOrBuilder
FederationOrBuilder
GetBackupRequestOrBuilder
GetFederationRequestOrBuilder
GetMetadataImportRequestOrBuilder
GetServiceRequestOrBuilder
HiveMetastoreConfigOrBuilder
KerberosConfigOrBuilder
LakeOrBuilder
ListBackupsRequestOrBuilder
ListBackupsResponseOrBuilder
ListFederationsRequestOrBuilder
ListFederationsResponseOrBuilder
ListMetadataImportsRequestOrBuilder
ListMetadataImportsResponseOrBuilder
ListServicesRequestOrBuilder
ListServicesResponseOrBuilder
LocationMetadata.HiveMetastoreVersionOrBuilder
LocationMetadataOrBuilder
MaintenanceWindowOrBuilder
MetadataExportOrBuilder
MetadataImport.DatabaseDumpOrBuilder
MetadataImportOrBuilder
MetadataIntegrationOrBuilder
MetadataManagementActivityOrBuilder
MoveTableToDatabaseRequestOrBuilder
MoveTableToDatabaseResponseOrBuilder
NetworkConfig.ConsumerOrBuilder
NetworkConfigOrBuilder
OperationMetadataOrBuilder
QueryMetadataRequestOrBuilder
QueryMetadataResponseOrBuilder
RemoveIamPolicyRequestOrBuilder
RemoveIamPolicyResponseOrBuilder
RestoreOrBuilder
RestoreServiceRequestOrBuilder
SecretOrBuilder
ServiceOrBuilder
TelemetryConfigOrBuilder
UpdateFederationRequestOrBuilder
UpdateMetadataImportRequestOrBuilder
UpdateServiceRequestOrBuilder
Enums
BackendMetastore.MetastoreType
The type of the backend metastore.
Protobuf enum google.cloud.metastore.v1alpha.BackendMetastore.MetastoreType
Backup.State
The current state of the backup.
Protobuf enum google.cloud.metastore.v1alpha.Backup.State
DatabaseDumpSpec.Type
The type of the database dump.
Protobuf enum google.cloud.metastore.v1alpha.DatabaseDumpSpec.Type
ExportMetadataRequest.DestinationCase
Federation.State
The current state of the federation.
Protobuf enum google.cloud.metastore.v1alpha.Federation.State
HiveMetastoreConfig.EndpointProtocol
Protocols available for serving the metastore service endpoint.
Protobuf enum google.cloud.metastore.v1alpha.HiveMetastoreConfig.EndpointProtocol
MetadataExport.DestinationCase
MetadataExport.State
The current state of the metadata export.
Protobuf enum google.cloud.metastore.v1alpha.MetadataExport.State
MetadataImport.DatabaseDump.DatabaseType
The type of the database.
Protobuf enum google.cloud.metastore.v1alpha.MetadataImport.DatabaseDump.DatabaseType
MetadataImport.MetadataCase
MetadataImport.State
The current state of the metadata import.
Protobuf enum google.cloud.metastore.v1alpha.MetadataImport.State
NetworkConfig.Consumer.VpcResourceCase
Restore.RestoreType
The type of restore. If unspecified, defaults to METADATA_ONLY
.
Protobuf enum google.cloud.metastore.v1alpha.Restore.RestoreType
Restore.State
The current state of the restore.
Protobuf enum google.cloud.metastore.v1alpha.Restore.State
Secret.ValueCase
Service.DatabaseType
The backend database type for the metastore service.
Protobuf enum google.cloud.metastore.v1alpha.Service.DatabaseType
Service.MetastoreConfigCase
Service.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.
Protobuf enum google.cloud.metastore.v1alpha.Service.ReleaseChannel
Service.State
The current state of the metastore service.
Protobuf enum google.cloud.metastore.v1alpha.Service.State
Service.Tier
Available service tiers.
Protobuf enum google.cloud.metastore.v1alpha.Service.Tier
TelemetryConfig.LogFormat
Protobuf enum google.cloud.metastore.v1alpha.TelemetryConfig.LogFormat