Class DataprocMetastoreClient (2.32.0)

Service Description: Configures and manages metastore services. Metastore services are fully managed, highly available, autoscaled, autohealing, OSS-native deployments of technical metadata management software. Each metastore service exposes a network endpoint through which metadata queries are served. Metadata queries can originate from a variety of sources, including Apache Hive, Apache Presto, and Apache Spark.

The Dataproc Metastore API defines the following resource model:

The service works with a collection of Google Cloud projects, named: /projects/*
Each project has a collection of available locations, named: /locations/* (a location must refer to a Google Cloud region)
Each location has a collection of services, named: /services/*
Dataproc Metastore services are resources with names of the form:

/projects/{project_number}/locations/{location_id}/services/{service_id}.

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


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
   ServiceName name = ServiceName.of("[PROJECT]", "[LOCATION]", "[SERVICE]");
   Service response = dataprocMetastoreClient.getService(name);
 }

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

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

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

See the individual methods for example code.

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

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

To customize credentials:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 DataprocMetastoreSettings dataprocMetastoreSettings =
     DataprocMetastoreSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 DataprocMetastoreClient dataprocMetastoreClient =
     DataprocMetastoreClient.create(dataprocMetastoreSettings);

To customize the endpoint:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 DataprocMetastoreSettings dataprocMetastoreSettings =
     DataprocMetastoreSettings.newBuilder().setEndpoint(myEndpoint).build();
 DataprocMetastoreClient dataprocMetastoreClient =
     DataprocMetastoreClient.create(dataprocMetastoreSettings);

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


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 DataprocMetastoreSettings dataprocMetastoreSettings =
     DataprocMetastoreSettings.newHttpJsonBuilder().build();
 DataprocMetastoreClient dataprocMetastoreClient =
     DataprocMetastoreClient.create(dataprocMetastoreSettings);

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

Inheritance

java.lang.Object > DataprocMetastoreClient

Static Methods

create()

public static final DataprocMetastoreClient create()

Constructs an instance of DataprocMetastoreClient with default settings.

Returns
Type	Description
`DataprocMetastoreClient`

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

Parameter
Name	Description
`settings`	`DataprocMetastoreSettings`

Returns
Type	Description
`DataprocMetastoreClient`

Exceptions
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).

Parameter
Name	Description
`stub`	`DataprocMetastoreStub`

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

Parameter
Name	Description
`settings`	`DataprocMetastoreSettings`

DataprocMetastoreClient(DataprocMetastoreStub stub)

protected DataprocMetastoreClient(DataprocMetastoreStub stub)

Parameter
Name	Description
`stub`	`DataprocMetastoreStub`

Methods

alterMetadataResourceLocationAsync(AlterMetadataResourceLocationRequest request)

public final OperationFuture<AlterMetadataResourceLocationResponse,OperationMetadata> alterMetadataResourceLocationAsync(AlterMetadataResourceLocationRequest request)

Alter metadata resource location. The metadata resource can be a database, table, or partition. This functionality only updates the parent directory for the respective metadata resource and does not transfer any existing data to the new location.

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 (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
   AlterMetadataResourceLocationRequest request =
       AlterMetadataResourceLocationRequest.newBuilder()
           .setService(ServiceName.of("[PROJECT]", "[LOCATION]", "[SERVICE]").toString())
           .setResourceName("resourceName-384566343")
           .setLocationUri("locationUri552310135")
           .build();
   AlterMetadataResourceLocationResponse response =
       dataprocMetastoreClient.alterMetadataResourceLocationAsync(request).get();
 }

Parameter
Name	Description
`request`	`AlterMetadataResourceLocationRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`OperationFuture<AlterMetadataResourceLocationResponse,OperationMetadata>`

alterMetadataResourceLocationCallable()

public final UnaryCallable<AlterMetadataResourceLocationRequest,Operation> alterMetadataResourceLocationCallable()

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 (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
   AlterMetadataResourceLocationRequest request =
       AlterMetadataResourceLocationRequest.newBuilder()
           .setService(ServiceName.of("[PROJECT]", "[LOCATION]", "[SERVICE]").toString())
           .setResourceName("resourceName-384566343")
           .setLocationUri("locationUri552310135")
           .build();
   ApiFuture<Operation> future =
       dataprocMetastoreClient.alterMetadataResourceLocationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

Returns
Type	Description
`UnaryCallable<AlterMetadataResourceLocationRequest,Operation>`

alterMetadataResourceLocationOperationCallable()

public final OperationCallable<AlterMetadataResourceLocationRequest,AlterMetadataResourceLocationResponse,OperationMetadata> alterMetadataResourceLocationOperationCallable()

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 (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
   AlterMetadataResourceLocationRequest request =
       AlterMetadataResourceLocationRequest.newBuilder()
           .setService(ServiceName.of("[PROJECT]", "[LOCATION]", "[SERVICE]").toString())
           .setResourceName("resourceName-384566343")
           .setLocationUri("locationUri552310135")
           .build();
   OperationFuture<AlterMetadataResourceLocationResponse, OperationMetadata> future =
       dataprocMetastoreClient
           .alterMetadataResourceLocationOperationCallable()
           .futureCall(request);
   // Do something.
   AlterMetadataResourceLocationResponse response = future.get();
 }

Returns
Type	Description
`OperationCallable<AlterMetadataResourceLocationRequest,AlterMetadataResourceLocationResponse,OperationMetadata>`

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`

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 and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
   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();
 }

Parameter
Name	Description
`request`	`CreateBackupRequest` The request object containing all of the parameters for the API call.

Returns
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 and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
   ServiceName parent = ServiceName.of("[PROJECT]", "[LOCATION]", "[SERVICE]");
   Backup backup = Backup.newBuilder().build();
   String backupId = "backupId2121930365";
   Backup response = dataprocMetastoreClient.createBackupAsync(parent, backup, backupId).get();
 }

Parameters
Name	Description
`parent`	`ServiceName` Required. The relative resource name of the service in which to create a backup of the following form: `projects/{project_number}/locations/{location_id}/services/{service_id}`.
`backup`	`Backup` Required. The backup to create. The `name` field is ignored. The ID of the created backup must be provided in the request's `backup_id` field.
`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.

Returns
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 and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
   String parent = ServiceName.of("[PROJECT]", "[LOCATION]", "[SERVICE]").toString();
   Backup backup = Backup.newBuilder().build();
   String backupId = "backupId2121930365";
   Backup response = dataprocMetastoreClient.createBackupAsync(parent, backup, backupId).get();
 }

Parameters
Name	Description
`parent`	`String` Required. The relative resource name of the service in which to create a backup of the following form: `projects/{project_number}/locations/{location_id}/services/{service_id}`.
`backup`	`Backup` Required. The backup to create. The `name` field is ignored. The ID of the created backup must be provided in the request's `backup_id` field.
`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.

Returns
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 and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
   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();
 }

Returns
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 and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
   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();
 }

Returns
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 and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
   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();
 }

Parameter
Name	Description
`request`	`CreateMetadataImportRequest` The request object containing all of the parameters for the API call.

Returns
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 and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
   ServiceName parent = ServiceName.of("[PROJECT]", "[LOCATION]", "[SERVICE]");
   MetadataImport metadataImport = MetadataImport.newBuilder().build();
   String metadataImportId = "metadataImportId1824548847";
   MetadataImport response =
       dataprocMetastoreClient
           .createMetadataImportAsync(parent, metadataImport, metadataImportId)
           .get();
 }

Parameters
Name	Description
`parent`	`ServiceName` Required. The relative resource name of the service in which to create a metastore import, in the following form: `projects/{project_number}/locations/{location_id}/services/{service_id}`.
`metadataImport`	`MetadataImport` Required. The metadata import to create. The `name` field is ignored. The ID of the created metadata import must be provided in the request's `metadata_import_id` field.
`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.

Returns
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 and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
   String parent = ServiceName.of("[PROJECT]", "[LOCATION]", "[SERVICE]").toString();
   MetadataImport metadataImport = MetadataImport.newBuilder().build();
   String metadataImportId = "metadataImportId1824548847";
   MetadataImport response =
       dataprocMetastoreClient
           .createMetadataImportAsync(parent, metadataImport, metadataImportId)
           .get();
 }

Parameters
Name	Description
`parent`	`String` Required. The relative resource name of the service in which to create a metastore import, in the following form: `projects/{project_number}/locations/{location_id}/services/{service_id}`.
`metadataImport`	`MetadataImport` Required. The metadata import to create. The `name` field is ignored. The ID of the created metadata import must be provided in the request's `metadata_import_id` field.
`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.

Returns
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 and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
   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();
 }

Returns
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 and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
   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();
 }

Returns
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 and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
   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();
 }

Parameter
Name	Description
`request`	`CreateServiceRequest` The request object containing all of the parameters for the API call.

Returns
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 and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   Service service = Service.newBuilder().build();
   String serviceId = "serviceId-194185552";
   Service response =
       dataprocMetastoreClient.createServiceAsync(parent, service, serviceId).get();
 }

Parameters
Name	Description
`parent`	`LocationName` Required. The relative resource name of the location in which to create a metastore service, in the following form: `projects/{project_number}/locations/{location_id}`.
`service`	`Service` Required. The Metastore service to create. The `name` field is ignored. The ID of the created metastore service must be provided in the request's `service_id` field.
`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.

Returns
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 and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   Service service = Service.newBuilder().build();
   String serviceId = "serviceId-194185552";
   Service response =
       dataprocMetastoreClient.createServiceAsync(parent, service, serviceId).get();
 }

Parameters
Name	Description
`parent`	`String` Required. The relative resource name of the location in which to create a metastore service, in the following form: `projects/{project_number}/locations/{location_id}`.
`service`	`Service` Required. The Metastore service to create. The `name` field is ignored. The ID of the created metastore service must be provided in the request's `service_id` field.
`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.

Returns
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 and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
   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();
 }

Returns
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 and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
   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();
 }

Returns
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 and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
   BackupName name = BackupName.of("[PROJECT]", "[LOCATION]", "[SERVICE]", "[BACKUP]");
   dataprocMetastoreClient.deleteBackupAsync(name).get();
 }

Parameter

Name Description

name

BackupName

Required. The relative resource name of the backup to delete, in the following form:

projects/{project_number}/locations/{location_id}/services/{service_id}/backups/{backup_id}.

Returns
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 and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
   DeleteBackupRequest request =
       DeleteBackupRequest.newBuilder()
           .setName(BackupName.of("[PROJECT]", "[LOCATION]", "[SERVICE]", "[BACKUP]").toString())
           .setRequestId("requestId693933066")
           .build();
   dataprocMetastoreClient.deleteBackupAsync(request).get();
 }

Parameter
Name	Description
`request`	`DeleteBackupRequest` The request object containing all of the parameters for the API call.

Returns
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 and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
   String name = BackupName.of("[PROJECT]", "[LOCATION]", "[SERVICE]", "[BACKUP]").toString();
   dataprocMetastoreClient.deleteBackupAsync(name).get();
 }

Parameter

Name Description

name

String

Required. The relative resource name of the backup to delete, in the following form:

projects/{project_number}/locations/{location_id}/services/{service_id}/backups/{backup_id}.

Returns
Type	Description
`OperationFuture<Empty,OperationMetadata>`

deleteBackupCallable()

public final UnaryCallable<DeleteBackupRequest,Operation> deleteBackupCallable()

Deletes a single backup.

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

Returns
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 and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
   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();
 }

Returns
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 and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
   DeleteServiceRequest request =
       DeleteServiceRequest.newBuilder()
           .setName(ServiceName.of("[PROJECT]", "[LOCATION]", "[SERVICE]").toString())
           .setRequestId("requestId693933066")
           .build();
   dataprocMetastoreClient.deleteServiceAsync(request).get();
 }

Parameter
Name	Description
`request`	`DeleteServiceRequest` The request object containing all of the parameters for the API call.

Returns
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 and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
   ServiceName name = ServiceName.of("[PROJECT]", "[LOCATION]", "[SERVICE]");
   dataprocMetastoreClient.deleteServiceAsync(name).get();
 }

Parameter

Name Description

name

ServiceName

Required. The relative resource name of the metastore service to delete, in the following form:

projects/{project_number}/locations/{location_id}/services/{service_id}.

Returns
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 and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
   String name = ServiceName.of("[PROJECT]", "[LOCATION]", "[SERVICE]").toString();
   dataprocMetastoreClient.deleteServiceAsync(name).get();
 }

Parameter

Name Description

name

String

Required. The relative resource name of the metastore service to delete, in the following form:

projects/{project_number}/locations/{location_id}/services/{service_id}.

Returns
Type	Description
`OperationFuture<Empty,OperationMetadata>`

deleteServiceCallable()

public final UnaryCallable<DeleteServiceRequest,Operation> deleteServiceCallable()

Deletes a single service.

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

Returns
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 and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
   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();
 }

Returns
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 and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
   ExportMetadataRequest request =
       ExportMetadataRequest.newBuilder()
           .setService(ServiceName.of("[PROJECT]", "[LOCATION]", "[SERVICE]").toString())
           .setRequestId("requestId693933066")
           .build();
   MetadataExport response = dataprocMetastoreClient.exportMetadataAsync(request).get();
 }

Parameter
Name	Description
`request`	`ExportMetadataRequest` The request object containing all of the parameters for the API call.

Returns
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 and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
   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();
 }

Returns
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 and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
   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();
 }

Returns
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 and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
   BackupName name = BackupName.of("[PROJECT]", "[LOCATION]", "[SERVICE]", "[BACKUP]");
   Backup response = dataprocMetastoreClient.getBackup(name);
 }

Parameter

Name Description

name

BackupName

Required. The relative resource name of the backup to retrieve, in the following form:

projects/{project_number}/locations/{location_id}/services/{service_id}/backups/{backup_id}.

Returns
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 and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
   GetBackupRequest request =
       GetBackupRequest.newBuilder()
           .setName(BackupName.of("[PROJECT]", "[LOCATION]", "[SERVICE]", "[BACKUP]").toString())
           .build();
   Backup response = dataprocMetastoreClient.getBackup(request);
 }

Parameter
Name	Description
`request`	`GetBackupRequest` The request object containing all of the parameters for the API call.

Returns
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 and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
   String name = BackupName.of("[PROJECT]", "[LOCATION]", "[SERVICE]", "[BACKUP]").toString();
   Backup response = dataprocMetastoreClient.getBackup(name);
 }

Parameter

Name Description

name

String

Required. The relative resource name of the backup to retrieve, in the following form:

projects/{project_number}/locations/{location_id}/services/{service_id}/backups/{backup_id}.

Returns
Type	Description
`Backup`

getBackupCallable()

public final UnaryCallable<GetBackupRequest,Backup> getBackupCallable()

Gets details of a single backup.

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

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

Returns
Type	Description
`OperationsClient`

getIamPolicy(GetIamPolicyRequest request)

public final Policy getIamPolicy(GetIamPolicyRequest request)

Gets the access control policy for a resource. Returns an empty policyif the resource exists and does not have a policy set.

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 (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
   GetIamPolicyRequest request =
       GetIamPolicyRequest.newBuilder()
           .setResource(
               BackupName.of("[PROJECT]", "[LOCATION]", "[SERVICE]", "[BACKUP]").toString())
           .setOptions(GetPolicyOptions.newBuilder().build())
           .build();
   Policy response = dataprocMetastoreClient.getIamPolicy(request);
 }

Parameter
Name	Description
`request`	`com.google.iam.v1.GetIamPolicyRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`com.google.iam.v1.Policy`

getIamPolicyCallable()

public final UnaryCallable<GetIamPolicyRequest,Policy> getIamPolicyCallable()

Gets the access control policy for a resource. Returns an empty policyif the resource exists and does not have a policy set.

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 (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
   GetIamPolicyRequest request =
       GetIamPolicyRequest.newBuilder()
           .setResource(
               BackupName.of("[PROJECT]", "[LOCATION]", "[SERVICE]", "[BACKUP]").toString())
           .setOptions(GetPolicyOptions.newBuilder().build())
           .build();
   ApiFuture<Policy> future = dataprocMetastoreClient.getIamPolicyCallable().futureCall(request);
   // Do something.
   Policy response = future.get();
 }

Returns
Type	Description
`UnaryCallable<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy>`

getLocation(GetLocationRequest request)

public final Location getLocation(GetLocationRequest request)

Gets information about a location.

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 (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
   GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
   Location response = dataprocMetastoreClient.getLocation(request);
 }

Parameter
Name	Description
`request`	`com.google.cloud.location.GetLocationRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`com.google.cloud.location.Location`

getLocationCallable()

public final UnaryCallable<GetLocationRequest,Location> getLocationCallable()

Gets information about a location.

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 (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
   GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
   ApiFuture<Location> future =
       dataprocMetastoreClient.getLocationCallable().futureCall(request);
   // Do something.
   Location response = future.get();
 }

Returns
Type	Description
`UnaryCallable<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location>`

getMetadataImport(GetMetadataImportRequest request)

public final MetadataImport getMetadataImport(GetMetadataImportRequest request)

Gets details of a single import.

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 (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
   GetMetadataImportRequest request =
       GetMetadataImportRequest.newBuilder()
           .setName(
               MetadataImportName.of("[PROJECT]", "[LOCATION]", "[SERVICE]", "[METADATA_IMPORT]")
                   .toString())
           .build();
   MetadataImport response = dataprocMetastoreClient.getMetadataImport(request);
 }

Parameter
Name	Description
`request`	`GetMetadataImportRequest` The request object containing all of the parameters for the API call.

Returns
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 and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
   MetadataImportName name =
       MetadataImportName.of("[PROJECT]", "[LOCATION]", "[SERVICE]", "[METADATA_IMPORT]");
   MetadataImport response = dataprocMetastoreClient.getMetadataImport(name);
 }

Parameter

Name Description

name

MetadataImportName

Required. The relative resource name of the metadata import to retrieve, in the following form:

projects/{project_number}/locations/{location_id}/services/{service_id}/metadataImports/{import_id}.

Returns
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 and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
   String name =
       MetadataImportName.of("[PROJECT]", "[LOCATION]", "[SERVICE]", "[METADATA_IMPORT]")
           .toString();
   MetadataImport response = dataprocMetastoreClient.getMetadataImport(name);
 }

Parameter

Name Description

name

String

Required. The relative resource name of the metadata import to retrieve, in the following form:

projects/{project_number}/locations/{location_id}/services/{service_id}/metadataImports/{import_id}.

Returns
Type	Description
`MetadataImport`

getMetadataImportCallable()

public final UnaryCallable<GetMetadataImportRequest,MetadataImport> getMetadataImportCallable()

Gets details of a single import.

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

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

Returns
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 and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
   GetServiceRequest request =
       GetServiceRequest.newBuilder()
           .setName(ServiceName.of("[PROJECT]", "[LOCATION]", "[SERVICE]").toString())
           .build();
   Service response = dataprocMetastoreClient.getService(request);
 }

Parameter
Name	Description
`request`	`GetServiceRequest` The request object containing all of the parameters for the API call.

Returns
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 and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
   ServiceName name = ServiceName.of("[PROJECT]", "[LOCATION]", "[SERVICE]");
   Service response = dataprocMetastoreClient.getService(name);
 }

Parameter

Name Description

name

ServiceName

Required. The relative resource name of the metastore service to retrieve, in the following form:

projects/{project_number}/locations/{location_id}/services/{service_id}.

Returns
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 and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
   String name = ServiceName.of("[PROJECT]", "[LOCATION]", "[SERVICE]").toString();
   Service response = dataprocMetastoreClient.getService(name);
 }

Parameter

Name Description

name

String

Required. The relative resource name of the metastore service to retrieve, in the following form:

projects/{project_number}/locations/{location_id}/services/{service_id}.

Returns
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 and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
   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();
 }

Returns
Type	Description
`UnaryCallable<GetServiceRequest,Service>`

getSettings()

public final DataprocMetastoreSettings getSettings()

Returns
Type	Description
`DataprocMetastoreSettings`

getStub()

public DataprocMetastoreStub getStub()

Returns
Type	Description
`DataprocMetastoreStub`

isShutdown()

public boolean isShutdown()

Returns
Type	Description
`boolean`

isTerminated()

public boolean isTerminated()

Returns
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 and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
   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);
   }
 }

Parameter
Name	Description
`request`	`ListBackupsRequest` The request object containing all of the parameters for the API call.

Returns
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 and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
   ServiceName parent = ServiceName.of("[PROJECT]", "[LOCATION]", "[SERVICE]");
   for (Backup element : dataprocMetastoreClient.listBackups(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter

Name Description

parent

ServiceName

Required. The relative resource name of the service whose backups to list, in the following form:

projects/{project_number}/locations/{location_id}/services/{service_id}/backups.

Returns
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 and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
   String parent = ServiceName.of("[PROJECT]", "[LOCATION]", "[SERVICE]").toString();
   for (Backup element : dataprocMetastoreClient.listBackups(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter

Name Description

parent

String

Required. The relative resource name of the service whose backups to list, in the following form:

projects/{project_number}/locations/{location_id}/services/{service_id}/backups.

Returns
Type	Description
`DataprocMetastoreClient.ListBackupsPagedResponse`

listBackupsCallable()

public final UnaryCallable<ListBackupsRequest,ListBackupsResponse> listBackupsCallable()

Lists backups in a service.

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

Returns
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 and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
   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);
   }
 }

Returns
Type	Description
`UnaryCallable<ListBackupsRequest,ListBackupsPagedResponse>`

listLocations(ListLocationsRequest request)

public final DataprocMetastoreClient.ListLocationsPagedResponse listLocations(ListLocationsRequest request)

Lists information about the supported locations for this service.

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 (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (Location element : dataprocMetastoreClient.listLocations(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`request`	`com.google.cloud.location.ListLocationsRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`DataprocMetastoreClient.ListLocationsPagedResponse`

listLocationsCallable()

public final UnaryCallable<ListLocationsRequest,ListLocationsResponse> listLocationsCallable()

Lists information about the supported locations for this service.

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 (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListLocationsResponse response =
         dataprocMetastoreClient.listLocationsCallable().call(request);
     for (Location element : response.getLocationsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

Returns
Type	Description
`UnaryCallable<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse>`

listLocationsPagedCallable()

public final UnaryCallable<ListLocationsRequest,DataprocMetastoreClient.ListLocationsPagedResponse> listLocationsPagedCallable()

Lists information about the supported locations for this service.

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 (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<Location> future =
       dataprocMetastoreClient.listLocationsPagedCallable().futureCall(request);
   // Do something.
   for (Location element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

Returns
Type	Description
`UnaryCallable<com.google.cloud.location.ListLocationsRequest,ListLocationsPagedResponse>`

listMetadataImports(ListMetadataImportsRequest request)

public final DataprocMetastoreClient.ListMetadataImportsPagedResponse listMetadataImports(ListMetadataImportsRequest request)

Lists imports in a service.

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

Parameter
Name	Description
`request`	`ListMetadataImportsRequest` The request object containing all of the parameters for the API call.

Returns
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 and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
   ServiceName parent = ServiceName.of("[PROJECT]", "[LOCATION]", "[SERVICE]");
   for (MetadataImport element :
       dataprocMetastoreClient.listMetadataImports(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter

Name Description

parent

ServiceName

Required. The relative resource name of the service whose metadata imports to list, in the following form:

projects/{project_number}/locations/{location_id}/services/{service_id}/metadataImports.

Returns
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 and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
   String parent = ServiceName.of("[PROJECT]", "[LOCATION]", "[SERVICE]").toString();
   for (MetadataImport element :
       dataprocMetastoreClient.listMetadataImports(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter

Name Description

parent

String

Required. The relative resource name of the service whose metadata imports to list, in the following form:

projects/{project_number}/locations/{location_id}/services/{service_id}/metadataImports.

Returns
Type	Description
`DataprocMetastoreClient.ListMetadataImportsPagedResponse`

listMetadataImportsCallable()

public final UnaryCallable<ListMetadataImportsRequest,ListMetadataImportsResponse> listMetadataImportsCallable()

Lists imports in a service.

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

Returns
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 and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
   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);
   }
 }

Returns
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 and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
   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);
   }
 }

Parameter
Name	Description
`request`	`ListServicesRequest` The request object containing all of the parameters for the API call.

Returns
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 and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (Service element : dataprocMetastoreClient.listServices(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter

Name Description

parent

LocationName

Required. The relative resource name of the location of metastore services to list, in the following form:

projects/{project_number}/locations/{location_id}.

Returns
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 and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   for (Service element : dataprocMetastoreClient.listServices(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter

Name Description

parent

String

Required. The relative resource name of the location of metastore services to list, in the following form:

projects/{project_number}/locations/{location_id}.

Returns
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 and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
   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;
     }
   }
 }

Returns
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 and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
   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);
   }
 }

Returns
Type	Description
`UnaryCallable<ListServicesRequest,ListServicesPagedResponse>`

moveTableToDatabaseAsync(MoveTableToDatabaseRequest request)

public final OperationFuture<MoveTableToDatabaseResponse,OperationMetadata> moveTableToDatabaseAsync(MoveTableToDatabaseRequest request)

Move a table to another 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 (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
   MoveTableToDatabaseRequest request =
       MoveTableToDatabaseRequest.newBuilder()
           .setService(ServiceName.of("[PROJECT]", "[LOCATION]", "[SERVICE]").toString())
           .setTableName("tableName-1988717703")
           .setDbName("dbName-1339126743")
           .setDestinationDbName("destinationDbName-2077361705")
           .build();
   MoveTableToDatabaseResponse response =
       dataprocMetastoreClient.moveTableToDatabaseAsync(request).get();
 }

Parameter
Name	Description
`request`	`MoveTableToDatabaseRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`OperationFuture<MoveTableToDatabaseResponse,OperationMetadata>`

moveTableToDatabaseCallable()

public final UnaryCallable<MoveTableToDatabaseRequest,Operation> moveTableToDatabaseCallable()

Move a table to another 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 (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
   MoveTableToDatabaseRequest request =
       MoveTableToDatabaseRequest.newBuilder()
           .setService(ServiceName.of("[PROJECT]", "[LOCATION]", "[SERVICE]").toString())
           .setTableName("tableName-1988717703")
           .setDbName("dbName-1339126743")
           .setDestinationDbName("destinationDbName-2077361705")
           .build();
   ApiFuture<Operation> future =
       dataprocMetastoreClient.moveTableToDatabaseCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

Returns
Type	Description
`UnaryCallable<MoveTableToDatabaseRequest,Operation>`

moveTableToDatabaseOperationCallable()

public final OperationCallable<MoveTableToDatabaseRequest,MoveTableToDatabaseResponse,OperationMetadata> moveTableToDatabaseOperationCallable()

Move a table to another 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 (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
   MoveTableToDatabaseRequest request =
       MoveTableToDatabaseRequest.newBuilder()
           .setService(ServiceName.of("[PROJECT]", "[LOCATION]", "[SERVICE]").toString())
           .setTableName("tableName-1988717703")
           .setDbName("dbName-1339126743")
           .setDestinationDbName("destinationDbName-2077361705")
           .build();
   OperationFuture<MoveTableToDatabaseResponse, OperationMetadata> future =
       dataprocMetastoreClient.moveTableToDatabaseOperationCallable().futureCall(request);
   // Do something.
   MoveTableToDatabaseResponse response = future.get();
 }

Returns
Type	Description
`OperationCallable<MoveTableToDatabaseRequest,MoveTableToDatabaseResponse,OperationMetadata>`

queryMetadataAsync(QueryMetadataRequest request)

public final OperationFuture<QueryMetadataResponse,OperationMetadata> queryMetadataAsync(QueryMetadataRequest request)

Query DPMS metadata.

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 (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
   QueryMetadataRequest request =
       QueryMetadataRequest.newBuilder()
           .setService(ServiceName.of("[PROJECT]", "[LOCATION]", "[SERVICE]").toString())
           .setQuery("query107944136")
           .build();
   QueryMetadataResponse response = dataprocMetastoreClient.queryMetadataAsync(request).get();
 }

Parameter
Name	Description
`request`	`QueryMetadataRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`OperationFuture<QueryMetadataResponse,OperationMetadata>`

queryMetadataCallable()

public final UnaryCallable<QueryMetadataRequest,Operation> queryMetadataCallable()

Query DPMS metadata.

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 (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
   QueryMetadataRequest request =
       QueryMetadataRequest.newBuilder()
           .setService(ServiceName.of("[PROJECT]", "[LOCATION]", "[SERVICE]").toString())
           .setQuery("query107944136")
           .build();
   ApiFuture<Operation> future =
       dataprocMetastoreClient.queryMetadataCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

Returns
Type	Description
`UnaryCallable<QueryMetadataRequest,Operation>`

queryMetadataOperationCallable()

public final OperationCallable<QueryMetadataRequest,QueryMetadataResponse,OperationMetadata> queryMetadataOperationCallable()

Query DPMS metadata.

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 (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
   QueryMetadataRequest request =
       QueryMetadataRequest.newBuilder()
           .setService(ServiceName.of("[PROJECT]", "[LOCATION]", "[SERVICE]").toString())
           .setQuery("query107944136")
           .build();
   OperationFuture<QueryMetadataResponse, OperationMetadata> future =
       dataprocMetastoreClient.queryMetadataOperationCallable().futureCall(request);
   // Do something.
   QueryMetadataResponse response = future.get();
 }

Returns
Type	Description
`OperationCallable<QueryMetadataRequest,QueryMetadataResponse,OperationMetadata>`

removeIamPolicy(RemoveIamPolicyRequest request)

public final RemoveIamPolicyResponse removeIamPolicy(RemoveIamPolicyRequest request)

Removes the attached IAM policies for a resource

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 (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
   RemoveIamPolicyRequest request =
       RemoveIamPolicyRequest.newBuilder()
           .setResource(
               BackupName.of("[PROJECT]", "[LOCATION]", "[SERVICE]", "[BACKUP]").toString())
           .setAsynchronous(true)
           .build();
   RemoveIamPolicyResponse response = dataprocMetastoreClient.removeIamPolicy(request);
 }

Parameter
Name	Description
`request`	`RemoveIamPolicyRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`RemoveIamPolicyResponse`

removeIamPolicyCallable()

public final UnaryCallable<RemoveIamPolicyRequest,RemoveIamPolicyResponse> removeIamPolicyCallable()

Removes the attached IAM policies for a resource

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 (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
   RemoveIamPolicyRequest request =
       RemoveIamPolicyRequest.newBuilder()
           .setResource(
               BackupName.of("[PROJECT]", "[LOCATION]", "[SERVICE]", "[BACKUP]").toString())
           .setAsynchronous(true)
           .build();
   ApiFuture<RemoveIamPolicyResponse> future =
       dataprocMetastoreClient.removeIamPolicyCallable().futureCall(request);
   // Do something.
   RemoveIamPolicyResponse response = future.get();
 }

Returns
Type	Description
`UnaryCallable<RemoveIamPolicyRequest,RemoveIamPolicyResponse>`

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 and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
   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();
 }

Parameter
Name	Description
`request`	`RestoreServiceRequest` The request object containing all of the parameters for the API call.

Returns
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 and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
   ServiceName service = ServiceName.of("[PROJECT]", "[LOCATION]", "[SERVICE]");
   BackupName backup = BackupName.of("[PROJECT]", "[LOCATION]", "[SERVICE]", "[BACKUP]");
   Restore response = dataprocMetastoreClient.restoreServiceAsync(service, backup).get();
 }

Parameters

Name Description

service

ServiceName

Required. The relative resource name of the metastore service to run restore, in the following form:

projects/{project_id}/locations/{location_id}/services/{service_id}.

backup

BackupName

Required. The relative resource name of the metastore service backup to restore from, in the following form:

projects/{project_id}/locations/{location_id}/services/{service_id}/backups/{backup_id}.

Returns
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 and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
   ServiceName service = ServiceName.of("[PROJECT]", "[LOCATION]", "[SERVICE]");
   String backup = BackupName.of("[PROJECT]", "[LOCATION]", "[SERVICE]", "[BACKUP]").toString();
   Restore response = dataprocMetastoreClient.restoreServiceAsync(service, backup).get();
 }

Parameters

Name Description

service

ServiceName

Required. The relative resource name of the metastore service to run restore, in the following form:

projects/{project_id}/locations/{location_id}/services/{service_id}.

backup

String

Required. The relative resource name of the metastore service backup to restore from, in the following form:

projects/{project_id}/locations/{location_id}/services/{service_id}/backups/{backup_id}.

Returns
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 and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
   String service = ServiceName.of("[PROJECT]", "[LOCATION]", "[SERVICE]").toString();
   BackupName backup = BackupName.of("[PROJECT]", "[LOCATION]", "[SERVICE]", "[BACKUP]");
   Restore response = dataprocMetastoreClient.restoreServiceAsync(service, backup).get();
 }

Parameters

Name Description

service

String

Required. The relative resource name of the metastore service to run restore, in the following form:

projects/{project_id}/locations/{location_id}/services/{service_id}.

backup

BackupName

Required. The relative resource name of the metastore service backup to restore from, in the following form:

projects/{project_id}/locations/{location_id}/services/{service_id}/backups/{backup_id}.

Returns
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 and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
   String service = ServiceName.of("[PROJECT]", "[LOCATION]", "[SERVICE]").toString();
   String backup = BackupName.of("[PROJECT]", "[LOCATION]", "[SERVICE]", "[BACKUP]").toString();
   Restore response = dataprocMetastoreClient.restoreServiceAsync(service, backup).get();
 }

Parameters

Name Description

service

String

Required. The relative resource name of the metastore service to run restore, in the following form:

projects/{project_id}/locations/{location_id}/services/{service_id}.

backup

String

Required. The relative resource name of the metastore service backup to restore from, in the following form:

projects/{project_id}/locations/{location_id}/services/{service_id}/backups/{backup_id}.

Returns
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 and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
   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();
 }

Returns
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 and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
   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();
 }

Returns
Type	Description
`OperationCallable<RestoreServiceRequest,Restore,OperationMetadata>`

setIamPolicy(SetIamPolicyRequest request)

public final Policy setIamPolicy(SetIamPolicyRequest request)

Sets the access control policy on the specified resource. Replacesany existing policy.

Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIEDerrors.

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 (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
   SetIamPolicyRequest request =
       SetIamPolicyRequest.newBuilder()
           .setResource(
               BackupName.of("[PROJECT]", "[LOCATION]", "[SERVICE]", "[BACKUP]").toString())
           .setPolicy(Policy.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   Policy response = dataprocMetastoreClient.setIamPolicy(request);
 }

Parameter
Name	Description
`request`	`com.google.iam.v1.SetIamPolicyRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`com.google.iam.v1.Policy`

setIamPolicyCallable()

public final UnaryCallable<SetIamPolicyRequest,Policy> setIamPolicyCallable()

Sets the access control policy on the specified resource. Replacesany existing policy.

Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIEDerrors.

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 (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
   SetIamPolicyRequest request =
       SetIamPolicyRequest.newBuilder()
           .setResource(
               BackupName.of("[PROJECT]", "[LOCATION]", "[SERVICE]", "[BACKUP]").toString())
           .setPolicy(Policy.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<Policy> future = dataprocMetastoreClient.setIamPolicyCallable().futureCall(request);
   // Do something.
   Policy response = future.get();
 }

Returns
Type	Description
`UnaryCallable<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy>`

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

testIamPermissions(TestIamPermissionsRequest request)

public final TestIamPermissionsResponse testIamPermissions(TestIamPermissionsRequest request)

Returns permissions that a caller has on the specified resource. If theresource does not exist, this will return an empty set ofpermissions, not a NOT_FOUND error.

Note: This operation is designed to be used for buildingpermission-aware UIs and command-line tools, not for authorizationchecking. This operation may "fail open" without warning.

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 (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
   TestIamPermissionsRequest request =
       TestIamPermissionsRequest.newBuilder()
           .setResource(
               BackupName.of("[PROJECT]", "[LOCATION]", "[SERVICE]", "[BACKUP]").toString())
           .addAllPermissions(new ArrayList<String>())
           .build();
   TestIamPermissionsResponse response = dataprocMetastoreClient.testIamPermissions(request);
 }

Parameter
Name	Description
`request`	`com.google.iam.v1.TestIamPermissionsRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`com.google.iam.v1.TestIamPermissionsResponse`

testIamPermissionsCallable()

public final UnaryCallable<TestIamPermissionsRequest,TestIamPermissionsResponse> testIamPermissionsCallable()

Returns permissions that a caller has on the specified resource. If theresource does not exist, this will return an empty set ofpermissions, not a NOT_FOUND error.

Note: This operation is designed to be used for buildingpermission-aware UIs and command-line tools, not for authorizationchecking. This operation may "fail open" without warning.

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 (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
   TestIamPermissionsRequest request =
       TestIamPermissionsRequest.newBuilder()
           .setResource(
               BackupName.of("[PROJECT]", "[LOCATION]", "[SERVICE]", "[BACKUP]").toString())
           .addAllPermissions(new ArrayList<String>())
           .build();
   ApiFuture<TestIamPermissionsResponse> future =
       dataprocMetastoreClient.testIamPermissionsCallable().futureCall(request);
   // Do something.
   TestIamPermissionsResponse response = future.get();
 }

Returns
Type	Description
`UnaryCallable<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse>`

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 and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
   MetadataImport metadataImport = MetadataImport.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   MetadataImport response =
       dataprocMetastoreClient.updateMetadataImportAsync(metadataImport, updateMask).get();
 }

Parameters

Name Description

metadataImport

MetadataImport

Required. The metadata import to update. The server only merges fields in the import if they are specified in update_mask.

The metadata import's name field is used to identify the metastore import to be updated.

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 update_mask are relative to the resource (not to the full request). A field is overwritten if it is in the mask.

Returns
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 and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
   UpdateMetadataImportRequest request =
       UpdateMetadataImportRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setMetadataImport(MetadataImport.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   MetadataImport response = dataprocMetastoreClient.updateMetadataImportAsync(request).get();
 }

Parameter
Name	Description
`request`	`UpdateMetadataImportRequest` The request object containing all of the parameters for the API call.

Returns
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 and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
   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();
 }

Returns
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 and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
   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();
 }

Returns
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 and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
   Service service = Service.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   Service response = dataprocMetastoreClient.updateServiceAsync(service, updateMask).get();
 }

Parameters

Name Description

service

Service

Required. The metastore service to update. The server only merges fields in the service if they are specified in update_mask.

The metastore service's name field is used to identify the metastore service to be updated.

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 update_mask are relative to the resource (not to the full request). A field is overwritten if it is in the mask.

Returns
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 and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
   UpdateServiceRequest request =
       UpdateServiceRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setService(Service.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   Service response = dataprocMetastoreClient.updateServiceAsync(request).get();
 }

Parameter
Name	Description
`request`	`UpdateServiceRequest` The request object containing all of the parameters for the API call.

Returns
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 and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
   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();
 }

Returns
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 and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (DataprocMetastoreClient dataprocMetastoreClient = DataprocMetastoreClient.create()) {
   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();
 }

Returns
Type	Description
`OperationCallable<UpdateServiceRequest,Service,OperationMetadata>`