- 2.55.0 (latest)
- 2.54.0
- 2.53.0
- 2.52.0
- 2.50.0
- 2.49.0
- 2.48.0
- 2.47.0
- 2.46.0
- 2.45.0
- 2.44.0
- 2.43.0
- 2.42.0
- 2.41.0
- 2.40.0
- 2.38.0
- 2.37.0
- 2.36.0
- 2.35.0
- 2.34.0
- 2.33.0
- 2.32.0
- 2.31.0
- 2.30.0
- 2.29.0
- 2.28.0
- 2.25.0
- 2.24.0
- 2.23.0
- 2.22.0
- 2.21.0
- 2.20.0
- 2.19.0
- 2.18.0
- 2.17.0
- 2.16.0
- 2.15.0
- 2.14.0
- 2.13.0
- 2.12.0
- 2.10.0
- 2.9.0
- 2.8.0
- 2.7.0
- 2.6.0
- 2.5.0
- 2.4.4
- 2.3.0
- 2.2.0
- 2.1.9
public class DataprocMetastoreClient implements BackgroundResource
Service Description: Configures and manages metastore services. Metastore services are fully managed, highly available, autoscaled, autohealing, OSS-native deployments of technical metadata management software. Each metastore service exposes a network endpoint through which metadata queries are served. Metadata queries can originate from a variety of sources, including Apache Hive, Apache Presto, and Apache Spark.
The Dataproc Metastore API defines the following resource model:
- The service works with a collection of Google Cloud projects, named:
/projects/*
- Each project has a collection of available locations, named:
/locations/*
(a location must refer to a Google Cloudregion
) - Each location has a collection of services, named:
/services/*
- Dataproc Metastore services are resources with names of the form:
/projects/{project_number}/locations/{location_id}/services/{service_id}
.
This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
ServiceName name = ServiceName.of("[PROJECT]", "[LOCATION]", "[SERVICE]");
Service response = dataprocMetastoreClient.getService(name);
}
Note: close() needs to be called on the DataprocMetastoreClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().
The surface of this class includes several types of Java methods for each of the API's methods:
- A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
- A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
- A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.
See the individual methods for example code.
Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.
This class can be customized by passing in a custom instance of DataprocMetastoreSettings to create(). For example:
To customize credentials:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
DataprocMetastoreSettings dataprocMetastoreSettings =
DataprocMetastoreSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
DataprocMetastoreClient dataprocMetastoreClient =
DataprocMetastoreClient.create(dataprocMetastoreSettings);
To customize the endpoint:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
DataprocMetastoreSettings dataprocMetastoreSettings =
DataprocMetastoreSettings.newBuilder().setEndpoint(myEndpoint).build();
DataprocMetastoreClient dataprocMetastoreClient =
DataprocMetastoreClient.create(dataprocMetastoreSettings);
To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
DataprocMetastoreSettings dataprocMetastoreSettings =
DataprocMetastoreSettings.newBuilder()
.setTransportChannelProvider(
DataprocMetastoreSettings.defaultHttpJsonTransportProviderBuilder().build())
.build();
DataprocMetastoreClient dataprocMetastoreClient =
DataprocMetastoreClient.create(dataprocMetastoreSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
Implements
BackgroundResourceStatic Methods
create()
public static final DataprocMetastoreClient create()
Constructs an instance of DataprocMetastoreClient with default settings.
Type | Description |
DataprocMetastoreClient |
Type | Description |
IOException |
create(DataprocMetastoreSettings settings)
public static final DataprocMetastoreClient create(DataprocMetastoreSettings settings)
Constructs an instance of DataprocMetastoreClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.
Name | Description |
settings | DataprocMetastoreSettings |
Type | Description |
DataprocMetastoreClient |
Type | Description |
IOException |
create(DataprocMetastoreStub stub)
public static final DataprocMetastoreClient create(DataprocMetastoreStub stub)
Constructs an instance of DataprocMetastoreClient, using the given stub for making calls. This is for advanced usage - prefer using create(DataprocMetastoreSettings).
Name | Description |
stub | DataprocMetastoreStub |
Type | Description |
DataprocMetastoreClient |
Constructors
DataprocMetastoreClient(DataprocMetastoreSettings settings)
protected DataprocMetastoreClient(DataprocMetastoreSettings settings)
Constructs an instance of DataprocMetastoreClient, 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.
Name | Description |
settings | DataprocMetastoreSettings |
DataprocMetastoreClient(DataprocMetastoreStub stub)
protected DataprocMetastoreClient(DataprocMetastoreStub stub)
Name | Description |
stub | DataprocMetastoreStub |
Methods
awaitTermination(long duration, TimeUnit unit)
public boolean awaitTermination(long duration, TimeUnit unit)
Name | Description |
duration | long |
unit | TimeUnit |
Type | Description |
boolean |
Type | Description |
InterruptedException |
close()
public final void close()
createBackupAsync(CreateBackupRequest request)
public final OperationFuture<Backup,OperationMetadata> createBackupAsync(CreateBackupRequest request)
Creates a new backup in a given project and location.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
CreateBackupRequest request =
CreateBackupRequest.newBuilder()
.setParent(ServiceName.of("[PROJECT]", "[LOCATION]", "[SERVICE]").toString())
.setBackupId("backupId2121930365")
.setBackup(Backup.newBuilder().build())
.setRequestId("requestId693933066")
.build();
Backup response = dataprocMetastoreClient.createBackupAsync(request).get();
}
Name | Description |
request | CreateBackupRequest The request object containing all of the parameters for the API call. |
Type | Description |
OperationFuture<Backup,OperationMetadata> |
createBackupAsync(ServiceName parent, Backup backup, String backupId)
public final OperationFuture<Backup,OperationMetadata> createBackupAsync(ServiceName parent, Backup backup, String backupId)
Creates a new backup in a given project and location.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
ServiceName parent = ServiceName.of("[PROJECT]", "[LOCATION]", "[SERVICE]");
Backup backup = Backup.newBuilder().build();
String backupId = "backupId2121930365";
Backup response = dataprocMetastoreClient.createBackupAsync(parent, backup, backupId).get();
}
Name | Description |
parent | ServiceName Required. The relative resource name of the service in which to create a backup of the following form:
|
backup | Backup Required. The backup to create. The |
backupId | String Required. The ID of the backup, which is used as the final component of the backup's name. This value must be between 1 and 64 characters long, begin with a letter, end with a letter or number, and consist of alpha-numeric ASCII characters or hyphens. |
Type | Description |
OperationFuture<Backup,OperationMetadata> |
createBackupAsync(String parent, Backup backup, String backupId)
public final OperationFuture<Backup,OperationMetadata> createBackupAsync(String parent, Backup backup, String backupId)
Creates a new backup in a given project and location.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
String parent = ServiceName.of("[PROJECT]", "[LOCATION]", "[SERVICE]").toString();
Backup backup = Backup.newBuilder().build();
String backupId = "backupId2121930365";
Backup response = dataprocMetastoreClient.createBackupAsync(parent, backup, backupId).get();
}
Name | Description |
parent | String Required. The relative resource name of the service in which to create a backup of the following form:
|
backup | Backup Required. The backup to create. The |
backupId | String Required. The ID of the backup, which is used as the final component of the backup's name. This value must be between 1 and 64 characters long, begin with a letter, end with a letter or number, and consist of alpha-numeric ASCII characters or hyphens. |
Type | Description |
OperationFuture<Backup,OperationMetadata> |
createBackupCallable()
public final UnaryCallable<CreateBackupRequest,Operation> createBackupCallable()
Creates a new backup in a given project and location.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
CreateBackupRequest request =
CreateBackupRequest.newBuilder()
.setParent(ServiceName.of("[PROJECT]", "[LOCATION]", "[SERVICE]").toString())
.setBackupId("backupId2121930365")
.setBackup(Backup.newBuilder().build())
.setRequestId("requestId693933066")
.build();
ApiFuture<Operation> future =
dataprocMetastoreClient.createBackupCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
Type | Description |
UnaryCallable<CreateBackupRequest,Operation> |
createBackupOperationCallable()
public final OperationCallable<CreateBackupRequest,Backup,OperationMetadata> createBackupOperationCallable()
Creates a new backup in a given project and location.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
CreateBackupRequest request =
CreateBackupRequest.newBuilder()
.setParent(ServiceName.of("[PROJECT]", "[LOCATION]", "[SERVICE]").toString())
.setBackupId("backupId2121930365")
.setBackup(Backup.newBuilder().build())
.setRequestId("requestId693933066")
.build();
OperationFuture<Backup, OperationMetadata> future =
dataprocMetastoreClient.createBackupOperationCallable().futureCall(request);
// Do something.
Backup response = future.get();
}
Type | Description |
OperationCallable<CreateBackupRequest,Backup,OperationMetadata> |
createMetadataImportAsync(CreateMetadataImportRequest request)
public final OperationFuture<MetadataImport,OperationMetadata> createMetadataImportAsync(CreateMetadataImportRequest request)
Creates a new MetadataImport in a given project and location.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
CreateMetadataImportRequest request =
CreateMetadataImportRequest.newBuilder()
.setParent(ServiceName.of("[PROJECT]", "[LOCATION]", "[SERVICE]").toString())
.setMetadataImportId("metadataImportId1824548847")
.setMetadataImport(MetadataImport.newBuilder().build())
.setRequestId("requestId693933066")
.build();
MetadataImport response = dataprocMetastoreClient.createMetadataImportAsync(request).get();
}
Name | Description |
request | CreateMetadataImportRequest The request object containing all of the parameters for the API call. |
Type | Description |
OperationFuture<MetadataImport,OperationMetadata> |
createMetadataImportAsync(ServiceName parent, MetadataImport metadataImport, String metadataImportId)
public final OperationFuture<MetadataImport,OperationMetadata> createMetadataImportAsync(ServiceName parent, MetadataImport metadataImport, String metadataImportId)
Creates a new MetadataImport in a given project and location.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
ServiceName parent = ServiceName.of("[PROJECT]", "[LOCATION]", "[SERVICE]");
MetadataImport metadataImport = MetadataImport.newBuilder().build();
String metadataImportId = "metadataImportId1824548847";
MetadataImport response =
dataprocMetastoreClient
.createMetadataImportAsync(parent, metadataImport, metadataImportId)
.get();
}
Name | Description |
parent | ServiceName Required. The relative resource name of the service in which to create a metastore import, in the following form:
|
metadataImport | MetadataImport Required. The metadata import to create. The |
metadataImportId | String Required. The ID of the metadata import, which is used as the final component of the metadata import's name. This value must be between 1 and 64 characters long, begin with a letter, end with a letter or number, and consist of alpha-numeric ASCII characters or hyphens. |
Type | Description |
OperationFuture<MetadataImport,OperationMetadata> |
createMetadataImportAsync(String parent, MetadataImport metadataImport, String metadataImportId)
public final OperationFuture<MetadataImport,OperationMetadata> createMetadataImportAsync(String parent, MetadataImport metadataImport, String metadataImportId)
Creates a new MetadataImport in a given project and location.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
String parent = ServiceName.of("[PROJECT]", "[LOCATION]", "[SERVICE]").toString();
MetadataImport metadataImport = MetadataImport.newBuilder().build();
String metadataImportId = "metadataImportId1824548847";
MetadataImport response =
dataprocMetastoreClient
.createMetadataImportAsync(parent, metadataImport, metadataImportId)
.get();
}
Name | Description |
parent | String Required. The relative resource name of the service in which to create a metastore import, in the following form:
|
metadataImport | MetadataImport Required. The metadata import to create. The |
metadataImportId | String Required. The ID of the metadata import, which is used as the final component of the metadata import's name. This value must be between 1 and 64 characters long, begin with a letter, end with a letter or number, and consist of alpha-numeric ASCII characters or hyphens. |
Type | Description |
OperationFuture<MetadataImport,OperationMetadata> |
createMetadataImportCallable()
public final UnaryCallable<CreateMetadataImportRequest,Operation> createMetadataImportCallable()
Creates a new MetadataImport in a given project and location.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
CreateMetadataImportRequest request =
CreateMetadataImportRequest.newBuilder()
.setParent(ServiceName.of("[PROJECT]", "[LOCATION]", "[SERVICE]").toString())
.setMetadataImportId("metadataImportId1824548847")
.setMetadataImport(MetadataImport.newBuilder().build())
.setRequestId("requestId693933066")
.build();
ApiFuture<Operation> future =
dataprocMetastoreClient.createMetadataImportCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
Type | Description |
UnaryCallable<CreateMetadataImportRequest,Operation> |
createMetadataImportOperationCallable()
public final OperationCallable<CreateMetadataImportRequest,MetadataImport,OperationMetadata> createMetadataImportOperationCallable()
Creates a new MetadataImport in a given project and location.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
CreateMetadataImportRequest request =
CreateMetadataImportRequest.newBuilder()
.setParent(ServiceName.of("[PROJECT]", "[LOCATION]", "[SERVICE]").toString())
.setMetadataImportId("metadataImportId1824548847")
.setMetadataImport(MetadataImport.newBuilder().build())
.setRequestId("requestId693933066")
.build();
OperationFuture<MetadataImport, OperationMetadata> future =
dataprocMetastoreClient.createMetadataImportOperationCallable().futureCall(request);
// Do something.
MetadataImport response = future.get();
}
Type | Description |
OperationCallable<CreateMetadataImportRequest,MetadataImport,OperationMetadata> |
createServiceAsync(CreateServiceRequest request)
public final OperationFuture<Service,OperationMetadata> createServiceAsync(CreateServiceRequest request)
Creates a metastore service in a project and location.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
CreateServiceRequest request =
CreateServiceRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setServiceId("serviceId-194185552")
.setService(Service.newBuilder().build())
.setRequestId("requestId693933066")
.build();
Service response = dataprocMetastoreClient.createServiceAsync(request).get();
}
Name | Description |
request | CreateServiceRequest The request object containing all of the parameters for the API call. |
Type | Description |
OperationFuture<Service,OperationMetadata> |
createServiceAsync(LocationName parent, Service service, String serviceId)
public final OperationFuture<Service,OperationMetadata> createServiceAsync(LocationName parent, Service service, String serviceId)
Creates a metastore service in a project and location.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
Service service = Service.newBuilder().build();
String serviceId = "serviceId-194185552";
Service response =
dataprocMetastoreClient.createServiceAsync(parent, service, serviceId).get();
}
Name | Description |
parent | LocationName Required. The relative resource name of the location in which to create a metastore service, in the following form:
|
service | Service Required. The Metastore service to create. The |
serviceId | String Required. The ID of the metastore service, which is used as the final component of the metastore service's name. This value must be between 2 and 63 characters long inclusive, begin with a letter, end with a letter or number, and consist of alpha-numeric ASCII characters or hyphens. |
Type | Description |
OperationFuture<Service,OperationMetadata> |
createServiceAsync(String parent, Service service, String serviceId)
public final OperationFuture<Service,OperationMetadata> createServiceAsync(String parent, Service service, String serviceId)
Creates a metastore service in a project and location.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
Service service = Service.newBuilder().build();
String serviceId = "serviceId-194185552";
Service response =
dataprocMetastoreClient.createServiceAsync(parent, service, serviceId).get();
}
Name | Description |
parent | String Required. The relative resource name of the location in which to create a metastore service, in the following form:
|
service | Service Required. The Metastore service to create. The |
serviceId | String Required. The ID of the metastore service, which is used as the final component of the metastore service's name. This value must be between 2 and 63 characters long inclusive, begin with a letter, end with a letter or number, and consist of alpha-numeric ASCII characters or hyphens. |
Type | Description |
OperationFuture<Service,OperationMetadata> |
createServiceCallable()
public final UnaryCallable<CreateServiceRequest,Operation> createServiceCallable()
Creates a metastore service in a project and location.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
CreateServiceRequest request =
CreateServiceRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setServiceId("serviceId-194185552")
.setService(Service.newBuilder().build())
.setRequestId("requestId693933066")
.build();
ApiFuture<Operation> future =
dataprocMetastoreClient.createServiceCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
Type | Description |
UnaryCallable<CreateServiceRequest,Operation> |
createServiceOperationCallable()
public final OperationCallable<CreateServiceRequest,Service,OperationMetadata> createServiceOperationCallable()
Creates a metastore service in a project and location.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
CreateServiceRequest request =
CreateServiceRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setServiceId("serviceId-194185552")
.setService(Service.newBuilder().build())
.setRequestId("requestId693933066")
.build();
OperationFuture<Service, OperationMetadata> future =
dataprocMetastoreClient.createServiceOperationCallable().futureCall(request);
// Do something.
Service response = future.get();
}
Type | Description |
OperationCallable<CreateServiceRequest,Service,OperationMetadata> |
deleteBackupAsync(BackupName name)
public final OperationFuture<Empty,OperationMetadata> deleteBackupAsync(BackupName name)
Deletes a single backup.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
BackupName name = BackupName.of("[PROJECT]", "[LOCATION]", "[SERVICE]", "[BACKUP]");
dataprocMetastoreClient.deleteBackupAsync(name).get();
}
Name | Description |
name | BackupName Required. The relative resource name of the backup to delete, in the following form:
|
Type | Description |
OperationFuture<Empty,OperationMetadata> |
deleteBackupAsync(DeleteBackupRequest request)
public final OperationFuture<Empty,OperationMetadata> deleteBackupAsync(DeleteBackupRequest request)
Deletes a single backup.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
DeleteBackupRequest request =
DeleteBackupRequest.newBuilder()
.setName(BackupName.of("[PROJECT]", "[LOCATION]", "[SERVICE]", "[BACKUP]").toString())
.setRequestId("requestId693933066")
.build();
dataprocMetastoreClient.deleteBackupAsync(request).get();
}
Name | Description |
request | DeleteBackupRequest The request object containing all of the parameters for the API call. |
Type | Description |
OperationFuture<Empty,OperationMetadata> |
deleteBackupAsync(String name)
public final OperationFuture<Empty,OperationMetadata> deleteBackupAsync(String name)
Deletes a single backup.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
String name = BackupName.of("[PROJECT]", "[LOCATION]", "[SERVICE]", "[BACKUP]").toString();
dataprocMetastoreClient.deleteBackupAsync(name).get();
}
Name | Description |
name | String Required. The relative resource name of the backup to delete, in the following form:
|
Type | Description |
OperationFuture<Empty,OperationMetadata> |
deleteBackupCallable()
public final UnaryCallable<DeleteBackupRequest,Operation> deleteBackupCallable()
Deletes a single backup.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
DeleteBackupRequest request =
DeleteBackupRequest.newBuilder()
.setName(BackupName.of("[PROJECT]", "[LOCATION]", "[SERVICE]", "[BACKUP]").toString())
.setRequestId("requestId693933066")
.build();
ApiFuture<Operation> future =
dataprocMetastoreClient.deleteBackupCallable().futureCall(request);
// Do something.
future.get();
}
Type | Description |
UnaryCallable<DeleteBackupRequest,Operation> |
deleteBackupOperationCallable()
public final OperationCallable<DeleteBackupRequest,Empty,OperationMetadata> deleteBackupOperationCallable()
Deletes a single backup.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
DeleteBackupRequest request =
DeleteBackupRequest.newBuilder()
.setName(BackupName.of("[PROJECT]", "[LOCATION]", "[SERVICE]", "[BACKUP]").toString())
.setRequestId("requestId693933066")
.build();
OperationFuture<Empty, OperationMetadata> future =
dataprocMetastoreClient.deleteBackupOperationCallable().futureCall(request);
// Do something.
future.get();
}
Type | Description |
OperationCallable<DeleteBackupRequest,Empty,OperationMetadata> |
deleteServiceAsync(DeleteServiceRequest request)
public final OperationFuture<Empty,OperationMetadata> deleteServiceAsync(DeleteServiceRequest request)
Deletes a single service.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
DeleteServiceRequest request =
DeleteServiceRequest.newBuilder()
.setName(ServiceName.of("[PROJECT]", "[LOCATION]", "[SERVICE]").toString())
.setRequestId("requestId693933066")
.build();
dataprocMetastoreClient.deleteServiceAsync(request).get();
}
Name | Description |
request | DeleteServiceRequest The request object containing all of the parameters for the API call. |
Type | Description |
OperationFuture<Empty,OperationMetadata> |
deleteServiceAsync(ServiceName name)
public final OperationFuture<Empty,OperationMetadata> deleteServiceAsync(ServiceName name)
Deletes a single service.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
ServiceName name = ServiceName.of("[PROJECT]", "[LOCATION]", "[SERVICE]");
dataprocMetastoreClient.deleteServiceAsync(name).get();
}
Name | Description |
name | ServiceName Required. The relative resource name of the metastore service to delete, in the following form:
|
Type | Description |
OperationFuture<Empty,OperationMetadata> |
deleteServiceAsync(String name)
public final OperationFuture<Empty,OperationMetadata> deleteServiceAsync(String name)
Deletes a single service.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
String name = ServiceName.of("[PROJECT]", "[LOCATION]", "[SERVICE]").toString();
dataprocMetastoreClient.deleteServiceAsync(name).get();
}
Name | Description |
name | String Required. The relative resource name of the metastore service to delete, in the following form:
|
Type | Description |
OperationFuture<Empty,OperationMetadata> |
deleteServiceCallable()
public final UnaryCallable<DeleteServiceRequest,Operation> deleteServiceCallable()
Deletes a single service.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
DeleteServiceRequest request =
DeleteServiceRequest.newBuilder()
.setName(ServiceName.of("[PROJECT]", "[LOCATION]", "[SERVICE]").toString())
.setRequestId("requestId693933066")
.build();
ApiFuture<Operation> future =
dataprocMetastoreClient.deleteServiceCallable().futureCall(request);
// Do something.
future.get();
}
Type | Description |
UnaryCallable<DeleteServiceRequest,Operation> |
deleteServiceOperationCallable()
public final OperationCallable<DeleteServiceRequest,Empty,OperationMetadata> deleteServiceOperationCallable()
Deletes a single service.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
DeleteServiceRequest request =
DeleteServiceRequest.newBuilder()
.setName(ServiceName.of("[PROJECT]", "[LOCATION]", "[SERVICE]").toString())
.setRequestId("requestId693933066")
.build();
OperationFuture<Empty, OperationMetadata> future =
dataprocMetastoreClient.deleteServiceOperationCallable().futureCall(request);
// Do something.
future.get();
}
Type | Description |
OperationCallable<DeleteServiceRequest,Empty,OperationMetadata> |
exportMetadataAsync(ExportMetadataRequest request)
public final OperationFuture<MetadataExport,OperationMetadata> exportMetadataAsync(ExportMetadataRequest request)
Exports metadata from a service.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
ExportMetadataRequest request =
ExportMetadataRequest.newBuilder()
.setService(ServiceName.of("[PROJECT]", "[LOCATION]", "[SERVICE]").toString())
.setRequestId("requestId693933066")
.build();
MetadataExport response = dataprocMetastoreClient.exportMetadataAsync(request).get();
}
Name | Description |
request | ExportMetadataRequest The request object containing all of the parameters for the API call. |
Type | Description |
OperationFuture<MetadataExport,OperationMetadata> |
exportMetadataCallable()
public final UnaryCallable<ExportMetadataRequest,Operation> exportMetadataCallable()
Exports metadata from a service.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
ExportMetadataRequest request =
ExportMetadataRequest.newBuilder()
.setService(ServiceName.of("[PROJECT]", "[LOCATION]", "[SERVICE]").toString())
.setRequestId("requestId693933066")
.build();
ApiFuture<Operation> future =
dataprocMetastoreClient.exportMetadataCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
Type | Description |
UnaryCallable<ExportMetadataRequest,Operation> |
exportMetadataOperationCallable()
public final OperationCallable<ExportMetadataRequest,MetadataExport,OperationMetadata> exportMetadataOperationCallable()
Exports metadata from a service.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
ExportMetadataRequest request =
ExportMetadataRequest.newBuilder()
.setService(ServiceName.of("[PROJECT]", "[LOCATION]", "[SERVICE]").toString())
.setRequestId("requestId693933066")
.build();
OperationFuture<MetadataExport, OperationMetadata> future =
dataprocMetastoreClient.exportMetadataOperationCallable().futureCall(request);
// Do something.
MetadataExport response = future.get();
}
Type | Description |
OperationCallable<ExportMetadataRequest,MetadataExport,OperationMetadata> |
getBackup(BackupName name)
public final Backup getBackup(BackupName name)
Gets details of a single backup.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
BackupName name = BackupName.of("[PROJECT]", "[LOCATION]", "[SERVICE]", "[BACKUP]");
Backup response = dataprocMetastoreClient.getBackup(name);
}
Name | Description |
name | BackupName Required. The relative resource name of the backup to retrieve, in the following form:
|
Type | Description |
Backup |
getBackup(GetBackupRequest request)
public final Backup getBackup(GetBackupRequest request)
Gets details of a single backup.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
GetBackupRequest request =
GetBackupRequest.newBuilder()
.setName(BackupName.of("[PROJECT]", "[LOCATION]", "[SERVICE]", "[BACKUP]").toString())
.build();
Backup response = dataprocMetastoreClient.getBackup(request);
}
Name | Description |
request | GetBackupRequest The request object containing all of the parameters for the API call. |
Type | Description |
Backup |
getBackup(String name)
public final Backup getBackup(String name)
Gets details of a single backup.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
String name = BackupName.of("[PROJECT]", "[LOCATION]", "[SERVICE]", "[BACKUP]").toString();
Backup response = dataprocMetastoreClient.getBackup(name);
}
Name | Description |
name | String Required. The relative resource name of the backup to retrieve, in the following form:
|
Type | Description |
Backup |
getBackupCallable()
public final UnaryCallable<GetBackupRequest,Backup> getBackupCallable()
Gets details of a single backup.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
GetBackupRequest request =
GetBackupRequest.newBuilder()
.setName(BackupName.of("[PROJECT]", "[LOCATION]", "[SERVICE]", "[BACKUP]").toString())
.build();
ApiFuture<Backup> future = dataprocMetastoreClient.getBackupCallable().futureCall(request);
// Do something.
Backup response = future.get();
}
Type | Description |
UnaryCallable<GetBackupRequest,Backup> |
getHttpJsonOperationsClient()
public final OperationsClient getHttpJsonOperationsClient()
Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
Type | Description |
OperationsClient |
getMetadataImport(GetMetadataImportRequest request)
public final MetadataImport getMetadataImport(GetMetadataImportRequest request)
Gets details of a single import.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
GetMetadataImportRequest request =
GetMetadataImportRequest.newBuilder()
.setName(
MetadataImportName.of("[PROJECT]", "[LOCATION]", "[SERVICE]", "[METADATA_IMPORT]")
.toString())
.build();
MetadataImport response = dataprocMetastoreClient.getMetadataImport(request);
}
Name | Description |
request | GetMetadataImportRequest The request object containing all of the parameters for the API call. |
Type | Description |
MetadataImport |
getMetadataImport(MetadataImportName name)
public final MetadataImport getMetadataImport(MetadataImportName name)
Gets details of a single import.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
MetadataImportName name =
MetadataImportName.of("[PROJECT]", "[LOCATION]", "[SERVICE]", "[METADATA_IMPORT]");
MetadataImport response = dataprocMetastoreClient.getMetadataImport(name);
}
Name | Description |
name | MetadataImportName Required. The relative resource name of the metadata import to retrieve, in the following form:
|
Type | Description |
MetadataImport |
getMetadataImport(String name)
public final MetadataImport getMetadataImport(String name)
Gets details of a single import.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
String name =
MetadataImportName.of("[PROJECT]", "[LOCATION]", "[SERVICE]", "[METADATA_IMPORT]")
.toString();
MetadataImport response = dataprocMetastoreClient.getMetadataImport(name);
}
Name | Description |
name | String Required. The relative resource name of the metadata import to retrieve, in the following form:
|
Type | Description |
MetadataImport |
getMetadataImportCallable()
public final UnaryCallable<GetMetadataImportRequest,MetadataImport> getMetadataImportCallable()
Gets details of a single import.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
GetMetadataImportRequest request =
GetMetadataImportRequest.newBuilder()
.setName(
MetadataImportName.of("[PROJECT]", "[LOCATION]", "[SERVICE]", "[METADATA_IMPORT]")
.toString())
.build();
ApiFuture<MetadataImport> future =
dataprocMetastoreClient.getMetadataImportCallable().futureCall(request);
// Do something.
MetadataImport response = future.get();
}
Type | Description |
UnaryCallable<GetMetadataImportRequest,MetadataImport> |
getOperationsClient()
public final OperationsClient getOperationsClient()
Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
Type | Description |
OperationsClient |
getService(GetServiceRequest request)
public final Service getService(GetServiceRequest request)
Gets the details of a single service.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
GetServiceRequest request =
GetServiceRequest.newBuilder()
.setName(ServiceName.of("[PROJECT]", "[LOCATION]", "[SERVICE]").toString())
.build();
Service response = dataprocMetastoreClient.getService(request);
}
Name | Description |
request | GetServiceRequest The request object containing all of the parameters for the API call. |
Type | Description |
Service |
getService(ServiceName name)
public final Service getService(ServiceName name)
Gets the details of a single service.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
ServiceName name = ServiceName.of("[PROJECT]", "[LOCATION]", "[SERVICE]");
Service response = dataprocMetastoreClient.getService(name);
}
Name | Description |
name | ServiceName Required. The relative resource name of the metastore service to retrieve, in the following form:
|
Type | Description |
Service |
getService(String name)
public final Service getService(String name)
Gets the details of a single service.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
String name = ServiceName.of("[PROJECT]", "[LOCATION]", "[SERVICE]").toString();
Service response = dataprocMetastoreClient.getService(name);
}
Name | Description |
name | String Required. The relative resource name of the metastore service to retrieve, in the following form:
|
Type | Description |
Service |
getServiceCallable()
public final UnaryCallable<GetServiceRequest,Service> getServiceCallable()
Gets the details of a single service.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
GetServiceRequest request =
GetServiceRequest.newBuilder()
.setName(ServiceName.of("[PROJECT]", "[LOCATION]", "[SERVICE]").toString())
.build();
ApiFuture<Service> future = dataprocMetastoreClient.getServiceCallable().futureCall(request);
// Do something.
Service response = future.get();
}
Type | Description |
UnaryCallable<GetServiceRequest,Service> |
getSettings()
public final DataprocMetastoreSettings getSettings()
Type | Description |
DataprocMetastoreSettings |
getStub()
public DataprocMetastoreStub getStub()
Type | Description |
DataprocMetastoreStub |
isShutdown()
public boolean isShutdown()
Type | Description |
boolean |
isTerminated()
public boolean isTerminated()
Type | Description |
boolean |
listBackups(ListBackupsRequest request)
public final DataprocMetastoreClient.ListBackupsPagedResponse listBackups(ListBackupsRequest request)
Lists backups in a service.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
ListBackupsRequest request =
ListBackupsRequest.newBuilder()
.setParent(ServiceName.of("[PROJECT]", "[LOCATION]", "[SERVICE]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setFilter("filter-1274492040")
.setOrderBy("orderBy-1207110587")
.build();
for (Backup element : dataprocMetastoreClient.listBackups(request).iterateAll()) {
// doThingsWith(element);
}
}
Name | Description |
request | ListBackupsRequest The request object containing all of the parameters for the API call. |
Type | Description |
DataprocMetastoreClient.ListBackupsPagedResponse |
listBackups(ServiceName parent)
public final DataprocMetastoreClient.ListBackupsPagedResponse listBackups(ServiceName parent)
Lists backups in a service.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
ServiceName parent = ServiceName.of("[PROJECT]", "[LOCATION]", "[SERVICE]");
for (Backup element : dataprocMetastoreClient.listBackups(parent).iterateAll()) {
// doThingsWith(element);
}
}
Name | Description |
parent | ServiceName Required. The relative resource name of the service whose backups to list, in the following form:
|
Type | Description |
DataprocMetastoreClient.ListBackupsPagedResponse |
listBackups(String parent)
public final DataprocMetastoreClient.ListBackupsPagedResponse listBackups(String parent)
Lists backups in a service.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
String parent = ServiceName.of("[PROJECT]", "[LOCATION]", "[SERVICE]").toString();
for (Backup element : dataprocMetastoreClient.listBackups(parent).iterateAll()) {
// doThingsWith(element);
}
}
Name | Description |
parent | String Required. The relative resource name of the service whose backups to list, in the following form:
|
Type | Description |
DataprocMetastoreClient.ListBackupsPagedResponse |
listBackupsCallable()
public final UnaryCallable<ListBackupsRequest,ListBackupsResponse> listBackupsCallable()
Lists backups in a service.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
ListBackupsRequest request =
ListBackupsRequest.newBuilder()
.setParent(ServiceName.of("[PROJECT]", "[LOCATION]", "[SERVICE]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setFilter("filter-1274492040")
.setOrderBy("orderBy-1207110587")
.build();
while (true) {
ListBackupsResponse response = dataprocMetastoreClient.listBackupsCallable().call(request);
for (Backup element : response.getBackupsList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
Type | Description |
UnaryCallable<ListBackupsRequest,ListBackupsResponse> |
listBackupsPagedCallable()
public final UnaryCallable<ListBackupsRequest,DataprocMetastoreClient.ListBackupsPagedResponse> listBackupsPagedCallable()
Lists backups in a service.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
ListBackupsRequest request =
ListBackupsRequest.newBuilder()
.setParent(ServiceName.of("[PROJECT]", "[LOCATION]", "[SERVICE]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setFilter("filter-1274492040")
.setOrderBy("orderBy-1207110587")
.build();
ApiFuture<Backup> future =
dataprocMetastoreClient.listBackupsPagedCallable().futureCall(request);
// Do something.
for (Backup element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
Type | Description |
UnaryCallable<ListBackupsRequest,ListBackupsPagedResponse> |
listMetadataImports(ListMetadataImportsRequest request)
public final DataprocMetastoreClient.ListMetadataImportsPagedResponse listMetadataImports(ListMetadataImportsRequest request)
Lists imports in a service.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
ListMetadataImportsRequest request =
ListMetadataImportsRequest.newBuilder()
.setParent(ServiceName.of("[PROJECT]", "[LOCATION]", "[SERVICE]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setFilter("filter-1274492040")
.setOrderBy("orderBy-1207110587")
.build();
for (MetadataImport element :
dataprocMetastoreClient.listMetadataImports(request).iterateAll()) {
// doThingsWith(element);
}
}
Name | Description |
request | ListMetadataImportsRequest The request object containing all of the parameters for the API call. |
Type | Description |
DataprocMetastoreClient.ListMetadataImportsPagedResponse |
listMetadataImports(ServiceName parent)
public final DataprocMetastoreClient.ListMetadataImportsPagedResponse listMetadataImports(ServiceName parent)
Lists imports in a service.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
ServiceName parent = ServiceName.of("[PROJECT]", "[LOCATION]", "[SERVICE]");
for (MetadataImport element :
dataprocMetastoreClient.listMetadataImports(parent).iterateAll()) {
// doThingsWith(element);
}
}
Name | Description |
parent | ServiceName Required. The relative resource name of the service whose metadata imports to list, in the following form:
|
Type | Description |
DataprocMetastoreClient.ListMetadataImportsPagedResponse |
listMetadataImports(String parent)
public final DataprocMetastoreClient.ListMetadataImportsPagedResponse listMetadataImports(String parent)
Lists imports in a service.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
String parent = ServiceName.of("[PROJECT]", "[LOCATION]", "[SERVICE]").toString();
for (MetadataImport element :
dataprocMetastoreClient.listMetadataImports(parent).iterateAll()) {
// doThingsWith(element);
}
}
Name | Description |
parent | String Required. The relative resource name of the service whose metadata imports to list, in the following form:
|
Type | Description |
DataprocMetastoreClient.ListMetadataImportsPagedResponse |
listMetadataImportsCallable()
public final UnaryCallable<ListMetadataImportsRequest,ListMetadataImportsResponse> listMetadataImportsCallable()
Lists imports in a service.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
ListMetadataImportsRequest request =
ListMetadataImportsRequest.newBuilder()
.setParent(ServiceName.of("[PROJECT]", "[LOCATION]", "[SERVICE]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setFilter("filter-1274492040")
.setOrderBy("orderBy-1207110587")
.build();
while (true) {
ListMetadataImportsResponse response =
dataprocMetastoreClient.listMetadataImportsCallable().call(request);
for (MetadataImport element : response.getMetadataImportsList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
Type | Description |
UnaryCallable<ListMetadataImportsRequest,ListMetadataImportsResponse> |
listMetadataImportsPagedCallable()
public final UnaryCallable<ListMetadataImportsRequest,DataprocMetastoreClient.ListMetadataImportsPagedResponse> listMetadataImportsPagedCallable()
Lists imports in a service.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
ListMetadataImportsRequest request =
ListMetadataImportsRequest.newBuilder()
.setParent(ServiceName.of("[PROJECT]", "[LOCATION]", "[SERVICE]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setFilter("filter-1274492040")
.setOrderBy("orderBy-1207110587")
.build();
ApiFuture<MetadataImport> future =
dataprocMetastoreClient.listMetadataImportsPagedCallable().futureCall(request);
// Do something.
for (MetadataImport element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
Type | Description |
UnaryCallable<ListMetadataImportsRequest,ListMetadataImportsPagedResponse> |
listServices(ListServicesRequest request)
public final DataprocMetastoreClient.ListServicesPagedResponse listServices(ListServicesRequest request)
Lists services in a project and location.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
ListServicesRequest request =
ListServicesRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setFilter("filter-1274492040")
.setOrderBy("orderBy-1207110587")
.build();
for (Service element : dataprocMetastoreClient.listServices(request).iterateAll()) {
// doThingsWith(element);
}
}
Name | Description |
request | ListServicesRequest The request object containing all of the parameters for the API call. |
Type | Description |
DataprocMetastoreClient.ListServicesPagedResponse |
listServices(LocationName parent)
public final DataprocMetastoreClient.ListServicesPagedResponse listServices(LocationName parent)
Lists services in a project and location.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
for (Service element : dataprocMetastoreClient.listServices(parent).iterateAll()) {
// doThingsWith(element);
}
}
Name | Description |
parent | LocationName Required. The relative resource name of the location of metastore services to list, in the following form:
|
Type | Description |
DataprocMetastoreClient.ListServicesPagedResponse |
listServices(String parent)
public final DataprocMetastoreClient.ListServicesPagedResponse listServices(String parent)
Lists services in a project and location.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
for (Service element : dataprocMetastoreClient.listServices(parent).iterateAll()) {
// doThingsWith(element);
}
}
Name | Description |
parent | String Required. The relative resource name of the location of metastore services to list, in the following form:
|
Type | Description |
DataprocMetastoreClient.ListServicesPagedResponse |
listServicesCallable()
public final UnaryCallable<ListServicesRequest,ListServicesResponse> listServicesCallable()
Lists services in a project and location.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
ListServicesRequest request =
ListServicesRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setFilter("filter-1274492040")
.setOrderBy("orderBy-1207110587")
.build();
while (true) {
ListServicesResponse response =
dataprocMetastoreClient.listServicesCallable().call(request);
for (Service element : response.getServicesList()) {
// doThingsWith(element);
}
String nextPageToken = response.getNextPageToken();
if (!Strings.isNullOrEmpty(nextPageToken)) {
request = request.toBuilder().setPageToken(nextPageToken).build();
} else {
break;
}
}
}
Type | Description |
UnaryCallable<ListServicesRequest,ListServicesResponse> |
listServicesPagedCallable()
public final UnaryCallable<ListServicesRequest,DataprocMetastoreClient.ListServicesPagedResponse> listServicesPagedCallable()
Lists services in a project and location.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
ListServicesRequest request =
ListServicesRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setFilter("filter-1274492040")
.setOrderBy("orderBy-1207110587")
.build();
ApiFuture<Service> future =
dataprocMetastoreClient.listServicesPagedCallable().futureCall(request);
// Do something.
for (Service element : future.get().iterateAll()) {
// doThingsWith(element);
}
}
Type | Description |
UnaryCallable<ListServicesRequest,ListServicesPagedResponse> |
restoreServiceAsync(RestoreServiceRequest request)
public final OperationFuture<Restore,OperationMetadata> restoreServiceAsync(RestoreServiceRequest request)
Restores a service from a backup.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
RestoreServiceRequest request =
RestoreServiceRequest.newBuilder()
.setService(ServiceName.of("[PROJECT]", "[LOCATION]", "[SERVICE]").toString())
.setBackup(
BackupName.of("[PROJECT]", "[LOCATION]", "[SERVICE]", "[BACKUP]").toString())
.setRequestId("requestId693933066")
.build();
Restore response = dataprocMetastoreClient.restoreServiceAsync(request).get();
}
Name | Description |
request | RestoreServiceRequest The request object containing all of the parameters for the API call. |
Type | Description |
OperationFuture<Restore,OperationMetadata> |
restoreServiceAsync(ServiceName service, BackupName backup)
public final OperationFuture<Restore,OperationMetadata> restoreServiceAsync(ServiceName service, BackupName backup)
Restores a service from a backup.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
ServiceName service = ServiceName.of("[PROJECT]", "[LOCATION]", "[SERVICE]");
BackupName backup = BackupName.of("[PROJECT]", "[LOCATION]", "[SERVICE]", "[BACKUP]");
Restore response = dataprocMetastoreClient.restoreServiceAsync(service, backup).get();
}
Name | Description |
service | ServiceName Required. The relative resource name of the metastore service to run restore, in the following form:
|
backup | BackupName Required. The relative resource name of the metastore service backup to restore from, in the following form:
|
Type | Description |
OperationFuture<Restore,OperationMetadata> |
restoreServiceAsync(ServiceName service, String backup)
public final OperationFuture<Restore,OperationMetadata> restoreServiceAsync(ServiceName service, String backup)
Restores a service from a backup.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
ServiceName service = ServiceName.of("[PROJECT]", "[LOCATION]", "[SERVICE]");
String backup = BackupName.of("[PROJECT]", "[LOCATION]", "[SERVICE]", "[BACKUP]").toString();
Restore response = dataprocMetastoreClient.restoreServiceAsync(service, backup).get();
}
Name | Description |
service | ServiceName Required. The relative resource name of the metastore service to run restore, in the following form:
|
backup | String Required. The relative resource name of the metastore service backup to restore from, in the following form:
|
Type | Description |
OperationFuture<Restore,OperationMetadata> |
restoreServiceAsync(String service, BackupName backup)
public final OperationFuture<Restore,OperationMetadata> restoreServiceAsync(String service, BackupName backup)
Restores a service from a backup.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
String service = ServiceName.of("[PROJECT]", "[LOCATION]", "[SERVICE]").toString();
BackupName backup = BackupName.of("[PROJECT]", "[LOCATION]", "[SERVICE]", "[BACKUP]");
Restore response = dataprocMetastoreClient.restoreServiceAsync(service, backup).get();
}
Name | Description |
service | String Required. The relative resource name of the metastore service to run restore, in the following form:
|
backup | BackupName Required. The relative resource name of the metastore service backup to restore from, in the following form:
|
Type | Description |
OperationFuture<Restore,OperationMetadata> |
restoreServiceAsync(String service, String backup)
public final OperationFuture<Restore,OperationMetadata> restoreServiceAsync(String service, String backup)
Restores a service from a backup.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
String service = ServiceName.of("[PROJECT]", "[LOCATION]", "[SERVICE]").toString();
String backup = BackupName.of("[PROJECT]", "[LOCATION]", "[SERVICE]", "[BACKUP]").toString();
Restore response = dataprocMetastoreClient.restoreServiceAsync(service, backup).get();
}
Name | Description |
service | String Required. The relative resource name of the metastore service to run restore, in the following form:
|
backup | String Required. The relative resource name of the metastore service backup to restore from, in the following form:
|
Type | Description |
OperationFuture<Restore,OperationMetadata> |
restoreServiceCallable()
public final UnaryCallable<RestoreServiceRequest,Operation> restoreServiceCallable()
Restores a service from a backup.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
RestoreServiceRequest request =
RestoreServiceRequest.newBuilder()
.setService(ServiceName.of("[PROJECT]", "[LOCATION]", "[SERVICE]").toString())
.setBackup(
BackupName.of("[PROJECT]", "[LOCATION]", "[SERVICE]", "[BACKUP]").toString())
.setRequestId("requestId693933066")
.build();
ApiFuture<Operation> future =
dataprocMetastoreClient.restoreServiceCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
Type | Description |
UnaryCallable<RestoreServiceRequest,Operation> |
restoreServiceOperationCallable()
public final OperationCallable<RestoreServiceRequest,Restore,OperationMetadata> restoreServiceOperationCallable()
Restores a service from a backup.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
RestoreServiceRequest request =
RestoreServiceRequest.newBuilder()
.setService(ServiceName.of("[PROJECT]", "[LOCATION]", "[SERVICE]").toString())
.setBackup(
BackupName.of("[PROJECT]", "[LOCATION]", "[SERVICE]", "[BACKUP]").toString())
.setRequestId("requestId693933066")
.build();
OperationFuture<Restore, OperationMetadata> future =
dataprocMetastoreClient.restoreServiceOperationCallable().futureCall(request);
// Do something.
Restore response = future.get();
}
Type | Description |
OperationCallable<RestoreServiceRequest,Restore,OperationMetadata> |
shutdown()
public void shutdown()
shutdownNow()
public void shutdownNow()
updateMetadataImportAsync(MetadataImport metadataImport, FieldMask updateMask)
public final OperationFuture<MetadataImport,OperationMetadata> updateMetadataImportAsync(MetadataImport metadataImport, FieldMask updateMask)
Updates a single import. Only the description field of MetadataImport is supported to be updated.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
MetadataImport metadataImport = MetadataImport.newBuilder().build();
FieldMask updateMask = FieldMask.newBuilder().build();
MetadataImport response =
dataprocMetastoreClient.updateMetadataImportAsync(metadataImport, updateMask).get();
}
Name | Description |
metadataImport | MetadataImport Required. The metadata import to update. The server only merges fields in
the import if they are specified in The metadata import's |
updateMask | FieldMask Required. A field mask used to specify the fields to be overwritten in the
metadata import resource by the update. Fields specified in the |
Type | Description |
OperationFuture<MetadataImport,OperationMetadata> |
updateMetadataImportAsync(UpdateMetadataImportRequest request)
public final OperationFuture<MetadataImport,OperationMetadata> updateMetadataImportAsync(UpdateMetadataImportRequest request)
Updates a single import. Only the description field of MetadataImport is supported to be updated.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
UpdateMetadataImportRequest request =
UpdateMetadataImportRequest.newBuilder()
.setUpdateMask(FieldMask.newBuilder().build())
.setMetadataImport(MetadataImport.newBuilder().build())
.setRequestId("requestId693933066")
.build();
MetadataImport response = dataprocMetastoreClient.updateMetadataImportAsync(request).get();
}
Name | Description |
request | UpdateMetadataImportRequest The request object containing all of the parameters for the API call. |
Type | Description |
OperationFuture<MetadataImport,OperationMetadata> |
updateMetadataImportCallable()
public final UnaryCallable<UpdateMetadataImportRequest,Operation> updateMetadataImportCallable()
Updates a single import. Only the description field of MetadataImport is supported to be updated.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
UpdateMetadataImportRequest request =
UpdateMetadataImportRequest.newBuilder()
.setUpdateMask(FieldMask.newBuilder().build())
.setMetadataImport(MetadataImport.newBuilder().build())
.setRequestId("requestId693933066")
.build();
ApiFuture<Operation> future =
dataprocMetastoreClient.updateMetadataImportCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
Type | Description |
UnaryCallable<UpdateMetadataImportRequest,Operation> |
updateMetadataImportOperationCallable()
public final OperationCallable<UpdateMetadataImportRequest,MetadataImport,OperationMetadata> updateMetadataImportOperationCallable()
Updates a single import. Only the description field of MetadataImport is supported to be updated.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
UpdateMetadataImportRequest request =
UpdateMetadataImportRequest.newBuilder()
.setUpdateMask(FieldMask.newBuilder().build())
.setMetadataImport(MetadataImport.newBuilder().build())
.setRequestId("requestId693933066")
.build();
OperationFuture<MetadataImport, OperationMetadata> future =
dataprocMetastoreClient.updateMetadataImportOperationCallable().futureCall(request);
// Do something.
MetadataImport response = future.get();
}
Type | Description |
OperationCallable<UpdateMetadataImportRequest,MetadataImport,OperationMetadata> |
updateServiceAsync(Service service, FieldMask updateMask)
public final OperationFuture<Service,OperationMetadata> updateServiceAsync(Service service, FieldMask updateMask)
Updates the parameters of a single service.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
Service service = Service.newBuilder().build();
FieldMask updateMask = FieldMask.newBuilder().build();
Service response = dataprocMetastoreClient.updateServiceAsync(service, updateMask).get();
}
Name | Description |
service | Service Required. The metastore service to update. The server only merges fields in the
service if they are specified in The metastore service's |
updateMask | FieldMask Required. A field mask used to specify the fields to be overwritten in the
metastore service resource by the update. Fields specified in the |
Type | Description |
OperationFuture<Service,OperationMetadata> |
updateServiceAsync(UpdateServiceRequest request)
public final OperationFuture<Service,OperationMetadata> updateServiceAsync(UpdateServiceRequest request)
Updates the parameters of a single service.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
UpdateServiceRequest request =
UpdateServiceRequest.newBuilder()
.setUpdateMask(FieldMask.newBuilder().build())
.setService(Service.newBuilder().build())
.setRequestId("requestId693933066")
.build();
Service response = dataprocMetastoreClient.updateServiceAsync(request).get();
}
Name | Description |
request | UpdateServiceRequest The request object containing all of the parameters for the API call. |
Type | Description |
OperationFuture<Service,OperationMetadata> |
updateServiceCallable()
public final UnaryCallable<UpdateServiceRequest,Operation> updateServiceCallable()
Updates the parameters of a single service.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
UpdateServiceRequest request =
UpdateServiceRequest.newBuilder()
.setUpdateMask(FieldMask.newBuilder().build())
.setService(Service.newBuilder().build())
.setRequestId("requestId693933066")
.build();
ApiFuture<Operation> future =
dataprocMetastoreClient.updateServiceCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
Type | Description |
UnaryCallable<UpdateServiceRequest,Operation> |
updateServiceOperationCallable()
public final OperationCallable<UpdateServiceRequest,Service,OperationMetadata> updateServiceOperationCallable()
Updates the parameters of a single service.
Sample code:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
UpdateServiceRequest request =
UpdateServiceRequest.newBuilder()
.setUpdateMask(FieldMask.newBuilder().build())
.setService(Service.newBuilder().build())
.setRequestId("requestId693933066")
.build();
OperationFuture<Service, OperationMetadata> future =
dataprocMetastoreClient.updateServiceOperationCallable().futureCall(request);
// Do something.
Service response = future.get();
}
Type | Description |
OperationCallable<UpdateServiceRequest,Service,OperationMetadata> |