| GitHub Repository | Product Reference |
Service Description: Hive Metastore Service is a biglake service that allows users to manage their external Hive catalogs. Full API compatibility with OSS Hive Metastore APIs is not supported. The methods match the Hive Metastore API spec mostly except for a few exceptions. These include listing resources with pattern, environment context which are combined in a single List API, return of ListResponse object instead of a list of resources, transactions, locks, etc.
The BigLake Hive Metastore API defines the following resources:
- A collection of Google Cloud projects:
/projects/* - Each project has a collection of catalogs:
/catalogs/* - Each catalog has a collection of databases:
/databases/* - Each database has a collection of tables:
/tables/*
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 (HiveMetastoreServiceClient hiveMetastoreServiceClient =
HiveMetastoreServiceClient.create()) {
ProjectName parent = ProjectName.of("[PROJECT]");
HiveCatalog hiveCatalog = HiveCatalog.newBuilder().build();
String hiveCatalogId = "hiveCatalogId-575314556";
HiveCatalog response =
hiveMetastoreServiceClient.createHiveCatalog(parent, hiveCatalog, hiveCatalogId);
}
Note: close() needs to be called on the HiveMetastoreServiceClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().
| Method | Description | Method Variants |
|---|---|---|
CreateHiveCatalog |
Creates a new hive catalog. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
GetHiveCatalog |
Gets the catalog specified by the resource name. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
ListHiveCatalogs |
List all catalogs in a specified project. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
UpdateHiveCatalog |
Updates an existing catalog. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
DeleteHiveCatalog |
Deletes an existing catalog specified by the catalog ID. Delete will fail if the catalog is not empty. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
CreateHiveDatabase |
Creates a new database. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
GetHiveDatabase |
Gets the database specified by the resource name. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
ListHiveDatabases |
List all databases in a specified catalog. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
UpdateHiveDatabase |
Updates an existing database specified by the database name. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
DeleteHiveDatabase |
Deletes an existing database specified by the database name. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
CreateHiveTable |
Creates a new hive table. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
GetHiveTable |
Gets the table specified by the resource name. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
ListHiveTables |
List all hive tables in a specified project under the hive catalog and database. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
UpdateHiveTable |
Updates an existing table specified by the table name. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
DeleteHiveTable |
Deletes an existing table specified by the table name. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
BatchCreatePartitions |
Adds partitions to a table. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
BatchDeletePartitions |
Deletes partitions from a table. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
BatchUpdatePartitions |
Updates partitions in a table. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
ListPartitions |
Streams list of partitions from a table. |
Callable method variants take no parameters and return 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 HiveMetastoreServiceSettings 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
HiveMetastoreServiceSettings hiveMetastoreServiceSettings =
HiveMetastoreServiceSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
HiveMetastoreServiceClient hiveMetastoreServiceClient =
HiveMetastoreServiceClient.create(hiveMetastoreServiceSettings);
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
HiveMetastoreServiceSettings hiveMetastoreServiceSettings =
HiveMetastoreServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
HiveMetastoreServiceClient hiveMetastoreServiceClient =
HiveMetastoreServiceClient.create(hiveMetastoreServiceSettings);
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
HiveMetastoreServiceSettings hiveMetastoreServiceSettings =
HiveMetastoreServiceSettings.newHttpJsonBuilder().build();
HiveMetastoreServiceClient hiveMetastoreServiceClient =
HiveMetastoreServiceClient.create(hiveMetastoreServiceSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
Static Methods
create()
public static final HiveMetastoreServiceClient create()Constructs an instance of HiveMetastoreServiceClient with default settings.
| Returns | |
|---|---|
| Type | Description |
HiveMetastoreServiceClient |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
create(HiveMetastoreServiceSettings settings)
public static final HiveMetastoreServiceClient create(HiveMetastoreServiceSettings settings)Constructs an instance of HiveMetastoreServiceClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.
| Parameter | |
|---|---|
| Name | Description |
settings |
HiveMetastoreServiceSettings |
| Returns | |
|---|---|
| Type | Description |
HiveMetastoreServiceClient |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
create(HiveMetastoreServiceStub stub)
public static final HiveMetastoreServiceClient create(HiveMetastoreServiceStub stub)Constructs an instance of HiveMetastoreServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(HiveMetastoreServiceSettings).
| Parameter | |
|---|---|
| Name | Description |
stub |
HiveMetastoreServiceStub |
| Returns | |
|---|---|
| Type | Description |
HiveMetastoreServiceClient |
|
Constructors
HiveMetastoreServiceClient(HiveMetastoreServiceSettings settings)
protected HiveMetastoreServiceClient(HiveMetastoreServiceSettings settings)Constructs an instance of HiveMetastoreServiceClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.
| Parameter | |
|---|---|
| Name | Description |
settings |
HiveMetastoreServiceSettings |
HiveMetastoreServiceClient(HiveMetastoreServiceStub stub)
protected HiveMetastoreServiceClient(HiveMetastoreServiceStub stub)| Parameter | |
|---|---|
| Name | Description |
stub |
HiveMetastoreServiceStub |
Methods
awaitTermination(long duration, TimeUnit unit)
public boolean awaitTermination(long duration, TimeUnit unit)| Parameters | |
|---|---|
| Name | Description |
duration |
long |
unit |
TimeUnit |
| Returns | |
|---|---|
| Type | Description |
boolean |
|
| Exceptions | |
|---|---|
| Type | Description |
InterruptedException |
|
batchCreatePartitions(BatchCreatePartitionsRequest request)
public final BatchCreatePartitionsResponse batchCreatePartitions(BatchCreatePartitionsRequest request)Adds partitions to a table.
Sample code:
// 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 (HiveMetastoreServiceClient hiveMetastoreServiceClient =
HiveMetastoreServiceClient.create()) {
BatchCreatePartitionsRequest request =
BatchCreatePartitionsRequest.newBuilder()
.setParent(TableName.of("[PROJECT]", "[CATALOG]", "[DATABASE]", "[TABLE]").toString())
.addAllRequests(new ArrayList<CreatePartitionRequest>())
.setSkipExistingPartitions(true)
.build();
BatchCreatePartitionsResponse response =
hiveMetastoreServiceClient.batchCreatePartitions(request);
}
| Parameter | |
|---|---|
| Name | Description |
request |
BatchCreatePartitionsRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
BatchCreatePartitionsResponse |
|
batchCreatePartitions(TableName parent)
public final BatchCreatePartitionsResponse batchCreatePartitions(TableName parent)Adds partitions to a table.
Sample code:
// 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 (HiveMetastoreServiceClient hiveMetastoreServiceClient =
HiveMetastoreServiceClient.create()) {
TableName parent = TableName.of("[PROJECT]", "[CATALOG]", "[DATABASE]", "[TABLE]");
BatchCreatePartitionsResponse response =
hiveMetastoreServiceClient.batchCreatePartitions(parent);
}
| Parameter | |
|---|---|
| Name | Description |
parent |
TableNameRequired. Reference to the table to where the partitions to be added, in the format of projects/{project}/catalogs/{catalogs}/databases/{database}/tables/{table}. |
| Returns | |
|---|---|
| Type | Description |
BatchCreatePartitionsResponse |
|
batchCreatePartitions(String parent)
public final BatchCreatePartitionsResponse batchCreatePartitions(String parent)Adds partitions to a table.
Sample code:
// 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 (HiveMetastoreServiceClient hiveMetastoreServiceClient =
HiveMetastoreServiceClient.create()) {
String parent = TableName.of("[PROJECT]", "[CATALOG]", "[DATABASE]", "[TABLE]").toString();
BatchCreatePartitionsResponse response =
hiveMetastoreServiceClient.batchCreatePartitions(parent);
}
| Parameter | |
|---|---|
| Name | Description |
parent |
StringRequired. Reference to the table to where the partitions to be added, in the format of projects/{project}/catalogs/{catalogs}/databases/{database}/tables/{table}. |
| Returns | |
|---|---|
| Type | Description |
BatchCreatePartitionsResponse |
|
batchCreatePartitionsCallable()
public final UnaryCallable<BatchCreatePartitionsRequest,BatchCreatePartitionsResponse> batchCreatePartitionsCallable()Adds partitions to a table.
Sample code:
// 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 (HiveMetastoreServiceClient hiveMetastoreServiceClient =
HiveMetastoreServiceClient.create()) {
BatchCreatePartitionsRequest request =
BatchCreatePartitionsRequest.newBuilder()
.setParent(TableName.of("[PROJECT]", "[CATALOG]", "[DATABASE]", "[TABLE]").toString())
.addAllRequests(new ArrayList<CreatePartitionRequest>())
.setSkipExistingPartitions(true)
.build();
ApiFuture<BatchCreatePartitionsResponse> future =
hiveMetastoreServiceClient.batchCreatePartitionsCallable().futureCall(request);
// Do something.
BatchCreatePartitionsResponse response = future.get();
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<BatchCreatePartitionsRequest,BatchCreatePartitionsResponse> |
|
batchDeletePartitions(BatchDeletePartitionsRequest request)
public final void batchDeletePartitions(BatchDeletePartitionsRequest request)Deletes partitions from a table.
Sample code:
// 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 (HiveMetastoreServiceClient hiveMetastoreServiceClient =
HiveMetastoreServiceClient.create()) {
BatchDeletePartitionsRequest request =
BatchDeletePartitionsRequest.newBuilder()
.setParent(TableName.of("[PROJECT]", "[CATALOG]", "[DATABASE]", "[TABLE]").toString())
.addAllPartitionValues(new ArrayList<PartitionValues>())
.build();
hiveMetastoreServiceClient.batchDeletePartitions(request);
}
| Parameter | |
|---|---|
| Name | Description |
request |
BatchDeletePartitionsRequestThe request object containing all of the parameters for the API call. |
batchDeletePartitions(TableName parent)
public final void batchDeletePartitions(TableName parent)Deletes partitions from a table.
Sample code:
// 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 (HiveMetastoreServiceClient hiveMetastoreServiceClient =
HiveMetastoreServiceClient.create()) {
TableName parent = TableName.of("[PROJECT]", "[CATALOG]", "[DATABASE]", "[TABLE]");
hiveMetastoreServiceClient.batchDeletePartitions(parent);
}
| Parameter | |
|---|---|
| Name | Description |
parent |
TableNameRequired. Reference to the table to which these partitions belong, in the format of projects/{project}/catalogs/{catalogs}/databases/{database}/tables/{table}. |
batchDeletePartitions(String parent)
public final void batchDeletePartitions(String parent)Deletes partitions from a table.
Sample code:
// 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 (HiveMetastoreServiceClient hiveMetastoreServiceClient =
HiveMetastoreServiceClient.create()) {
String parent = TableName.of("[PROJECT]", "[CATALOG]", "[DATABASE]", "[TABLE]").toString();
hiveMetastoreServiceClient.batchDeletePartitions(parent);
}
| Parameter | |
|---|---|
| Name | Description |
parent |
StringRequired. Reference to the table to which these partitions belong, in the format of projects/{project}/catalogs/{catalogs}/databases/{database}/tables/{table}. |
batchDeletePartitionsCallable()
public final UnaryCallable<BatchDeletePartitionsRequest,Empty> batchDeletePartitionsCallable()Deletes partitions from a table.
Sample code:
// 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 (HiveMetastoreServiceClient hiveMetastoreServiceClient =
HiveMetastoreServiceClient.create()) {
BatchDeletePartitionsRequest request =
BatchDeletePartitionsRequest.newBuilder()
.setParent(TableName.of("[PROJECT]", "[CATALOG]", "[DATABASE]", "[TABLE]").toString())
.addAllPartitionValues(new ArrayList<PartitionValues>())
.build();
ApiFuture<Empty> future =
hiveMetastoreServiceClient.batchDeletePartitionsCallable().futureCall(request);
// Do something.
future.get();
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<BatchDeletePartitionsRequest,Empty> |
|
batchUpdatePartitions(BatchUpdatePartitionsRequest request)
public final BatchUpdatePartitionsResponse batchUpdatePartitions(BatchUpdatePartitionsRequest request)Updates partitions in a table.
Sample code:
// 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 (HiveMetastoreServiceClient hiveMetastoreServiceClient =
HiveMetastoreServiceClient.create()) {
BatchUpdatePartitionsRequest request =
BatchUpdatePartitionsRequest.newBuilder()
.setParent(TableName.of("[PROJECT]", "[CATALOG]", "[DATABASE]", "[TABLE]").toString())
.addAllRequests(new ArrayList<UpdatePartitionRequest>())
.build();
BatchUpdatePartitionsResponse response =
hiveMetastoreServiceClient.batchUpdatePartitions(request);
}
| Parameter | |
|---|---|
| Name | Description |
request |
BatchUpdatePartitionsRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
BatchUpdatePartitionsResponse |
|
batchUpdatePartitions(TableName parent)
public final BatchUpdatePartitionsResponse batchUpdatePartitions(TableName parent)Updates partitions in a table.
Sample code:
// 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 (HiveMetastoreServiceClient hiveMetastoreServiceClient =
HiveMetastoreServiceClient.create()) {
TableName parent = TableName.of("[PROJECT]", "[CATALOG]", "[DATABASE]", "[TABLE]");
BatchUpdatePartitionsResponse response =
hiveMetastoreServiceClient.batchUpdatePartitions(parent);
}
| Parameter | |
|---|---|
| Name | Description |
parent |
TableNameRequired. Reference to the table to which these partitions belong, in the format of projects/{project}/catalogs/{catalogs}/databases/{database}/tables/{table}. |
| Returns | |
|---|---|
| Type | Description |
BatchUpdatePartitionsResponse |
|
batchUpdatePartitions(String parent)
public final BatchUpdatePartitionsResponse batchUpdatePartitions(String parent)Updates partitions in a table.
Sample code:
// 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 (HiveMetastoreServiceClient hiveMetastoreServiceClient =
HiveMetastoreServiceClient.create()) {
String parent = TableName.of("[PROJECT]", "[CATALOG]", "[DATABASE]", "[TABLE]").toString();
BatchUpdatePartitionsResponse response =
hiveMetastoreServiceClient.batchUpdatePartitions(parent);
}
| Parameter | |
|---|---|
| Name | Description |
parent |
StringRequired. Reference to the table to which these partitions belong, in the format of projects/{project}/catalogs/{catalogs}/databases/{database}/tables/{table}. |
| Returns | |
|---|---|
| Type | Description |
BatchUpdatePartitionsResponse |
|
batchUpdatePartitionsCallable()
public final UnaryCallable<BatchUpdatePartitionsRequest,BatchUpdatePartitionsResponse> batchUpdatePartitionsCallable()Updates partitions in a table.
Sample code:
// 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 (HiveMetastoreServiceClient hiveMetastoreServiceClient =
HiveMetastoreServiceClient.create()) {
BatchUpdatePartitionsRequest request =
BatchUpdatePartitionsRequest.newBuilder()
.setParent(TableName.of("[PROJECT]", "[CATALOG]", "[DATABASE]", "[TABLE]").toString())
.addAllRequests(new ArrayList<UpdatePartitionRequest>())
.build();
ApiFuture<BatchUpdatePartitionsResponse> future =
hiveMetastoreServiceClient.batchUpdatePartitionsCallable().futureCall(request);
// Do something.
BatchUpdatePartitionsResponse response = future.get();
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<BatchUpdatePartitionsRequest,BatchUpdatePartitionsResponse> |
|
close()
public final void close()createHiveCatalog(CreateHiveCatalogRequest request)
public final HiveCatalog createHiveCatalog(CreateHiveCatalogRequest request)Creates a new hive catalog.
Sample code:
// 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 (HiveMetastoreServiceClient hiveMetastoreServiceClient =
HiveMetastoreServiceClient.create()) {
CreateHiveCatalogRequest request =
CreateHiveCatalogRequest.newBuilder()
.setParent(ProjectName.of("[PROJECT]").toString())
.setHiveCatalog(HiveCatalog.newBuilder().build())
.setHiveCatalogId("hiveCatalogId-575314556")
.setPrimaryLocation("primaryLocation-1140723753")
.build();
HiveCatalog response = hiveMetastoreServiceClient.createHiveCatalog(request);
}
| Parameter | |
|---|---|
| Name | Description |
request |
CreateHiveCatalogRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
HiveCatalog |
|
createHiveCatalog(ProjectName parent, HiveCatalog hiveCatalog, String hiveCatalogId)
public final HiveCatalog createHiveCatalog(ProjectName parent, HiveCatalog hiveCatalog, String hiveCatalogId)Creates a new hive catalog.
Sample code:
// 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 (HiveMetastoreServiceClient hiveMetastoreServiceClient =
HiveMetastoreServiceClient.create()) {
ProjectName parent = ProjectName.of("[PROJECT]");
HiveCatalog hiveCatalog = HiveCatalog.newBuilder().build();
String hiveCatalogId = "hiveCatalogId-575314556";
HiveCatalog response =
hiveMetastoreServiceClient.createHiveCatalog(parent, hiveCatalog, hiveCatalogId);
}
| Parameters | |
|---|---|
| Name | Description |
parent |
ProjectNameRequired. The parent resource where this catalog will be created. Format: projects/{project_id_or_number} |
hiveCatalog |
HiveCatalogRequired. The catalog to create. The |
hiveCatalogId |
StringRequired. The Hive Catalog ID to use for the catalog that will become the final component of the catalog's resource name. The maximum length is 256 characters. |
| Returns | |
|---|---|
| Type | Description |
HiveCatalog |
|
createHiveCatalog(String parent, HiveCatalog hiveCatalog, String hiveCatalogId)
public final HiveCatalog createHiveCatalog(String parent, HiveCatalog hiveCatalog, String hiveCatalogId)Creates a new hive catalog.
Sample code:
// 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 (HiveMetastoreServiceClient hiveMetastoreServiceClient =
HiveMetastoreServiceClient.create()) {
String parent = ProjectName.of("[PROJECT]").toString();
HiveCatalog hiveCatalog = HiveCatalog.newBuilder().build();
String hiveCatalogId = "hiveCatalogId-575314556";
HiveCatalog response =
hiveMetastoreServiceClient.createHiveCatalog(parent, hiveCatalog, hiveCatalogId);
}
| Parameters | |
|---|---|
| Name | Description |
parent |
StringRequired. The parent resource where this catalog will be created. Format: projects/{project_id_or_number} |
hiveCatalog |
HiveCatalogRequired. The catalog to create. The |
hiveCatalogId |
StringRequired. The Hive Catalog ID to use for the catalog that will become the final component of the catalog's resource name. The maximum length is 256 characters. |
| Returns | |
|---|---|
| Type | Description |
HiveCatalog |
|
createHiveCatalogCallable()
public final UnaryCallable<CreateHiveCatalogRequest,HiveCatalog> createHiveCatalogCallable()Creates a new hive catalog.
Sample code:
// 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 (HiveMetastoreServiceClient hiveMetastoreServiceClient =
HiveMetastoreServiceClient.create()) {
CreateHiveCatalogRequest request =
CreateHiveCatalogRequest.newBuilder()
.setParent(ProjectName.of("[PROJECT]").toString())
.setHiveCatalog(HiveCatalog.newBuilder().build())
.setHiveCatalogId("hiveCatalogId-575314556")
.setPrimaryLocation("primaryLocation-1140723753")
.build();
ApiFuture<HiveCatalog> future =
hiveMetastoreServiceClient.createHiveCatalogCallable().futureCall(request);
// Do something.
HiveCatalog response = future.get();
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<CreateHiveCatalogRequest,HiveCatalog> |
|
createHiveDatabase(CatalogName parent, HiveDatabase hiveDatabase, String hiveDatabaseId)
public final HiveDatabase createHiveDatabase(CatalogName parent, HiveDatabase hiveDatabase, String hiveDatabaseId)Creates a new database.
Sample code:
// 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 (HiveMetastoreServiceClient hiveMetastoreServiceClient =
HiveMetastoreServiceClient.create()) {
CatalogName parent = CatalogName.of("[PROJECT]", "[CATALOG]");
HiveDatabase hiveDatabase = HiveDatabase.newBuilder().build();
String hiveDatabaseId = "hiveDatabaseId-1150232698";
HiveDatabase response =
hiveMetastoreServiceClient.createHiveDatabase(parent, hiveDatabase, hiveDatabaseId);
}
| Parameters | |
|---|---|
| Name | Description |
parent |
CatalogNameRequired. The parent resource where this database will be created. Format: projects/{project_id_or_number}/catalogs/{catalog_id} |
hiveDatabase |
HiveDatabaseRequired. The database to create. The |
hiveDatabaseId |
StringRequired. The ID to use for the Hive Database. The maximum length is 128 characters. |
| Returns | |
|---|---|
| Type | Description |
HiveDatabase |
|
createHiveDatabase(CreateHiveDatabaseRequest request)
public final HiveDatabase createHiveDatabase(CreateHiveDatabaseRequest request)Creates a new database.
Sample code:
// 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 (HiveMetastoreServiceClient hiveMetastoreServiceClient =
HiveMetastoreServiceClient.create()) {
CreateHiveDatabaseRequest request =
CreateHiveDatabaseRequest.newBuilder()
.setParent(CatalogName.of("[PROJECT]", "[CATALOG]").toString())
.setHiveDatabase(HiveDatabase.newBuilder().build())
.setHiveDatabaseId("hiveDatabaseId-1150232698")
.build();
HiveDatabase response = hiveMetastoreServiceClient.createHiveDatabase(request);
}
| Parameter | |
|---|---|
| Name | Description |
request |
CreateHiveDatabaseRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
HiveDatabase |
|
createHiveDatabase(String parent, HiveDatabase hiveDatabase, String hiveDatabaseId)
public final HiveDatabase createHiveDatabase(String parent, HiveDatabase hiveDatabase, String hiveDatabaseId)Creates a new database.
Sample code:
// 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 (HiveMetastoreServiceClient hiveMetastoreServiceClient =
HiveMetastoreServiceClient.create()) {
String parent = CatalogName.of("[PROJECT]", "[CATALOG]").toString();
HiveDatabase hiveDatabase = HiveDatabase.newBuilder().build();
String hiveDatabaseId = "hiveDatabaseId-1150232698";
HiveDatabase response =
hiveMetastoreServiceClient.createHiveDatabase(parent, hiveDatabase, hiveDatabaseId);
}
| Parameters | |
|---|---|
| Name | Description |
parent |
StringRequired. The parent resource where this database will be created. Format: projects/{project_id_or_number}/catalogs/{catalog_id} |
hiveDatabase |
HiveDatabaseRequired. The database to create. The |
hiveDatabaseId |
StringRequired. The ID to use for the Hive Database. The maximum length is 128 characters. |
| Returns | |
|---|---|
| Type | Description |
HiveDatabase |
|
createHiveDatabaseCallable()
public final UnaryCallable<CreateHiveDatabaseRequest,HiveDatabase> createHiveDatabaseCallable()Creates a new database.
Sample code:
// 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 (HiveMetastoreServiceClient hiveMetastoreServiceClient =
HiveMetastoreServiceClient.create()) {
CreateHiveDatabaseRequest request =
CreateHiveDatabaseRequest.newBuilder()
.setParent(CatalogName.of("[PROJECT]", "[CATALOG]").toString())
.setHiveDatabase(HiveDatabase.newBuilder().build())
.setHiveDatabaseId("hiveDatabaseId-1150232698")
.build();
ApiFuture<HiveDatabase> future =
hiveMetastoreServiceClient.createHiveDatabaseCallable().futureCall(request);
// Do something.
HiveDatabase response = future.get();
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<CreateHiveDatabaseRequest,HiveDatabase> |
|
createHiveTable(CreateHiveTableRequest request)
public final HiveTable createHiveTable(CreateHiveTableRequest request)Creates a new hive table.
Sample code:
// 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 (HiveMetastoreServiceClient hiveMetastoreServiceClient =
HiveMetastoreServiceClient.create()) {
CreateHiveTableRequest request =
CreateHiveTableRequest.newBuilder()
.setParent(NamespaceName.of("[PROJECT]", "[CATALOG]", "[DATABASE]").toString())
.setHiveTable(HiveTable.newBuilder().build())
.setHiveTableId("hiveTableId152241145")
.build();
HiveTable response = hiveMetastoreServiceClient.createHiveTable(request);
}
| Parameter | |
|---|---|
| Name | Description |
request |
CreateHiveTableRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
HiveTable |
|
createHiveTable(NamespaceName parent, HiveTable hiveTable, String hiveTableId)
public final HiveTable createHiveTable(NamespaceName parent, HiveTable hiveTable, String hiveTableId)Creates a new hive table.
Sample code:
// 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 (HiveMetastoreServiceClient hiveMetastoreServiceClient =
HiveMetastoreServiceClient.create()) {
NamespaceName parent = NamespaceName.of("[PROJECT]", "[CATALOG]", "[DATABASE]");
HiveTable hiveTable = HiveTable.newBuilder().build();
String hiveTableId = "hiveTableId152241145";
HiveTable response =
hiveMetastoreServiceClient.createHiveTable(parent, hiveTable, hiveTableId);
}
| Parameters | |
|---|---|
| Name | Description |
parent |
NamespaceNameRequired. The parent resource for the table to be created. Format: projects/{project_id_or_number}/catalogs/{catalog_id}/databases/{database_id} |
hiveTable |
HiveTableRequired. The Hive Table to create. The |
hiveTableId |
StringRequired. The Hive Table ID to use for the table that will become the final component of the table's resource name. The maximum length is 256 characters. |
| Returns | |
|---|---|
| Type | Description |
HiveTable |
|
createHiveTable(String parent, HiveTable hiveTable, String hiveTableId)
public final HiveTable createHiveTable(String parent, HiveTable hiveTable, String hiveTableId)Creates a new hive table.
Sample code:
// 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 (HiveMetastoreServiceClient hiveMetastoreServiceClient =
HiveMetastoreServiceClient.create()) {
String parent = NamespaceName.of("[PROJECT]", "[CATALOG]", "[DATABASE]").toString();
HiveTable hiveTable = HiveTable.newBuilder().build();
String hiveTableId = "hiveTableId152241145";
HiveTable response =
hiveMetastoreServiceClient.createHiveTable(parent, hiveTable, hiveTableId);
}
| Parameters | |
|---|---|
| Name | Description |
parent |
StringRequired. The parent resource for the table to be created. Format: projects/{project_id_or_number}/catalogs/{catalog_id}/databases/{database_id} |
hiveTable |
HiveTableRequired. The Hive Table to create. The |
hiveTableId |
StringRequired. The Hive Table ID to use for the table that will become the final component of the table's resource name. The maximum length is 256 characters. |
| Returns | |
|---|---|
| Type | Description |
HiveTable |
|
createHiveTableCallable()
public final UnaryCallable<CreateHiveTableRequest,HiveTable> createHiveTableCallable()Creates a new hive table.
Sample code:
// 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 (HiveMetastoreServiceClient hiveMetastoreServiceClient =
HiveMetastoreServiceClient.create()) {
CreateHiveTableRequest request =
CreateHiveTableRequest.newBuilder()
.setParent(NamespaceName.of("[PROJECT]", "[CATALOG]", "[DATABASE]").toString())
.setHiveTable(HiveTable.newBuilder().build())
.setHiveTableId("hiveTableId152241145")
.build();
ApiFuture<HiveTable> future =
hiveMetastoreServiceClient.createHiveTableCallable().futureCall(request);
// Do something.
HiveTable response = future.get();
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<CreateHiveTableRequest,HiveTable> |
|
deleteHiveCatalog(CatalogName name)
public final void deleteHiveCatalog(CatalogName name)Deletes an existing catalog specified by the catalog ID. Delete will fail if the catalog is not empty.
Sample code:
// 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 (HiveMetastoreServiceClient hiveMetastoreServiceClient =
HiveMetastoreServiceClient.create()) {
CatalogName name = CatalogName.of("[PROJECT]", "[CATALOG]");
hiveMetastoreServiceClient.deleteHiveCatalog(name);
}
| Parameter | |
|---|---|
| Name | Description |
name |
CatalogNameRequired. The name of the catalog to delete. Format: projects/{project_id_or_number}/catalogs/{catalog_id} |
deleteHiveCatalog(DeleteHiveCatalogRequest request)
public final void deleteHiveCatalog(DeleteHiveCatalogRequest request)Deletes an existing catalog specified by the catalog ID. Delete will fail if the catalog is not empty.
Sample code:
// 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 (HiveMetastoreServiceClient hiveMetastoreServiceClient =
HiveMetastoreServiceClient.create()) {
DeleteHiveCatalogRequest request =
DeleteHiveCatalogRequest.newBuilder()
.setName(CatalogName.of("[PROJECT]", "[CATALOG]").toString())
.build();
hiveMetastoreServiceClient.deleteHiveCatalog(request);
}
| Parameter | |
|---|---|
| Name | Description |
request |
DeleteHiveCatalogRequestThe request object containing all of the parameters for the API call. |
deleteHiveCatalog(String name)
public final void deleteHiveCatalog(String name)Deletes an existing catalog specified by the catalog ID. Delete will fail if the catalog is not empty.
Sample code:
// 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 (HiveMetastoreServiceClient hiveMetastoreServiceClient =
HiveMetastoreServiceClient.create()) {
String name = CatalogName.of("[PROJECT]", "[CATALOG]").toString();
hiveMetastoreServiceClient.deleteHiveCatalog(name);
}
| Parameter | |
|---|---|
| Name | Description |
name |
StringRequired. The name of the catalog to delete. Format: projects/{project_id_or_number}/catalogs/{catalog_id} |
deleteHiveCatalogCallable()
public final UnaryCallable<DeleteHiveCatalogRequest,Empty> deleteHiveCatalogCallable()Deletes an existing catalog specified by the catalog ID. Delete will fail if the catalog is not empty.
Sample code:
// 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 (HiveMetastoreServiceClient hiveMetastoreServiceClient =
HiveMetastoreServiceClient.create()) {
DeleteHiveCatalogRequest request =
DeleteHiveCatalogRequest.newBuilder()
.setName(CatalogName.of("[PROJECT]", "[CATALOG]").toString())
.build();
ApiFuture<Empty> future =
hiveMetastoreServiceClient.deleteHiveCatalogCallable().futureCall(request);
// Do something.
future.get();
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<DeleteHiveCatalogRequest,Empty> |
|
deleteHiveDatabase(DeleteHiveDatabaseRequest request)
public final void deleteHiveDatabase(DeleteHiveDatabaseRequest request)Deletes an existing database specified by the database name.
Sample code:
// 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 (HiveMetastoreServiceClient hiveMetastoreServiceClient =
HiveMetastoreServiceClient.create()) {
DeleteHiveDatabaseRequest request =
DeleteHiveDatabaseRequest.newBuilder()
.setName(NamespaceName.of("[PROJECT]", "[CATALOG]", "[DATABASE]").toString())
.build();
hiveMetastoreServiceClient.deleteHiveDatabase(request);
}
| Parameter | |
|---|---|
| Name | Description |
request |
DeleteHiveDatabaseRequestThe request object containing all of the parameters for the API call. |
deleteHiveDatabase(NamespaceName name)
public final void deleteHiveDatabase(NamespaceName name)Deletes an existing database specified by the database name.
Sample code:
// 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 (HiveMetastoreServiceClient hiveMetastoreServiceClient =
HiveMetastoreServiceClient.create()) {
NamespaceName name = NamespaceName.of("[PROJECT]", "[CATALOG]", "[DATABASE]");
hiveMetastoreServiceClient.deleteHiveDatabase(name);
}
| Parameter | |
|---|---|
| Name | Description |
name |
NamespaceNameRequired. The name of the database to delete. Format: projects/{project_id_or_number}/catalogs/{catalog_id}/databases/{database_id} |
deleteHiveDatabase(String name)
public final void deleteHiveDatabase(String name)Deletes an existing database specified by the database name.
Sample code:
// 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 (HiveMetastoreServiceClient hiveMetastoreServiceClient =
HiveMetastoreServiceClient.create()) {
String name = NamespaceName.of("[PROJECT]", "[CATALOG]", "[DATABASE]").toString();
hiveMetastoreServiceClient.deleteHiveDatabase(name);
}
| Parameter | |
|---|---|
| Name | Description |
name |
StringRequired. The name of the database to delete. Format: projects/{project_id_or_number}/catalogs/{catalog_id}/databases/{database_id} |
deleteHiveDatabaseCallable()
public final UnaryCallable<DeleteHiveDatabaseRequest,Empty> deleteHiveDatabaseCallable()Deletes an existing database specified by the database name.
Sample code:
// 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 (HiveMetastoreServiceClient hiveMetastoreServiceClient =
HiveMetastoreServiceClient.create()) {
DeleteHiveDatabaseRequest request =
DeleteHiveDatabaseRequest.newBuilder()
.setName(NamespaceName.of("[PROJECT]", "[CATALOG]", "[DATABASE]").toString())
.build();
ApiFuture<Empty> future =
hiveMetastoreServiceClient.deleteHiveDatabaseCallable().futureCall(request);
// Do something.
future.get();
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<DeleteHiveDatabaseRequest,Empty> |
|
deleteHiveTable(DeleteHiveTableRequest request)
public final void deleteHiveTable(DeleteHiveTableRequest request)Deletes an existing table specified by the table name.
Sample code:
// 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 (HiveMetastoreServiceClient hiveMetastoreServiceClient =
HiveMetastoreServiceClient.create()) {
DeleteHiveTableRequest request =
DeleteHiveTableRequest.newBuilder()
.setName(TableName.of("[PROJECT]", "[CATALOG]", "[DATABASE]", "[TABLE]").toString())
.build();
hiveMetastoreServiceClient.deleteHiveTable(request);
}
| Parameter | |
|---|---|
| Name | Description |
request |
DeleteHiveTableRequestThe request object containing all of the parameters for the API call. |
deleteHiveTable(TableName name)
public final void deleteHiveTable(TableName name)Deletes an existing table specified by the table name.
Sample code:
// 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 (HiveMetastoreServiceClient hiveMetastoreServiceClient =
HiveMetastoreServiceClient.create()) {
TableName name = TableName.of("[PROJECT]", "[CATALOG]", "[DATABASE]", "[TABLE]");
hiveMetastoreServiceClient.deleteHiveTable(name);
}
| Parameter | |
|---|---|
| Name | Description |
name |
TableNameRequired. The name of the database to delete. Format: projects/{project_id_or_number}/catalogs/{catalog_id}/databases/{database_id}/tables/{table_id} |
deleteHiveTable(String name)
public final void deleteHiveTable(String name)Deletes an existing table specified by the table name.
Sample code:
// 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 (HiveMetastoreServiceClient hiveMetastoreServiceClient =
HiveMetastoreServiceClient.create()) {
String name = TableName.of("[PROJECT]", "[CATALOG]", "[DATABASE]", "[TABLE]").toString();
hiveMetastoreServiceClient.deleteHiveTable(name);
}
| Parameter | |
|---|---|
| Name | Description |
name |
StringRequired. The name of the database to delete. Format: projects/{project_id_or_number}/catalogs/{catalog_id}/databases/{database_id}/tables/{table_id} |
deleteHiveTableCallable()
public final UnaryCallable<DeleteHiveTableRequest,Empty> deleteHiveTableCallable()Deletes an existing table specified by the table name.
Sample code:
// 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 (HiveMetastoreServiceClient hiveMetastoreServiceClient =
HiveMetastoreServiceClient.create()) {
DeleteHiveTableRequest request =
DeleteHiveTableRequest.newBuilder()
.setName(TableName.of("[PROJECT]", "[CATALOG]", "[DATABASE]", "[TABLE]").toString())
.build();
ApiFuture<Empty> future =
hiveMetastoreServiceClient.deleteHiveTableCallable().futureCall(request);
// Do something.
future.get();
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<DeleteHiveTableRequest,Empty> |
|
getHiveCatalog(CatalogName name)
public final HiveCatalog getHiveCatalog(CatalogName name)Gets the catalog specified by the resource name.
Sample code:
// 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 (HiveMetastoreServiceClient hiveMetastoreServiceClient =
HiveMetastoreServiceClient.create()) {
CatalogName name = CatalogName.of("[PROJECT]", "[CATALOG]");
HiveCatalog response = hiveMetastoreServiceClient.getHiveCatalog(name);
}
| Parameter | |
|---|---|
| Name | Description |
name |
CatalogNameRequired. The name of the catalog to retrieve. Format: projects/{project_id_or_number}/catalogs/{catalog_id} |
| Returns | |
|---|---|
| Type | Description |
HiveCatalog |
|
getHiveCatalog(GetHiveCatalogRequest request)
public final HiveCatalog getHiveCatalog(GetHiveCatalogRequest request)Gets the catalog specified by the resource name.
Sample code:
// 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 (HiveMetastoreServiceClient hiveMetastoreServiceClient =
HiveMetastoreServiceClient.create()) {
GetHiveCatalogRequest request =
GetHiveCatalogRequest.newBuilder()
.setName(CatalogName.of("[PROJECT]", "[CATALOG]").toString())
.build();
HiveCatalog response = hiveMetastoreServiceClient.getHiveCatalog(request);
}
| Parameter | |
|---|---|
| Name | Description |
request |
GetHiveCatalogRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
HiveCatalog |
|
getHiveCatalog(String name)
public final HiveCatalog getHiveCatalog(String name)Gets the catalog specified by the resource name.
Sample code:
// 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 (HiveMetastoreServiceClient hiveMetastoreServiceClient =
HiveMetastoreServiceClient.create()) {
String name = CatalogName.of("[PROJECT]", "[CATALOG]").toString();
HiveCatalog response = hiveMetastoreServiceClient.getHiveCatalog(name);
}
| Parameter | |
|---|---|
| Name | Description |
name |
StringRequired. The name of the catalog to retrieve. Format: projects/{project_id_or_number}/catalogs/{catalog_id} |
| Returns | |
|---|---|
| Type | Description |
HiveCatalog |
|
getHiveCatalogCallable()
public final UnaryCallable<GetHiveCatalogRequest,HiveCatalog> getHiveCatalogCallable()Gets the catalog specified by the resource name.
Sample code:
// 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 (HiveMetastoreServiceClient hiveMetastoreServiceClient =
HiveMetastoreServiceClient.create()) {
GetHiveCatalogRequest request =
GetHiveCatalogRequest.newBuilder()
.setName(CatalogName.of("[PROJECT]", "[CATALOG]").toString())
.build();
ApiFuture<HiveCatalog> future =
hiveMetastoreServiceClient.getHiveCatalogCallable().futureCall(request);
// Do something.
HiveCatalog response = future.get();
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<GetHiveCatalogRequest,HiveCatalog> |
|
getHiveDatabase(GetHiveDatabaseRequest request)
public final HiveDatabase getHiveDatabase(GetHiveDatabaseRequest request)Gets the database specified by the resource name.
Sample code:
// 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 (HiveMetastoreServiceClient hiveMetastoreServiceClient =
HiveMetastoreServiceClient.create()) {
GetHiveDatabaseRequest request =
GetHiveDatabaseRequest.newBuilder()
.setName(NamespaceName.of("[PROJECT]", "[CATALOG]", "[DATABASE]").toString())
.build();
HiveDatabase response = hiveMetastoreServiceClient.getHiveDatabase(request);
}
| Parameter | |
|---|---|
| Name | Description |
request |
GetHiveDatabaseRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
HiveDatabase |
|
getHiveDatabase(NamespaceName name)
public final HiveDatabase getHiveDatabase(NamespaceName name)Gets the database specified by the resource name.
Sample code:
// 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 (HiveMetastoreServiceClient hiveMetastoreServiceClient =
HiveMetastoreServiceClient.create()) {
NamespaceName name = NamespaceName.of("[PROJECT]", "[CATALOG]", "[DATABASE]");
HiveDatabase response = hiveMetastoreServiceClient.getHiveDatabase(name);
}
| Parameter | |
|---|---|
| Name | Description |
name |
NamespaceNameRequired. The name of the database to retrieve. Format: projects/{project_id_or_number}/catalogs/{catalog_id}/databases/{database_id} |
| Returns | |
|---|---|
| Type | Description |
HiveDatabase |
|
getHiveDatabase(String name)
public final HiveDatabase getHiveDatabase(String name)Gets the database specified by the resource name.
Sample code:
// 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 (HiveMetastoreServiceClient hiveMetastoreServiceClient =
HiveMetastoreServiceClient.create()) {
String name = NamespaceName.of("[PROJECT]", "[CATALOG]", "[DATABASE]").toString();
HiveDatabase response = hiveMetastoreServiceClient.getHiveDatabase(name);
}
| Parameter | |
|---|---|
| Name | Description |
name |
StringRequired. The name of the database to retrieve. Format: projects/{project_id_or_number}/catalogs/{catalog_id}/databases/{database_id} |
| Returns | |
|---|---|
| Type | Description |
HiveDatabase |
|
getHiveDatabaseCallable()
public final UnaryCallable<GetHiveDatabaseRequest,HiveDatabase> getHiveDatabaseCallable()Gets the database specified by the resource name.
Sample code:
// 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 (HiveMetastoreServiceClient hiveMetastoreServiceClient =
HiveMetastoreServiceClient.create()) {
GetHiveDatabaseRequest request =
GetHiveDatabaseRequest.newBuilder()
.setName(NamespaceName.of("[PROJECT]", "[CATALOG]", "[DATABASE]").toString())
.build();
ApiFuture<HiveDatabase> future =
hiveMetastoreServiceClient.getHiveDatabaseCallable().futureCall(request);
// Do something.
HiveDatabase response = future.get();
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<GetHiveDatabaseRequest,HiveDatabase> |
|
getHiveTable(GetHiveTableRequest request)
public final HiveTable getHiveTable(GetHiveTableRequest request)Gets the table specified by the resource name.
Sample code:
// 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 (HiveMetastoreServiceClient hiveMetastoreServiceClient =
HiveMetastoreServiceClient.create()) {
GetHiveTableRequest request =
GetHiveTableRequest.newBuilder()
.setName(TableName.of("[PROJECT]", "[CATALOG]", "[DATABASE]", "[TABLE]").toString())
.build();
HiveTable response = hiveMetastoreServiceClient.getHiveTable(request);
}
| Parameter | |
|---|---|
| Name | Description |
request |
GetHiveTableRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
HiveTable |
|
getHiveTable(TableName name)
public final HiveTable getHiveTable(TableName name)Gets the table specified by the resource name.
Sample code:
// 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 (HiveMetastoreServiceClient hiveMetastoreServiceClient =
HiveMetastoreServiceClient.create()) {
TableName name = TableName.of("[PROJECT]", "[CATALOG]", "[DATABASE]", "[TABLE]");
HiveTable response = hiveMetastoreServiceClient.getHiveTable(name);
}
| Parameter | |
|---|---|
| Name | Description |
name |
TableNameRequired. The name of the table to retrieve. Format: projects/{project_id_or_number}/catalogs/{catalog_id}/databases/{database_id}/tables/{table_id} |
| Returns | |
|---|---|
| Type | Description |
HiveTable |
|
getHiveTable(String name)
public final HiveTable getHiveTable(String name)Gets the table specified by the resource name.
Sample code:
// 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 (HiveMetastoreServiceClient hiveMetastoreServiceClient =
HiveMetastoreServiceClient.create()) {
String name = TableName.of("[PROJECT]", "[CATALOG]", "[DATABASE]", "[TABLE]").toString();
HiveTable response = hiveMetastoreServiceClient.getHiveTable(name);
}
| Parameter | |
|---|---|
| Name | Description |
name |
StringRequired. The name of the table to retrieve. Format: projects/{project_id_or_number}/catalogs/{catalog_id}/databases/{database_id}/tables/{table_id} |
| Returns | |
|---|---|
| Type | Description |
HiveTable |
|
getHiveTableCallable()
public final UnaryCallable<GetHiveTableRequest,HiveTable> getHiveTableCallable()Gets the table specified by the resource name.
Sample code:
// 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 (HiveMetastoreServiceClient hiveMetastoreServiceClient =
HiveMetastoreServiceClient.create()) {
GetHiveTableRequest request =
GetHiveTableRequest.newBuilder()
.setName(TableName.of("[PROJECT]", "[CATALOG]", "[DATABASE]", "[TABLE]").toString())
.build();
ApiFuture<HiveTable> future =
hiveMetastoreServiceClient.getHiveTableCallable().futureCall(request);
// Do something.
HiveTable response = future.get();
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<GetHiveTableRequest,HiveTable> |
|
getSettings()
public final HiveMetastoreServiceSettings getSettings()| Returns | |
|---|---|
| Type | Description |
HiveMetastoreServiceSettings |
|
getStub()
public HiveMetastoreServiceStub getStub()| Returns | |
|---|---|
| Type | Description |
HiveMetastoreServiceStub |
|
isShutdown()
public boolean isShutdown()| Returns | |
|---|---|
| Type | Description |
boolean |
|
isTerminated()
public boolean isTerminated()| Returns | |
|---|---|
| Type | Description |
boolean |
|
listHiveCatalogs(ListHiveCatalogsRequest request)
public final HiveMetastoreServiceClient.ListHiveCatalogsPagedResponse listHiveCatalogs(ListHiveCatalogsRequest request)List all catalogs in a specified project.
Sample code:
// 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 (HiveMetastoreServiceClient hiveMetastoreServiceClient =
HiveMetastoreServiceClient.create()) {
ListHiveCatalogsRequest request =
ListHiveCatalogsRequest.newBuilder()
.setParent(ProjectName.of("[PROJECT]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
for (HiveCatalog element :
hiveMetastoreServiceClient.listHiveCatalogs(request).iterateAll()) {
// doThingsWith(element);
}
}
| Parameter | |
|---|---|
| Name | Description |
request |
ListHiveCatalogsRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
HiveMetastoreServiceClient.ListHiveCatalogsPagedResponse |
|
listHiveCatalogs(ProjectName parent)
public final HiveMetastoreServiceClient.ListHiveCatalogsPagedResponse listHiveCatalogs(ProjectName parent)List all catalogs in a specified project.
Sample code:
// 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 (HiveMetastoreServiceClient hiveMetastoreServiceClient =
HiveMetastoreServiceClient.create()) {
ProjectName parent = ProjectName.of("[PROJECT]");
for (HiveCatalog element : hiveMetastoreServiceClient.listHiveCatalogs(parent).iterateAll()) {
// doThingsWith(element);
}
}
| Parameter | |
|---|---|
| Name | Description |
parent |
ProjectNameRequired. The project to list catalogs from. Format: projects/{project_id_or_number} |
| Returns | |
|---|---|
| Type | Description |
HiveMetastoreServiceClient.ListHiveCatalogsPagedResponse |
|
listHiveCatalogs(String parent)
public final HiveMetastoreServiceClient.ListHiveCatalogsPagedResponse listHiveCatalogs(String parent)List all catalogs in a specified project.
Sample code:
// 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 (HiveMetastoreServiceClient hiveMetastoreServiceClient =
HiveMetastoreServiceClient.create()) {
String parent = ProjectName.of("[PROJECT]").toString();
for (HiveCatalog element : hiveMetastoreServiceClient.listHiveCatalogs(parent).iterateAll()) {
// doThingsWith(element);
}
}
| Parameter | |
|---|---|
| Name | Description |
parent |
StringRequired. The project to list catalogs from. Format: projects/{project_id_or_number} |
| Returns | |
|---|---|
| Type | Description |
HiveMetastoreServiceClient.ListHiveCatalogsPagedResponse |
|
listHiveCatalogsCallable()
public final UnaryCallable<ListHiveCatalogsRequest,ListHiveCatalogsResponse> listHiveCatalogsCallable()List all catalogs in a specified project.
Sample code:
// 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 (HiveMetastoreServiceClient hiveMetastoreServiceClient =
HiveMetastoreServiceClient.create()) {
ListHiveCatalogsRequest request =
ListHiveCatalogsRequest.newBuilder()
.setParent(ProjectName.of("[PROJECT]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
while (true) {
ListHiveCatalogsResponse response =
hiveMetastoreServiceClient.listHiveCatalogsCallable().call(request);
for (HiveCatalog element : response.getCatalogsList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<ListHiveCatalogsRequest,ListHiveCatalogsResponse> |
|
listHiveCatalogsPagedCallable()
public final UnaryCallable<ListHiveCatalogsRequest,HiveMetastoreServiceClient.ListHiveCatalogsPagedResponse> listHiveCatalogsPagedCallable()List all catalogs in a specified project.
Sample code:
// 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 (HiveMetastoreServiceClient hiveMetastoreServiceClient =
HiveMetastoreServiceClient.create()) {
ListHiveCatalogsRequest request =
ListHiveCatalogsRequest.newBuilder()
.setParent(ProjectName.of("[PROJECT]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
ApiFuture<HiveCatalog> future =
hiveMetastoreServiceClient.listHiveCatalogsPagedCallable().futureCall(request);
// Do something.
for (HiveCatalog element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<ListHiveCatalogsRequest,ListHiveCatalogsPagedResponse> |
|
listHiveDatabases(CatalogName parent)
public final HiveMetastoreServiceClient.ListHiveDatabasesPagedResponse listHiveDatabases(CatalogName parent)List all databases in a specified catalog.
Sample code:
// 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 (HiveMetastoreServiceClient hiveMetastoreServiceClient =
HiveMetastoreServiceClient.create()) {
CatalogName parent = CatalogName.of("[PROJECT]", "[CATALOG]");
for (HiveDatabase element :
hiveMetastoreServiceClient.listHiveDatabases(parent).iterateAll()) {
// doThingsWith(element);
}
}
| Parameter | |
|---|---|
| Name | Description |
parent |
CatalogNameRequired. The hive catalog to list databases from. Format: projects/{project_id_or_number}/catalogs/{catalog_id} |
| Returns | |
|---|---|
| Type | Description |
HiveMetastoreServiceClient.ListHiveDatabasesPagedResponse |
|
listHiveDatabases(ListHiveDatabasesRequest request)
public final HiveMetastoreServiceClient.ListHiveDatabasesPagedResponse listHiveDatabases(ListHiveDatabasesRequest request)List all databases in a specified catalog.
Sample code:
// 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 (HiveMetastoreServiceClient hiveMetastoreServiceClient =
HiveMetastoreServiceClient.create()) {
ListHiveDatabasesRequest request =
ListHiveDatabasesRequest.newBuilder()
.setParent(CatalogName.of("[PROJECT]", "[CATALOG]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
for (HiveDatabase element :
hiveMetastoreServiceClient.listHiveDatabases(request).iterateAll()) {
// doThingsWith(element);
}
}
| Parameter | |
|---|---|
| Name | Description |
request |
ListHiveDatabasesRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
HiveMetastoreServiceClient.ListHiveDatabasesPagedResponse |
|
listHiveDatabases(String parent)
public final HiveMetastoreServiceClient.ListHiveDatabasesPagedResponse listHiveDatabases(String parent)List all databases in a specified catalog.
Sample code:
// 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 (HiveMetastoreServiceClient hiveMetastoreServiceClient =
HiveMetastoreServiceClient.create()) {
String parent = CatalogName.of("[PROJECT]", "[CATALOG]").toString();
for (HiveDatabase element :
hiveMetastoreServiceClient.listHiveDatabases(parent).iterateAll()) {
// doThingsWith(element);
}
}
| Parameter | |
|---|---|
| Name | Description |
parent |
StringRequired. The hive catalog to list databases from. Format: projects/{project_id_or_number}/catalogs/{catalog_id} |
| Returns | |
|---|---|
| Type | Description |
HiveMetastoreServiceClient.ListHiveDatabasesPagedResponse |
|
listHiveDatabasesCallable()
public final UnaryCallable<ListHiveDatabasesRequest,ListHiveDatabasesResponse> listHiveDatabasesCallable()List all databases in a specified catalog.
Sample code:
// 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 (HiveMetastoreServiceClient hiveMetastoreServiceClient =
HiveMetastoreServiceClient.create()) {
ListHiveDatabasesRequest request =
ListHiveDatabasesRequest.newBuilder()
.setParent(CatalogName.of("[PROJECT]", "[CATALOG]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
while (true) {
ListHiveDatabasesResponse response =
hiveMetastoreServiceClient.listHiveDatabasesCallable().call(request);
for (HiveDatabase element : response.getDatabasesList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<ListHiveDatabasesRequest,ListHiveDatabasesResponse> |
|
listHiveDatabasesPagedCallable()
public final UnaryCallable<ListHiveDatabasesRequest,HiveMetastoreServiceClient.ListHiveDatabasesPagedResponse> listHiveDatabasesPagedCallable()List all databases in a specified catalog.
Sample code:
// 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 (HiveMetastoreServiceClient hiveMetastoreServiceClient =
HiveMetastoreServiceClient.create()) {
ListHiveDatabasesRequest request =
ListHiveDatabasesRequest.newBuilder()
.setParent(CatalogName.of("[PROJECT]", "[CATALOG]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
ApiFuture<HiveDatabase> future =
hiveMetastoreServiceClient.listHiveDatabasesPagedCallable().futureCall(request);
// Do something.
for (HiveDatabase element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<ListHiveDatabasesRequest,ListHiveDatabasesPagedResponse> |
|
listHiveTables(ListHiveTablesRequest request)
public final HiveMetastoreServiceClient.ListHiveTablesPagedResponse listHiveTables(ListHiveTablesRequest request)List all hive tables in a specified project under the hive catalog and database.
Sample code:
// 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 (HiveMetastoreServiceClient hiveMetastoreServiceClient =
HiveMetastoreServiceClient.create()) {
ListHiveTablesRequest request =
ListHiveTablesRequest.newBuilder()
.setParent(NamespaceName.of("[PROJECT]", "[CATALOG]", "[DATABASE]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
for (HiveTable element : hiveMetastoreServiceClient.listHiveTables(request).iterateAll()) {
// doThingsWith(element);
}
}
| Parameter | |
|---|---|
| Name | Description |
request |
ListHiveTablesRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
HiveMetastoreServiceClient.ListHiveTablesPagedResponse |
|
listHiveTables(NamespaceName parent)
public final HiveMetastoreServiceClient.ListHiveTablesPagedResponse listHiveTables(NamespaceName parent)List all hive tables in a specified project under the hive catalog and database.
Sample code:
// 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 (HiveMetastoreServiceClient hiveMetastoreServiceClient =
HiveMetastoreServiceClient.create()) {
NamespaceName parent = NamespaceName.of("[PROJECT]", "[CATALOG]", "[DATABASE]");
for (HiveTable element : hiveMetastoreServiceClient.listHiveTables(parent).iterateAll()) {
// doThingsWith(element);
}
}
| Parameter | |
|---|---|
| Name | Description |
parent |
NamespaceNameRequired. The database to list tables from. Format: projects/{project_id_or_number}/catalogs/{catalog_id}/databases/{database_id} |
| Returns | |
|---|---|
| Type | Description |
HiveMetastoreServiceClient.ListHiveTablesPagedResponse |
|
listHiveTables(String parent)
public final HiveMetastoreServiceClient.ListHiveTablesPagedResponse listHiveTables(String parent)List all hive tables in a specified project under the hive catalog and database.
Sample code:
// 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 (HiveMetastoreServiceClient hiveMetastoreServiceClient =
HiveMetastoreServiceClient.create()) {
String parent = NamespaceName.of("[PROJECT]", "[CATALOG]", "[DATABASE]").toString();
for (HiveTable element : hiveMetastoreServiceClient.listHiveTables(parent).iterateAll()) {
// doThingsWith(element);
}
}
| Parameter | |
|---|---|
| Name | Description |
parent |
StringRequired. The database to list tables from. Format: projects/{project_id_or_number}/catalogs/{catalog_id}/databases/{database_id} |
| Returns | |
|---|---|
| Type | Description |
HiveMetastoreServiceClient.ListHiveTablesPagedResponse |
|
listHiveTablesCallable()
public final UnaryCallable<ListHiveTablesRequest,ListHiveTablesResponse> listHiveTablesCallable()List all hive tables in a specified project under the hive catalog and database.
Sample code:
// 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 (HiveMetastoreServiceClient hiveMetastoreServiceClient =
HiveMetastoreServiceClient.create()) {
ListHiveTablesRequest request =
ListHiveTablesRequest.newBuilder()
.setParent(NamespaceName.of("[PROJECT]", "[CATALOG]", "[DATABASE]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
while (true) {
ListHiveTablesResponse response =
hiveMetastoreServiceClient.listHiveTablesCallable().call(request);
for (HiveTable element : response.getTablesList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<ListHiveTablesRequest,ListHiveTablesResponse> |
|
listHiveTablesPagedCallable()
public final UnaryCallable<ListHiveTablesRequest,HiveMetastoreServiceClient.ListHiveTablesPagedResponse> listHiveTablesPagedCallable()List all hive tables in a specified project under the hive catalog and database.
Sample code:
// 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 (HiveMetastoreServiceClient hiveMetastoreServiceClient =
HiveMetastoreServiceClient.create()) {
ListHiveTablesRequest request =
ListHiveTablesRequest.newBuilder()
.setParent(NamespaceName.of("[PROJECT]", "[CATALOG]", "[DATABASE]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.build();
ApiFuture<HiveTable> future =
hiveMetastoreServiceClient.listHiveTablesPagedCallable().futureCall(request);
// Do something.
for (HiveTable element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<ListHiveTablesRequest,ListHiveTablesPagedResponse> |
|
listPartitionsCallable()
public final ServerStreamingCallable<ListPartitionsRequest,ListPartitionsResponse> listPartitionsCallable()Streams list of partitions from a table.
Sample code:
// 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 (HiveMetastoreServiceClient hiveMetastoreServiceClient =
HiveMetastoreServiceClient.create()) {
ListPartitionsRequest request =
ListPartitionsRequest.newBuilder()
.setParent(TableName.of("[PROJECT]", "[CATALOG]", "[DATABASE]", "[TABLE]").toString())
.setFilter("filter-1274492040")
.build();
ServerStream<ListPartitionsResponse> stream =
hiveMetastoreServiceClient.listPartitionsCallable().call(request);
for (ListPartitionsResponse response : stream) {
// Do something when a response is received.
}
}
| Returns | |
|---|---|
| Type | Description |
ServerStreamingCallable<ListPartitionsRequest,ListPartitionsResponse> |
|
shutdown()
public void shutdown()shutdownNow()
public void shutdownNow()updateHiveCatalog(HiveCatalog hiveCatalog, FieldMask updateMask)
public final HiveCatalog updateHiveCatalog(HiveCatalog hiveCatalog, FieldMask updateMask)Updates an existing catalog.
Sample code:
// 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 (HiveMetastoreServiceClient hiveMetastoreServiceClient =
HiveMetastoreServiceClient.create()) {
HiveCatalog hiveCatalog = HiveCatalog.newBuilder().build();
FieldMask updateMask = FieldMask.newBuilder().build();
HiveCatalog response = hiveMetastoreServiceClient.updateHiveCatalog(hiveCatalog, updateMask);
}
| Parameters | |
|---|---|
| Name | Description |
hiveCatalog |
HiveCatalogRequired. The hive catalog to update. The name under the catalog is used to identify the catalog. Format: projects/{project_id_or_number}/catalogs/{catalog_id} |
updateMask |
FieldMaskOptional. The list of fields to update. For the |
| Returns | |
|---|---|
| Type | Description |
HiveCatalog |
|
updateHiveCatalog(UpdateHiveCatalogRequest request)
public final HiveCatalog updateHiveCatalog(UpdateHiveCatalogRequest request)Updates an existing catalog.
Sample code:
// 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 (HiveMetastoreServiceClient hiveMetastoreServiceClient =
HiveMetastoreServiceClient.create()) {
UpdateHiveCatalogRequest request =
UpdateHiveCatalogRequest.newBuilder()
.setHiveCatalog(HiveCatalog.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.build();
HiveCatalog response = hiveMetastoreServiceClient.updateHiveCatalog(request);
}
| Parameter | |
|---|---|
| Name | Description |
request |
UpdateHiveCatalogRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
HiveCatalog |
|
updateHiveCatalogCallable()
public final UnaryCallable<UpdateHiveCatalogRequest,HiveCatalog> updateHiveCatalogCallable()Updates an existing catalog.
Sample code:
// 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 (HiveMetastoreServiceClient hiveMetastoreServiceClient =
HiveMetastoreServiceClient.create()) {
UpdateHiveCatalogRequest request =
UpdateHiveCatalogRequest.newBuilder()
.setHiveCatalog(HiveCatalog.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.build();
ApiFuture<HiveCatalog> future =
hiveMetastoreServiceClient.updateHiveCatalogCallable().futureCall(request);
// Do something.
HiveCatalog response = future.get();
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<UpdateHiveCatalogRequest,HiveCatalog> |
|
updateHiveDatabase(HiveDatabase hiveDatabase, FieldMask updateMask)
public final HiveDatabase updateHiveDatabase(HiveDatabase hiveDatabase, FieldMask updateMask)Updates an existing database specified by the database name.
Sample code:
// 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 (HiveMetastoreServiceClient hiveMetastoreServiceClient =
HiveMetastoreServiceClient.create()) {
HiveDatabase hiveDatabase = HiveDatabase.newBuilder().build();
FieldMask updateMask = FieldMask.newBuilder().build();
HiveDatabase response =
hiveMetastoreServiceClient.updateHiveDatabase(hiveDatabase, updateMask);
}
| Parameters | |
|---|---|
| Name | Description |
hiveDatabase |
HiveDatabaseRequired. The database to update. The database's |
updateMask |
FieldMaskOptional. The list of fields to update. |
| Returns | |
|---|---|
| Type | Description |
HiveDatabase |
|
updateHiveDatabase(UpdateHiveDatabaseRequest request)
public final HiveDatabase updateHiveDatabase(UpdateHiveDatabaseRequest request)Updates an existing database specified by the database name.
Sample code:
// 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 (HiveMetastoreServiceClient hiveMetastoreServiceClient =
HiveMetastoreServiceClient.create()) {
UpdateHiveDatabaseRequest request =
UpdateHiveDatabaseRequest.newBuilder()
.setHiveDatabase(HiveDatabase.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.build();
HiveDatabase response = hiveMetastoreServiceClient.updateHiveDatabase(request);
}
| Parameter | |
|---|---|
| Name | Description |
request |
UpdateHiveDatabaseRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
HiveDatabase |
|
updateHiveDatabaseCallable()
public final UnaryCallable<UpdateHiveDatabaseRequest,HiveDatabase> updateHiveDatabaseCallable()Updates an existing database specified by the database name.
Sample code:
// 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 (HiveMetastoreServiceClient hiveMetastoreServiceClient =
HiveMetastoreServiceClient.create()) {
UpdateHiveDatabaseRequest request =
UpdateHiveDatabaseRequest.newBuilder()
.setHiveDatabase(HiveDatabase.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.build();
ApiFuture<HiveDatabase> future =
hiveMetastoreServiceClient.updateHiveDatabaseCallable().futureCall(request);
// Do something.
HiveDatabase response = future.get();
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<UpdateHiveDatabaseRequest,HiveDatabase> |
|
updateHiveTable(HiveTable hiveTable, FieldMask updateMask)
public final HiveTable updateHiveTable(HiveTable hiveTable, FieldMask updateMask)Updates an existing table specified by the table name.
Sample code:
// 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 (HiveMetastoreServiceClient hiveMetastoreServiceClient =
HiveMetastoreServiceClient.create()) {
HiveTable hiveTable = HiveTable.newBuilder().build();
FieldMask updateMask = FieldMask.newBuilder().build();
HiveTable response = hiveMetastoreServiceClient.updateHiveTable(hiveTable, updateMask);
}
| Parameters | |
|---|---|
| Name | Description |
hiveTable |
HiveTableRequired. The table to update. The table's |
updateMask |
FieldMaskOptional. The list of fields to update. |
| Returns | |
|---|---|
| Type | Description |
HiveTable |
|
updateHiveTable(UpdateHiveTableRequest request)
public final HiveTable updateHiveTable(UpdateHiveTableRequest request)Updates an existing table specified by the table name.
Sample code:
// 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 (HiveMetastoreServiceClient hiveMetastoreServiceClient =
HiveMetastoreServiceClient.create()) {
UpdateHiveTableRequest request =
UpdateHiveTableRequest.newBuilder()
.setHiveTable(HiveTable.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.build();
HiveTable response = hiveMetastoreServiceClient.updateHiveTable(request);
}
| Parameter | |
|---|---|
| Name | Description |
request |
UpdateHiveTableRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
HiveTable |
|
updateHiveTableCallable()
public final UnaryCallable<UpdateHiveTableRequest,HiveTable> updateHiveTableCallable()Updates an existing table specified by the table name.
Sample code:
// 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 (HiveMetastoreServiceClient hiveMetastoreServiceClient =
HiveMetastoreServiceClient.create()) {
UpdateHiveTableRequest request =
UpdateHiveTableRequest.newBuilder()
.setHiveTable(HiveTable.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.build();
ApiFuture<HiveTable> future =
hiveMetastoreServiceClient.updateHiveTableCallable().futureCall(request);
// Do something.
HiveTable response = future.get();
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<UpdateHiveTableRequest,HiveTable> |
|