Class DataprocMetastoreClient
- java.lang.Object
-
- com.google.cloud.metastore.v1beta.DataprocMetastoreClient
-
- All Implemented Interfaces:
com.google.api.gax.core.BackgroundResource
,AutoCloseable
@BetaApi @Generated("by gapic-generator-java") public class DataprocMetastoreClient extends Object implements com.google.api.gax.core.BackgroundResource
Service Description: Configures and manages metastore services. Metastore services are fully managed, highly available, autoscaled, autohealing, OSS-native deployments of technical metadata management software. Each metastore service exposes a network endpoint through which metadata queries are served. Metadata queries can originate from a variety of sources, including Apache Hive, Apache Presto, and Apache Spark.The Dataproc Metastore API defines the following resource model:
- The service works with a collection of Google Cloud projects, named: `/projects/*`
- Each project has a collection of available locations, named: `/locations/*` (a location must refer to a Google 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.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
DataprocMetastoreClient.ListBackupsFixedSizeCollection
static class
DataprocMetastoreClient.ListBackupsPage
static class
DataprocMetastoreClient.ListBackupsPagedResponse
static class
DataprocMetastoreClient.ListLocationsFixedSizeCollection
static class
DataprocMetastoreClient.ListLocationsPage
static class
DataprocMetastoreClient.ListLocationsPagedResponse
static class
DataprocMetastoreClient.ListMetadataImportsFixedSizeCollection
static class
DataprocMetastoreClient.ListMetadataImportsPage
static class
DataprocMetastoreClient.ListMetadataImportsPagedResponse
static class
DataprocMetastoreClient.ListServicesFixedSizeCollection
static class
DataprocMetastoreClient.ListServicesPage
static class
DataprocMetastoreClient.ListServicesPagedResponse
-
Constructor Summary
Constructors Modifier Constructor Description protected
DataprocMetastoreClient(DataprocMetastoreSettings settings)
Constructs an instance of DataprocMetastoreClient, using the given settings.protected
DataprocMetastoreClient(DataprocMetastoreStub stub)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description com.google.api.gax.longrunning.OperationFuture<AlterMetadataResourceLocationResponse,OperationMetadata>
alterMetadataResourceLocationAsync(AlterMetadataResourceLocationRequest request)
Alter metadata resource location.com.google.api.gax.rpc.UnaryCallable<AlterMetadataResourceLocationRequest,com.google.longrunning.Operation>
alterMetadataResourceLocationCallable()
Alter metadata resource location.com.google.api.gax.rpc.OperationCallable<AlterMetadataResourceLocationRequest,AlterMetadataResourceLocationResponse,OperationMetadata>
alterMetadataResourceLocationOperationCallable()
Alter metadata resource location.boolean
awaitTermination(long duration, TimeUnit unit)
void
close()
static DataprocMetastoreClient
create()
Constructs an instance of DataprocMetastoreClient with default settings.static DataprocMetastoreClient
create(DataprocMetastoreSettings settings)
Constructs an instance of DataprocMetastoreClient, using the given settings.static DataprocMetastoreClient
create(DataprocMetastoreStub stub)
Constructs an instance of DataprocMetastoreClient, using the given stub for making calls.com.google.api.gax.longrunning.OperationFuture<Backup,OperationMetadata>
createBackupAsync(CreateBackupRequest request)
Creates a new backup in a given project and location.com.google.api.gax.longrunning.OperationFuture<Backup,OperationMetadata>
createBackupAsync(ServiceName parent, Backup backup, String backupId)
Creates a new backup in a given project and location.com.google.api.gax.longrunning.OperationFuture<Backup,OperationMetadata>
createBackupAsync(String parent, Backup backup, String backupId)
Creates a new backup in a given project and location.com.google.api.gax.rpc.UnaryCallable<CreateBackupRequest,com.google.longrunning.Operation>
createBackupCallable()
Creates a new backup in a given project and location.com.google.api.gax.rpc.OperationCallable<CreateBackupRequest,Backup,OperationMetadata>
createBackupOperationCallable()
Creates a new backup in a given project and location.com.google.api.gax.longrunning.OperationFuture<MetadataImport,OperationMetadata>
createMetadataImportAsync(CreateMetadataImportRequest request)
Creates a new MetadataImport in a given project and location.com.google.api.gax.longrunning.OperationFuture<MetadataImport,OperationMetadata>
createMetadataImportAsync(ServiceName parent, MetadataImport metadataImport, String metadataImportId)
Creates a new MetadataImport in a given project and location.com.google.api.gax.longrunning.OperationFuture<MetadataImport,OperationMetadata>
createMetadataImportAsync(String parent, MetadataImport metadataImport, String metadataImportId)
Creates a new MetadataImport in a given project and location.com.google.api.gax.rpc.UnaryCallable<CreateMetadataImportRequest,com.google.longrunning.Operation>
createMetadataImportCallable()
Creates a new MetadataImport in a given project and location.com.google.api.gax.rpc.OperationCallable<CreateMetadataImportRequest,MetadataImport,OperationMetadata>
createMetadataImportOperationCallable()
Creates a new MetadataImport in a given project and location.com.google.api.gax.longrunning.OperationFuture<Service,OperationMetadata>
createServiceAsync(CreateServiceRequest request)
Creates a metastore service in a project and location.com.google.api.gax.longrunning.OperationFuture<Service,OperationMetadata>
createServiceAsync(LocationName parent, Service service, String serviceId)
Creates a metastore service in a project and location.com.google.api.gax.longrunning.OperationFuture<Service,OperationMetadata>
createServiceAsync(String parent, Service service, String serviceId)
Creates a metastore service in a project and location.com.google.api.gax.rpc.UnaryCallable<CreateServiceRequest,com.google.longrunning.Operation>
createServiceCallable()
Creates a metastore service in a project and location.com.google.api.gax.rpc.OperationCallable<CreateServiceRequest,Service,OperationMetadata>
createServiceOperationCallable()
Creates a metastore service in a project and location.com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,OperationMetadata>
deleteBackupAsync(BackupName name)
Deletes a single backup.com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,OperationMetadata>
deleteBackupAsync(DeleteBackupRequest request)
Deletes a single backup.com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,OperationMetadata>
deleteBackupAsync(String name)
Deletes a single backup.com.google.api.gax.rpc.UnaryCallable<DeleteBackupRequest,com.google.longrunning.Operation>
deleteBackupCallable()
Deletes a single backup.com.google.api.gax.rpc.OperationCallable<DeleteBackupRequest,com.google.protobuf.Empty,OperationMetadata>
deleteBackupOperationCallable()
Deletes a single backup.com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,OperationMetadata>
deleteServiceAsync(DeleteServiceRequest request)
Deletes a single service.com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,OperationMetadata>
deleteServiceAsync(ServiceName name)
Deletes a single service.com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.Empty,OperationMetadata>
deleteServiceAsync(String name)
Deletes a single service.com.google.api.gax.rpc.UnaryCallable<DeleteServiceRequest,com.google.longrunning.Operation>
deleteServiceCallable()
Deletes a single service.com.google.api.gax.rpc.OperationCallable<DeleteServiceRequest,com.google.protobuf.Empty,OperationMetadata>
deleteServiceOperationCallable()
Deletes a single service.com.google.api.gax.longrunning.OperationFuture<MetadataExport,OperationMetadata>
exportMetadataAsync(ExportMetadataRequest request)
Exports metadata from a service.com.google.api.gax.rpc.UnaryCallable<ExportMetadataRequest,com.google.longrunning.Operation>
exportMetadataCallable()
Exports metadata from a service.com.google.api.gax.rpc.OperationCallable<ExportMetadataRequest,MetadataExport,OperationMetadata>
exportMetadataOperationCallable()
Exports metadata from a service.Backup
getBackup(BackupName name)
Gets details of a single backup.Backup
getBackup(GetBackupRequest request)
Gets details of a single backup.Backup
getBackup(String name)
Gets details of a single backup.com.google.api.gax.rpc.UnaryCallable<GetBackupRequest,Backup>
getBackupCallable()
Gets details of a single backup.com.google.api.gax.httpjson.longrunning.OperationsClient
getHttpJsonOperationsClient()
Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.com.google.iam.v1.Policy
getIamPolicy(com.google.iam.v1.GetIamPolicyRequest request)
Gets the access control policy for a resource.com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy>
getIamPolicyCallable()
Gets the access control policy for a resource.com.google.cloud.location.Location
getLocation(com.google.cloud.location.GetLocationRequest request)
Gets information about a location.com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location>
getLocationCallable()
Gets information about a location.MetadataImport
getMetadataImport(GetMetadataImportRequest request)
Gets details of a single import.MetadataImport
getMetadataImport(MetadataImportName name)
Gets details of a single import.MetadataImport
getMetadataImport(String name)
Gets details of a single import.com.google.api.gax.rpc.UnaryCallable<GetMetadataImportRequest,MetadataImport>
getMetadataImportCallable()
Gets details of a single import.com.google.longrunning.OperationsClient
getOperationsClient()
Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.Service
getService(GetServiceRequest request)
Gets the details of a single service.Service
getService(ServiceName name)
Gets the details of a single service.Service
getService(String name)
Gets the details of a single service.com.google.api.gax.rpc.UnaryCallable<GetServiceRequest,Service>
getServiceCallable()
Gets the details of a single service.DataprocMetastoreSettings
getSettings()
DataprocMetastoreStub
getStub()
boolean
isShutdown()
boolean
isTerminated()
DataprocMetastoreClient.ListBackupsPagedResponse
listBackups(ListBackupsRequest request)
Lists backups in a service.DataprocMetastoreClient.ListBackupsPagedResponse
listBackups(ServiceName parent)
Lists backups in a service.DataprocMetastoreClient.ListBackupsPagedResponse
listBackups(String parent)
Lists backups in a service.com.google.api.gax.rpc.UnaryCallable<ListBackupsRequest,ListBackupsResponse>
listBackupsCallable()
Lists backups in a service.com.google.api.gax.rpc.UnaryCallable<ListBackupsRequest,DataprocMetastoreClient.ListBackupsPagedResponse>
listBackupsPagedCallable()
Lists backups in a service.DataprocMetastoreClient.ListLocationsPagedResponse
listLocations(com.google.cloud.location.ListLocationsRequest request)
Lists information about the supported locations for this service.com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse>
listLocationsCallable()
Lists information about the supported locations for this service.com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.ListLocationsRequest,DataprocMetastoreClient.ListLocationsPagedResponse>
listLocationsPagedCallable()
Lists information about the supported locations for this service.DataprocMetastoreClient.ListMetadataImportsPagedResponse
listMetadataImports(ListMetadataImportsRequest request)
Lists imports in a service.DataprocMetastoreClient.ListMetadataImportsPagedResponse
listMetadataImports(ServiceName parent)
Lists imports in a service.DataprocMetastoreClient.ListMetadataImportsPagedResponse
listMetadataImports(String parent)
Lists imports in a service.com.google.api.gax.rpc.UnaryCallable<ListMetadataImportsRequest,ListMetadataImportsResponse>
listMetadataImportsCallable()
Lists imports in a service.com.google.api.gax.rpc.UnaryCallable<ListMetadataImportsRequest,DataprocMetastoreClient.ListMetadataImportsPagedResponse>
listMetadataImportsPagedCallable()
Lists imports in a service.DataprocMetastoreClient.ListServicesPagedResponse
listServices(ListServicesRequest request)
Lists services in a project and location.DataprocMetastoreClient.ListServicesPagedResponse
listServices(LocationName parent)
Lists services in a project and location.DataprocMetastoreClient.ListServicesPagedResponse
listServices(String parent)
Lists services in a project and location.com.google.api.gax.rpc.UnaryCallable<ListServicesRequest,ListServicesResponse>
listServicesCallable()
Lists services in a project and location.com.google.api.gax.rpc.UnaryCallable<ListServicesRequest,DataprocMetastoreClient.ListServicesPagedResponse>
listServicesPagedCallable()
Lists services in a project and location.com.google.api.gax.longrunning.OperationFuture<MoveTableToDatabaseResponse,OperationMetadata>
moveTableToDatabaseAsync(MoveTableToDatabaseRequest request)
Move a table to another database.com.google.api.gax.rpc.UnaryCallable<MoveTableToDatabaseRequest,com.google.longrunning.Operation>
moveTableToDatabaseCallable()
Move a table to another database.com.google.api.gax.rpc.OperationCallable<MoveTableToDatabaseRequest,MoveTableToDatabaseResponse,OperationMetadata>
moveTableToDatabaseOperationCallable()
Move a table to another database.com.google.api.gax.longrunning.OperationFuture<QueryMetadataResponse,OperationMetadata>
queryMetadataAsync(QueryMetadataRequest request)
Query DPMS metadata.com.google.api.gax.rpc.UnaryCallable<QueryMetadataRequest,com.google.longrunning.Operation>
queryMetadataCallable()
Query DPMS metadata.com.google.api.gax.rpc.OperationCallable<QueryMetadataRequest,QueryMetadataResponse,OperationMetadata>
queryMetadataOperationCallable()
Query DPMS metadata.RemoveIamPolicyResponse
removeIamPolicy(RemoveIamPolicyRequest request)
Removes the attached IAM policies for a resourcecom.google.api.gax.rpc.UnaryCallable<RemoveIamPolicyRequest,RemoveIamPolicyResponse>
removeIamPolicyCallable()
Removes the attached IAM policies for a resourcecom.google.api.gax.longrunning.OperationFuture<Restore,OperationMetadata>
restoreServiceAsync(RestoreServiceRequest request)
Restores a service from a backup.com.google.api.gax.longrunning.OperationFuture<Restore,OperationMetadata>
restoreServiceAsync(ServiceName service, BackupName backup)
Restores a service from a backup.com.google.api.gax.longrunning.OperationFuture<Restore,OperationMetadata>
restoreServiceAsync(ServiceName service, String backup)
Restores a service from a backup.com.google.api.gax.longrunning.OperationFuture<Restore,OperationMetadata>
restoreServiceAsync(String service, BackupName backup)
Restores a service from a backup.com.google.api.gax.longrunning.OperationFuture<Restore,OperationMetadata>
restoreServiceAsync(String service, String backup)
Restores a service from a backup.com.google.api.gax.rpc.UnaryCallable<RestoreServiceRequest,com.google.longrunning.Operation>
restoreServiceCallable()
Restores a service from a backup.com.google.api.gax.rpc.OperationCallable<RestoreServiceRequest,Restore,OperationMetadata>
restoreServiceOperationCallable()
Restores a service from a backup.com.google.iam.v1.Policy
setIamPolicy(com.google.iam.v1.SetIamPolicyRequest request)
Sets the access control policy on the specified resource.com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy>
setIamPolicyCallable()
Sets the access control policy on the specified resource.void
shutdown()
void
shutdownNow()
com.google.iam.v1.TestIamPermissionsResponse
testIamPermissions(com.google.iam.v1.TestIamPermissionsRequest request)
Returns permissions that a caller has on the specified resource.com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse>
testIamPermissionsCallable()
Returns permissions that a caller has on the specified resource.com.google.api.gax.longrunning.OperationFuture<MetadataImport,OperationMetadata>
updateMetadataImportAsync(MetadataImport metadataImport, com.google.protobuf.FieldMask updateMask)
Updates a single import.com.google.api.gax.longrunning.OperationFuture<MetadataImport,OperationMetadata>
updateMetadataImportAsync(UpdateMetadataImportRequest request)
Updates a single import.com.google.api.gax.rpc.UnaryCallable<UpdateMetadataImportRequest,com.google.longrunning.Operation>
updateMetadataImportCallable()
Updates a single import.com.google.api.gax.rpc.OperationCallable<UpdateMetadataImportRequest,MetadataImport,OperationMetadata>
updateMetadataImportOperationCallable()
Updates a single import.com.google.api.gax.longrunning.OperationFuture<Service,OperationMetadata>
updateServiceAsync(Service service, com.google.protobuf.FieldMask updateMask)
Updates the parameters of a single service.com.google.api.gax.longrunning.OperationFuture<Service,OperationMetadata>
updateServiceAsync(UpdateServiceRequest request)
Updates the parameters of a single service.com.google.api.gax.rpc.UnaryCallable<UpdateServiceRequest,com.google.longrunning.Operation>
updateServiceCallable()
Updates the parameters of a single service.com.google.api.gax.rpc.OperationCallable<UpdateServiceRequest,Service,OperationMetadata>
updateServiceOperationCallable()
Updates the parameters of a single service.
-
-
-
Constructor Detail
-
DataprocMetastoreClient
protected DataprocMetastoreClient(DataprocMetastoreSettings settings) throws IOException
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.- Throws:
IOException
-
DataprocMetastoreClient
protected DataprocMetastoreClient(DataprocMetastoreStub stub)
-
-
Method Detail
-
create
public static final DataprocMetastoreClient create() throws IOException
Constructs an instance of DataprocMetastoreClient with default settings.- Throws:
IOException
-
create
public static final DataprocMetastoreClient create(DataprocMetastoreSettings settings) throws IOException
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.- Throws:
IOException
-
create
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).
-
getSettings
public final DataprocMetastoreSettings getSettings()
-
getStub
public DataprocMetastoreStub getStub()
-
getOperationsClient
public final com.google.longrunning.OperationsClient getOperationsClient()
Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
-
getHttpJsonOperationsClient
@BetaApi public final com.google.api.gax.httpjson.longrunning.OperationsClient getHttpJsonOperationsClient()
Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
-
listServices
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); } }
- Parameters:
parent
- Required. The relative resource name of the location of metastore services to list, in the following form:`projects/{project_number}/locations/{location_id}`.
- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
listServices
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); } }
- Parameters:
parent
- Required. The relative resource name of the location of metastore services to list, in the following form:`projects/{project_number}/locations/{location_id}`.
- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
listServices
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); } }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
listServicesPagedCallable
public final com.google.api.gax.rpc.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); } }
-
listServicesCallable
public final com.google.api.gax.rpc.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; } } }
-
getService
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); }
- Parameters:
name
- Required. The relative resource name of the metastore service to retrieve, in the following form:`projects/{project_number}/locations/{location_id}/services/{service_id}`.
- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
getService
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); }
- Parameters:
name
- Required. The relative resource name of the metastore service to retrieve, in the following form:`projects/{project_number}/locations/{location_id}/services/{service_id}`.
- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
getService
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); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
getServiceCallable
public final com.google.api.gax.rpc.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(); }
-
createServiceAsync
public final com.google.api.gax.longrunning.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:
parent
- 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
- 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
- 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.
- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
createServiceAsync
public final com.google.api.gax.longrunning.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:
parent
- 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
- 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
- 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.
- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
createServiceAsync
public final com.google.api.gax.longrunning.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(); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
createServiceOperationCallable
public final com.google.api.gax.rpc.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(); }
-
createServiceCallable
public final com.google.api.gax.rpc.UnaryCallable<CreateServiceRequest,com.google.longrunning.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(); }
-
updateServiceAsync
public final com.google.api.gax.longrunning.OperationFuture<Service,OperationMetadata> updateServiceAsync(Service service, com.google.protobuf.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:
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
- 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.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
updateServiceAsync
public final com.google.api.gax.longrunning.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(); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
updateServiceOperationCallable
public final com.google.api.gax.rpc.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(); }
-
updateServiceCallable
public final com.google.api.gax.rpc.UnaryCallable<UpdateServiceRequest,com.google.longrunning.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(); }
-
deleteServiceAsync
public final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.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(); }
- Parameters:
name
- Required. The relative resource name of the metastore service to delete, in the following form:`projects/{project_number}/locations/{location_id}/services/{service_id}`.
- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
deleteServiceAsync
public final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.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(); }
- Parameters:
name
- Required. The relative resource name of the metastore service to delete, in the following form:`projects/{project_number}/locations/{location_id}/services/{service_id}`.
- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
deleteServiceAsync
public final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.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(); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
deleteServiceOperationCallable
public final com.google.api.gax.rpc.OperationCallable<DeleteServiceRequest,com.google.protobuf.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(); }
-
deleteServiceCallable
public final com.google.api.gax.rpc.UnaryCallable<DeleteServiceRequest,com.google.longrunning.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(); }
-
listMetadataImports
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); } }
- Parameters:
parent
- 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`.
- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
listMetadataImports
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); } }
- Parameters:
parent
- 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`.
- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
listMetadataImports
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); } }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
listMetadataImportsPagedCallable
public final com.google.api.gax.rpc.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); } }
-
listMetadataImportsCallable
public final com.google.api.gax.rpc.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; } } }
-
getMetadataImport
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); }
- Parameters:
name
- 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}`.
- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
getMetadataImport
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); }
- Parameters:
name
- 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}`.
- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
getMetadataImport
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); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
getMetadataImportCallable
public final com.google.api.gax.rpc.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(); }
-
createMetadataImportAsync
public final com.google.api.gax.longrunning.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:
parent
- 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
- 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
- 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.
- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
createMetadataImportAsync
public final com.google.api.gax.longrunning.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:
parent
- 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
- 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
- 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.
- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
createMetadataImportAsync
public final com.google.api.gax.longrunning.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(); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
createMetadataImportOperationCallable
public final com.google.api.gax.rpc.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(); }
-
createMetadataImportCallable
public final com.google.api.gax.rpc.UnaryCallable<CreateMetadataImportRequest,com.google.longrunning.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(); }
-
updateMetadataImportAsync
public final com.google.api.gax.longrunning.OperationFuture<MetadataImport,OperationMetadata> updateMetadataImportAsync(MetadataImport metadataImport, com.google.protobuf.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:
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
- 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.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
updateMetadataImportAsync
public final com.google.api.gax.longrunning.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(); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
updateMetadataImportOperationCallable
public final com.google.api.gax.rpc.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(); }
-
updateMetadataImportCallable
public final com.google.api.gax.rpc.UnaryCallable<UpdateMetadataImportRequest,com.google.longrunning.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(); }
-
exportMetadataAsync
public final com.google.api.gax.longrunning.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(); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
exportMetadataOperationCallable
public final com.google.api.gax.rpc.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(); }
-
exportMetadataCallable
public final com.google.api.gax.rpc.UnaryCallable<ExportMetadataRequest,com.google.longrunning.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(); }
-
restoreServiceAsync
public final com.google.api.gax.longrunning.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:
service
- 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
- 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}`.
- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
restoreServiceAsync
public final com.google.api.gax.longrunning.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:
service
- 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
- 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}`.
- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
restoreServiceAsync
public final com.google.api.gax.longrunning.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:
service
- 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
- 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}`.
- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
restoreServiceAsync
public final com.google.api.gax.longrunning.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:
service
- 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
- 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}`.
- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
restoreServiceAsync
public final com.google.api.gax.longrunning.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(); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
restoreServiceOperationCallable
public final com.google.api.gax.rpc.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(); }
-
restoreServiceCallable
public final com.google.api.gax.rpc.UnaryCallable<RestoreServiceRequest,com.google.longrunning.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(); }
-
listBackups
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); } }
- Parameters:
parent
- 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`.
- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
listBackups
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); } }
- Parameters:
parent
- 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`.
- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
listBackups
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); } }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
listBackupsPagedCallable
public final com.google.api.gax.rpc.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); } }
-
listBackupsCallable
public final com.google.api.gax.rpc.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; } } }
-
getBackup
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); }
- Parameters:
name
- 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}`.
- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
getBackup
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); }
- Parameters:
name
- 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}`.
- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
getBackup
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); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
getBackupCallable
public final com.google.api.gax.rpc.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(); }
-
createBackupAsync
public final com.google.api.gax.longrunning.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:
parent
- 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
- 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
- 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.
- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
createBackupAsync
public final com.google.api.gax.longrunning.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:
parent
- 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
- 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
- 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.
- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
createBackupAsync
public final com.google.api.gax.longrunning.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(); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
createBackupOperationCallable
public final com.google.api.gax.rpc.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(); }
-
createBackupCallable
public final com.google.api.gax.rpc.UnaryCallable<CreateBackupRequest,com.google.longrunning.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(); }
-
deleteBackupAsync
public final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.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(); }
- Parameters:
name
- 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}`.
- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
deleteBackupAsync
public final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.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(); }
- Parameters:
name
- 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}`.
- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
deleteBackupAsync
public final com.google.api.gax.longrunning.OperationFuture<com.google.protobuf.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(); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
deleteBackupOperationCallable
public final com.google.api.gax.rpc.OperationCallable<DeleteBackupRequest,com.google.protobuf.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(); }
-
deleteBackupCallable
public final com.google.api.gax.rpc.UnaryCallable<DeleteBackupRequest,com.google.longrunning.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(); }
-
removeIamPolicy
public final RemoveIamPolicyResponse removeIamPolicy(RemoveIamPolicyRequest request)
Removes the attached IAM policies for a resourceSample 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); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
removeIamPolicyCallable
public final com.google.api.gax.rpc.UnaryCallable<RemoveIamPolicyRequest,RemoveIamPolicyResponse> removeIamPolicyCallable()
Removes the attached IAM policies for a resourceSample 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(); }
-
queryMetadataAsync
public final com.google.api.gax.longrunning.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(); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
queryMetadataOperationCallable
public final com.google.api.gax.rpc.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(); }
-
queryMetadataCallable
public final com.google.api.gax.rpc.UnaryCallable<QueryMetadataRequest,com.google.longrunning.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(); }
-
moveTableToDatabaseAsync
public final com.google.api.gax.longrunning.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(); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
moveTableToDatabaseOperationCallable
public final com.google.api.gax.rpc.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(); }
-
moveTableToDatabaseCallable
public final com.google.api.gax.rpc.UnaryCallable<MoveTableToDatabaseRequest,com.google.longrunning.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(); }
-
alterMetadataResourceLocationAsync
public final com.google.api.gax.longrunning.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(); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
alterMetadataResourceLocationOperationCallable
public final com.google.api.gax.rpc.OperationCallable<AlterMetadataResourceLocationRequest,AlterMetadataResourceLocationResponse,OperationMetadata> alterMetadataResourceLocationOperationCallable()
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(); OperationFuture<AlterMetadataResourceLocationResponse, OperationMetadata> future = dataprocMetastoreClient .alterMetadataResourceLocationOperationCallable() .futureCall(request); // Do something. AlterMetadataResourceLocationResponse response = future.get(); }
-
alterMetadataResourceLocationCallable
public final com.google.api.gax.rpc.UnaryCallable<AlterMetadataResourceLocationRequest,com.google.longrunning.Operation> alterMetadataResourceLocationCallable()
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(); ApiFuture<Operation> future = dataprocMetastoreClient.alterMetadataResourceLocationCallable().futureCall(request); // Do something. Operation response = future.get(); }
-
listLocations
public final DataprocMetastoreClient.ListLocationsPagedResponse listLocations(com.google.cloud.location.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); } }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
listLocationsPagedCallable
public final com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.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); } }
-
listLocationsCallable
public final com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.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; } } }
-
getLocation
public final com.google.cloud.location.Location getLocation(com.google.cloud.location.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); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
getLocationCallable
public final com.google.api.gax.rpc.UnaryCallable<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.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(); }
-
setIamPolicy
public final com.google.iam.v1.Policy setIamPolicy(com.google.iam.v1.SetIamPolicyRequest request)
Sets the access control policy on the specified resource. Replacesany existing policy.Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED`errors.
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); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
setIamPolicyCallable
public final com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy> setIamPolicyCallable()
Sets the access control policy on the specified resource. Replacesany existing policy.Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED`errors.
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(); }
-
getIamPolicy
public final com.google.iam.v1.Policy getIamPolicy(com.google.iam.v1.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); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
getIamPolicyCallable
public final com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.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(); }
-
testIamPermissions
public final com.google.iam.v1.TestIamPermissionsResponse testIamPermissions(com.google.iam.v1.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); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
testIamPermissionsCallable
public final com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.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(); }
-
close
public final void close()
- Specified by:
close
in interfaceAutoCloseable
-
shutdown
public void shutdown()
- Specified by:
shutdown
in interfacecom.google.api.gax.core.BackgroundResource
-
isShutdown
public boolean isShutdown()
- Specified by:
isShutdown
in interfacecom.google.api.gax.core.BackgroundResource
-
isTerminated
public boolean isTerminated()
- Specified by:
isTerminated
in interfacecom.google.api.gax.core.BackgroundResource
-
shutdownNow
public void shutdownNow()
- Specified by:
shutdownNow
in interfacecom.google.api.gax.core.BackgroundResource
-
awaitTermination
public boolean awaitTermination(long duration, TimeUnit unit) throws InterruptedException
- Specified by:
awaitTermination
in interfacecom.google.api.gax.core.BackgroundResource
- Throws:
InterruptedException
-
-