Package com.google.cloud.bigquery.biglake.v1alpha1

Class MetastoreServiceClient

java.lang.Object
com.google.cloud.bigquery.biglake.v1alpha1.MetastoreServiceClient
All Implemented Interfaces:
BackgroundResource, AutoCloseable
@BetaApi @Generated("by gapic-generator-java") public class MetastoreServiceClient extends Object implements BackgroundResource
Service Description: BigLake Metastore is a serverless, highly available, multi-tenant runtime metastore for Google Cloud Data Analytics products.

The BigLake Metastore API defines the following resource model:

  • A collection of Google Cloud projects: `/projects/*`
  • Each project has a collection of available locations: `/locations/*`
  • Each location has a collection of catalogs: `/catalogs/*`
  • Each catalog has a collection of databases: `/databases/*`
  • Each database has a collection of tables: `/tables/*`

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


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (MetastoreServiceClient metastoreServiceClient = MetastoreServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   Catalog catalog = Catalog.newBuilder().build();
   String catalogId = "catalogId1455933204";
   Catalog response = metastoreServiceClient.createCatalog(parent, catalog, catalogId);
 }

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

Methods
Method Description Method Variants

CreateCatalog

Creates a new catalog.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • createCatalog(CreateCatalogRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • createCatalog(LocationName parent, Catalog catalog, String catalogId)

  • createCatalog(String parent, Catalog catalog, String catalogId)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • createCatalogCallable()

DeleteCatalog

Deletes an existing catalog specified by the catalog ID.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deleteCatalog(DeleteCatalogRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • deleteCatalog(CatalogName name)

  • deleteCatalog(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • deleteCatalogCallable()

GetCatalog

Gets the catalog specified by the resource name.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getCatalog(GetCatalogRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getCatalog(CatalogName name)

  • getCatalog(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getCatalogCallable()

ListCatalogs

List all catalogs in a specified project.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listCatalogs(ListCatalogsRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listCatalogs(LocationName parent)

  • listCatalogs(String parent)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listCatalogsPagedCallable()

  • listCatalogsCallable()

CreateDatabase

Creates a new database.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • createDatabase(CreateDatabaseRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • createDatabase(CatalogName parent, Database database, String databaseId)

  • createDatabase(String parent, Database database, String databaseId)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • createDatabaseCallable()

DeleteDatabase

Deletes an existing database specified by the database ID.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deleteDatabase(DeleteDatabaseRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • deleteDatabase(DatabaseName name)

  • deleteDatabase(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • deleteDatabaseCallable()

UpdateDatabase

Updates an existing database specified by the database ID.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • updateDatabase(UpdateDatabaseRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • updateDatabase(Database database, FieldMask updateMask)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • updateDatabaseCallable()

GetDatabase

Gets the database specified by the resource name.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getDatabase(GetDatabaseRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getDatabase(DatabaseName name)

  • getDatabase(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getDatabaseCallable()

ListDatabases

List all databases in a specified catalog.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listDatabases(ListDatabasesRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listDatabases(CatalogName parent)

  • listDatabases(String parent)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listDatabasesPagedCallable()

  • listDatabasesCallable()

CreateTable

Creates a new table.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • createTable(CreateTableRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • createTable(DatabaseName parent, Table table, String tableId)

  • createTable(String parent, Table table, String tableId)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • createTableCallable()

DeleteTable

Deletes an existing table specified by the table ID.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deleteTable(DeleteTableRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • deleteTable(TableName name)

  • deleteTable(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • deleteTableCallable()

UpdateTable

Updates an existing table specified by the table ID.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • updateTable(UpdateTableRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • updateTable(Table table, FieldMask updateMask)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • updateTableCallable()

RenameTable

Renames an existing table specified by the table ID.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • renameTable(RenameTableRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • renameTable(TableName name, TableName newName)

  • renameTable(TableName name, String newName)

  • renameTable(String name, TableName newName)

  • renameTable(String name, String newName)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • renameTableCallable()

GetTable

Gets the table specified by the resource name.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getTable(GetTableRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getTable(TableName name)

  • getTable(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getTableCallable()

ListTables

List all tables in a specified database.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listTables(ListTablesRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listTables(DatabaseName parent)

  • listTables(String parent)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listTablesPagedCallable()

  • listTablesCallable()

CreateLock

Creates a new lock.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • createLock(CreateLockRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • createLock(DatabaseName parent, Lock lock)

  • createLock(String parent, Lock lock)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • createLockCallable()

DeleteLock

Deletes an existing lock specified by the lock ID.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deleteLock(DeleteLockRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • deleteLock(LockName name)

  • deleteLock(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • deleteLockCallable()

CheckLock

Checks the state of a lock specified by the lock ID.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • checkLock(CheckLockRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • checkLock(LockName name)

  • checkLock(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • checkLockCallable()

ListLocks

List all locks in a specified database.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listLocks(ListLocksRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listLocks(DatabaseName parent)

  • listLocks(String parent)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listLocksPagedCallable()

  • listLocksCallable()

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 MetastoreServiceSettings 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
 MetastoreServiceSettings metastoreServiceSettings =
     MetastoreServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 MetastoreServiceClient metastoreServiceClient =
     MetastoreServiceClient.create(metastoreServiceSettings);

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
 MetastoreServiceSettings metastoreServiceSettings =
     MetastoreServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 MetastoreServiceClient metastoreServiceClient =
     MetastoreServiceClient.create(metastoreServiceSettings);

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
 MetastoreServiceSettings metastoreServiceSettings =
     MetastoreServiceSettings.newHttpJsonBuilder().build();
 MetastoreServiceClient metastoreServiceClient =
     MetastoreServiceClient.create(metastoreServiceSettings);

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

  • Constructor Details

    • MetastoreServiceClient

      protected MetastoreServiceClient(MetastoreServiceSettings settings) throws IOException
      Constructs an instance of MetastoreServiceClient, 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

    • MetastoreServiceClient

      protected MetastoreServiceClient(MetastoreServiceStub stub)

  • Method Details

    • create

      public static final MetastoreServiceClient create() throws IOException
      Constructs an instance of MetastoreServiceClient with default settings.
      Throws:
      IOException

    • create

      public static final MetastoreServiceClient create(MetastoreServiceSettings settings) throws IOException
      Constructs an instance of MetastoreServiceClient, 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 MetastoreServiceClient create(MetastoreServiceStub stub)
      Constructs an instance of MetastoreServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(MetastoreServiceSettings).

    • getSettings

      public final MetastoreServiceSettings getSettings()

    • getStub

      public MetastoreServiceStub getStub()

    • createCatalog

      public final Catalog createCatalog(LocationName parent, Catalog catalog, String catalogId)
      Creates a new catalog.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (MetastoreServiceClient metastoreServiceClient = MetastoreServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   Catalog catalog = Catalog.newBuilder().build();
   String catalogId = "catalogId1455933204";
   Catalog response = metastoreServiceClient.createCatalog(parent, catalog, catalogId);
 }
      Parameters:
      parent - Required. The parent resource where this catalog will be created. Format: projects/{project_id_or_number}/locations/{location_id}
      catalog - Required. The catalog to create. The `name` field does not need to be provided.
      catalogId - Required. The ID to use for the catalog, which will become the final component of the catalog's resource name.
      Throws:
      ApiException - if the remote call fails

    • createCatalog

      public final Catalog createCatalog(String parent, Catalog catalog, String catalogId)
      Creates a new catalog.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (MetastoreServiceClient metastoreServiceClient = MetastoreServiceClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   Catalog catalog = Catalog.newBuilder().build();
   String catalogId = "catalogId1455933204";
   Catalog response = metastoreServiceClient.createCatalog(parent, catalog, catalogId);
 }
      Parameters:
      parent - Required. The parent resource where this catalog will be created. Format: projects/{project_id_or_number}/locations/{location_id}
      catalog - Required. The catalog to create. The `name` field does not need to be provided.
      catalogId - Required. The ID to use for the catalog, which will become the final component of the catalog's resource name.
      Throws:
      ApiException - if the remote call fails

    • createCatalog

      public final Catalog createCatalog(CreateCatalogRequest request)
      Creates a new catalog.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (MetastoreServiceClient metastoreServiceClient = MetastoreServiceClient.create()) {
   CreateCatalogRequest request =
       CreateCatalogRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setCatalog(Catalog.newBuilder().build())
           .setCatalogId("catalogId1455933204")
           .build();
   Catalog response = metastoreServiceClient.createCatalog(request);
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • createCatalogCallable

      public final UnaryCallable<CreateCatalogRequest,Catalog> createCatalogCallable()
      Creates a new catalog.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (MetastoreServiceClient metastoreServiceClient = MetastoreServiceClient.create()) {
   CreateCatalogRequest request =
       CreateCatalogRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setCatalog(Catalog.newBuilder().build())
           .setCatalogId("catalogId1455933204")
           .build();
   ApiFuture<Catalog> future =
       metastoreServiceClient.createCatalogCallable().futureCall(request);
   // Do something.
   Catalog response = future.get();
 }

    • deleteCatalog

      public final Catalog deleteCatalog(CatalogName name)
      Deletes an existing catalog specified by the catalog ID.

      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 (MetastoreServiceClient metastoreServiceClient = MetastoreServiceClient.create()) {
   CatalogName name = CatalogName.of("[PROJECT]", "[LOCATION]", "[CATALOG]");
   Catalog response = metastoreServiceClient.deleteCatalog(name);
 }
      Parameters:
      name - Required. The name of the catalog to delete. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}
      Throws:
      ApiException - if the remote call fails

    • deleteCatalog

      public final Catalog deleteCatalog(String name)
      Deletes an existing catalog specified by the catalog ID.

      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 (MetastoreServiceClient metastoreServiceClient = MetastoreServiceClient.create()) {
   String name = CatalogName.of("[PROJECT]", "[LOCATION]", "[CATALOG]").toString();
   Catalog response = metastoreServiceClient.deleteCatalog(name);
 }
      Parameters:
      name - Required. The name of the catalog to delete. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}
      Throws:
      ApiException - if the remote call fails

    • deleteCatalog

      public final Catalog deleteCatalog(DeleteCatalogRequest request)
      Deletes an existing catalog specified by the catalog ID.

      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 (MetastoreServiceClient metastoreServiceClient = MetastoreServiceClient.create()) {
   DeleteCatalogRequest request =
       DeleteCatalogRequest.newBuilder()
           .setName(CatalogName.of("[PROJECT]", "[LOCATION]", "[CATALOG]").toString())
           .build();
   Catalog response = metastoreServiceClient.deleteCatalog(request);
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • deleteCatalogCallable

      public final UnaryCallable<DeleteCatalogRequest,Catalog> deleteCatalogCallable()
      Deletes an existing catalog specified by the catalog ID.

      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 (MetastoreServiceClient metastoreServiceClient = MetastoreServiceClient.create()) {
   DeleteCatalogRequest request =
       DeleteCatalogRequest.newBuilder()
           .setName(CatalogName.of("[PROJECT]", "[LOCATION]", "[CATALOG]").toString())
           .build();
   ApiFuture<Catalog> future =
       metastoreServiceClient.deleteCatalogCallable().futureCall(request);
   // Do something.
   Catalog response = future.get();
 }

    • getCatalog

      public final Catalog getCatalog(CatalogName name)
      Gets the catalog specified by the resource name.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (MetastoreServiceClient metastoreServiceClient = MetastoreServiceClient.create()) {
   CatalogName name = CatalogName.of("[PROJECT]", "[LOCATION]", "[CATALOG]");
   Catalog response = metastoreServiceClient.getCatalog(name);
 }
      Parameters:
      name - Required. The name of the catalog to retrieve. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}
      Throws:
      ApiException - if the remote call fails

    • getCatalog

      public final Catalog getCatalog(String name)
      Gets the catalog specified by the resource name.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (MetastoreServiceClient metastoreServiceClient = MetastoreServiceClient.create()) {
   String name = CatalogName.of("[PROJECT]", "[LOCATION]", "[CATALOG]").toString();
   Catalog response = metastoreServiceClient.getCatalog(name);
 }
      Parameters:
      name - Required. The name of the catalog to retrieve. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}
      Throws:
      ApiException - if the remote call fails

    • getCatalog

      public final Catalog getCatalog(GetCatalogRequest request)
      Gets the catalog specified by the resource name.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (MetastoreServiceClient metastoreServiceClient = MetastoreServiceClient.create()) {
   GetCatalogRequest request =
       GetCatalogRequest.newBuilder()
           .setName(CatalogName.of("[PROJECT]", "[LOCATION]", "[CATALOG]").toString())
           .build();
   Catalog response = metastoreServiceClient.getCatalog(request);
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • getCatalogCallable

      public final UnaryCallable<GetCatalogRequest,Catalog> getCatalogCallable()
      Gets the catalog specified by the resource name.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (MetastoreServiceClient metastoreServiceClient = MetastoreServiceClient.create()) {
   GetCatalogRequest request =
       GetCatalogRequest.newBuilder()
           .setName(CatalogName.of("[PROJECT]", "[LOCATION]", "[CATALOG]").toString())
           .build();
   ApiFuture<Catalog> future = metastoreServiceClient.getCatalogCallable().futureCall(request);
   // Do something.
   Catalog response = future.get();
 }

    • listCatalogs

      public final MetastoreServiceClient.ListCatalogsPagedResponse listCatalogs(LocationName parent)
      List all catalogs in a specified project.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (MetastoreServiceClient metastoreServiceClient = MetastoreServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (Catalog element : metastoreServiceClient.listCatalogs(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
      Parameters:
      parent - Required. The parent, which owns this collection of catalogs. Format: projects/{project_id_or_number}/locations/{location_id}
      Throws:
      ApiException - if the remote call fails

    • listCatalogs

      public final MetastoreServiceClient.ListCatalogsPagedResponse listCatalogs(String parent)
      List all catalogs in a specified project.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (MetastoreServiceClient metastoreServiceClient = MetastoreServiceClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   for (Catalog element : metastoreServiceClient.listCatalogs(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
      Parameters:
      parent - Required. The parent, which owns this collection of catalogs. Format: projects/{project_id_or_number}/locations/{location_id}
      Throws:
      ApiException - if the remote call fails

    • listCatalogs

      public final MetastoreServiceClient.ListCatalogsPagedResponse listCatalogs(ListCatalogsRequest request)
      List all catalogs in a specified project.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (MetastoreServiceClient metastoreServiceClient = MetastoreServiceClient.create()) {
   ListCatalogsRequest request =
       ListCatalogsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (Catalog element : metastoreServiceClient.listCatalogs(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • listCatalogsPagedCallable

      public final UnaryCallable<ListCatalogsRequest,MetastoreServiceClient.ListCatalogsPagedResponse> listCatalogsPagedCallable()
      List all catalogs in a specified project.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (MetastoreServiceClient metastoreServiceClient = MetastoreServiceClient.create()) {
   ListCatalogsRequest request =
       ListCatalogsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<Catalog> future =
       metastoreServiceClient.listCatalogsPagedCallable().futureCall(request);
   // Do something.
   for (Catalog element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

    • listCatalogsCallable

      public final UnaryCallable<ListCatalogsRequest,ListCatalogsResponse> listCatalogsCallable()
      List all catalogs in a specified project.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (MetastoreServiceClient metastoreServiceClient = MetastoreServiceClient.create()) {
   ListCatalogsRequest request =
       ListCatalogsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListCatalogsResponse response = metastoreServiceClient.listCatalogsCallable().call(request);
     for (Catalog element : response.getCatalogsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

    • createDatabase

      public final Database createDatabase(CatalogName parent, Database database, String databaseId)
      Creates a new database.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (MetastoreServiceClient metastoreServiceClient = MetastoreServiceClient.create()) {
   CatalogName parent = CatalogName.of("[PROJECT]", "[LOCATION]", "[CATALOG]");
   Database database = Database.newBuilder().build();
   String databaseId = "databaseId1688905718";
   Database response = metastoreServiceClient.createDatabase(parent, database, databaseId);
 }
      Parameters:
      parent - Required. The parent resource where this database will be created. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}
      database - Required. The database to create. The `name` field does not need to be provided.
      databaseId - Required. The ID to use for the database, which will become the final component of the database's resource name.
      Throws:
      ApiException - if the remote call fails

    • createDatabase

      public final Database createDatabase(String parent, Database database, String databaseId)
      Creates a new database.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (MetastoreServiceClient metastoreServiceClient = MetastoreServiceClient.create()) {
   String parent = CatalogName.of("[PROJECT]", "[LOCATION]", "[CATALOG]").toString();
   Database database = Database.newBuilder().build();
   String databaseId = "databaseId1688905718";
   Database response = metastoreServiceClient.createDatabase(parent, database, databaseId);
 }
      Parameters:
      parent - Required. The parent resource where this database will be created. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}
      database - Required. The database to create. The `name` field does not need to be provided.
      databaseId - Required. The ID to use for the database, which will become the final component of the database's resource name.
      Throws:
      ApiException - if the remote call fails

    • createDatabase

      public final Database createDatabase(CreateDatabaseRequest request)
      Creates a new database.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (MetastoreServiceClient metastoreServiceClient = MetastoreServiceClient.create()) {
   CreateDatabaseRequest request =
       CreateDatabaseRequest.newBuilder()
           .setParent(CatalogName.of("[PROJECT]", "[LOCATION]", "[CATALOG]").toString())
           .setDatabase(Database.newBuilder().build())
           .setDatabaseId("databaseId1688905718")
           .build();
   Database response = metastoreServiceClient.createDatabase(request);
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • createDatabaseCallable

      public final UnaryCallable<CreateDatabaseRequest,Database> createDatabaseCallable()
      Creates a new database.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (MetastoreServiceClient metastoreServiceClient = MetastoreServiceClient.create()) {
   CreateDatabaseRequest request =
       CreateDatabaseRequest.newBuilder()
           .setParent(CatalogName.of("[PROJECT]", "[LOCATION]", "[CATALOG]").toString())
           .setDatabase(Database.newBuilder().build())
           .setDatabaseId("databaseId1688905718")
           .build();
   ApiFuture<Database> future =
       metastoreServiceClient.createDatabaseCallable().futureCall(request);
   // Do something.
   Database response = future.get();
 }

    • deleteDatabase

      public final Database deleteDatabase(DatabaseName name)
      Deletes an existing database specified by the database ID.

      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 (MetastoreServiceClient metastoreServiceClient = MetastoreServiceClient.create()) {
   DatabaseName name = DatabaseName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[DATABASE]");
   Database response = metastoreServiceClient.deleteDatabase(name);
 }
      Parameters:
      name - Required. The name of the database to delete. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}/databases/{database_id}
      Throws:
      ApiException - if the remote call fails

    • deleteDatabase

      public final Database deleteDatabase(String name)
      Deletes an existing database specified by the database ID.

      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 (MetastoreServiceClient metastoreServiceClient = MetastoreServiceClient.create()) {
   String name =
       DatabaseName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[DATABASE]").toString();
   Database response = metastoreServiceClient.deleteDatabase(name);
 }
      Parameters:
      name - Required. The name of the database to delete. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}/databases/{database_id}
      Throws:
      ApiException - if the remote call fails

    • deleteDatabase

      public final Database deleteDatabase(DeleteDatabaseRequest request)
      Deletes an existing database specified by the database ID.

      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 (MetastoreServiceClient metastoreServiceClient = MetastoreServiceClient.create()) {
   DeleteDatabaseRequest request =
       DeleteDatabaseRequest.newBuilder()
           .setName(
               DatabaseName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[DATABASE]").toString())
           .build();
   Database response = metastoreServiceClient.deleteDatabase(request);
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • deleteDatabaseCallable

      public final UnaryCallable<DeleteDatabaseRequest,Database> deleteDatabaseCallable()
      Deletes an existing database specified by the database ID.

      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 (MetastoreServiceClient metastoreServiceClient = MetastoreServiceClient.create()) {
   DeleteDatabaseRequest request =
       DeleteDatabaseRequest.newBuilder()
           .setName(
               DatabaseName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[DATABASE]").toString())
           .build();
   ApiFuture<Database> future =
       metastoreServiceClient.deleteDatabaseCallable().futureCall(request);
   // Do something.
   Database response = future.get();
 }

    • updateDatabase

      public final Database updateDatabase(Database database, com.google.protobuf.FieldMask updateMask)
      Updates an existing database specified by the database ID.

      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 (MetastoreServiceClient metastoreServiceClient = MetastoreServiceClient.create()) {
   Database database = Database.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   Database response = metastoreServiceClient.updateDatabase(database, updateMask);
 }
      Parameters:
      database - Required. The database to update.

      The database's `name` field is used to identify the database to update. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}/databases/{database_id}

      updateMask - The list of fields to update.

      For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask If not set, defaults to all of the fields that are allowed to update.

      Throws:
      ApiException - if the remote call fails

    • updateDatabase

      public final Database updateDatabase(UpdateDatabaseRequest request)
      Updates an existing database specified by the database ID.

      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 (MetastoreServiceClient metastoreServiceClient = MetastoreServiceClient.create()) {
   UpdateDatabaseRequest request =
       UpdateDatabaseRequest.newBuilder()
           .setDatabase(Database.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   Database response = metastoreServiceClient.updateDatabase(request);
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • updateDatabaseCallable

      public final UnaryCallable<UpdateDatabaseRequest,Database> updateDatabaseCallable()
      Updates an existing database specified by the database ID.

      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 (MetastoreServiceClient metastoreServiceClient = MetastoreServiceClient.create()) {
   UpdateDatabaseRequest request =
       UpdateDatabaseRequest.newBuilder()
           .setDatabase(Database.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<Database> future =
       metastoreServiceClient.updateDatabaseCallable().futureCall(request);
   // Do something.
   Database response = future.get();
 }

    • getDatabase

      public final Database getDatabase(DatabaseName name)
      Gets the database specified by the resource name.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (MetastoreServiceClient metastoreServiceClient = MetastoreServiceClient.create()) {
   DatabaseName name = DatabaseName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[DATABASE]");
   Database response = metastoreServiceClient.getDatabase(name);
 }
      Parameters:
      name - Required. The name of the database to retrieve. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}/databases/{database_id}
      Throws:
      ApiException - if the remote call fails

    • getDatabase

      public final Database getDatabase(String name)
      Gets the database specified by the resource name.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (MetastoreServiceClient metastoreServiceClient = MetastoreServiceClient.create()) {
   String name =
       DatabaseName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[DATABASE]").toString();
   Database response = metastoreServiceClient.getDatabase(name);
 }
      Parameters:
      name - Required. The name of the database to retrieve. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}/databases/{database_id}
      Throws:
      ApiException - if the remote call fails

    • getDatabase

      public final Database getDatabase(GetDatabaseRequest request)
      Gets the database specified by the resource name.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (MetastoreServiceClient metastoreServiceClient = MetastoreServiceClient.create()) {
   GetDatabaseRequest request =
       GetDatabaseRequest.newBuilder()
           .setName(
               DatabaseName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[DATABASE]").toString())
           .build();
   Database response = metastoreServiceClient.getDatabase(request);
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • getDatabaseCallable

      public final UnaryCallable<GetDatabaseRequest,Database> getDatabaseCallable()
      Gets the database specified by the resource name.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (MetastoreServiceClient metastoreServiceClient = MetastoreServiceClient.create()) {
   GetDatabaseRequest request =
       GetDatabaseRequest.newBuilder()
           .setName(
               DatabaseName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[DATABASE]").toString())
           .build();
   ApiFuture<Database> future = metastoreServiceClient.getDatabaseCallable().futureCall(request);
   // Do something.
   Database response = future.get();
 }

    • listDatabases

      public final MetastoreServiceClient.ListDatabasesPagedResponse listDatabases(CatalogName parent)
      List all databases in a specified catalog.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (MetastoreServiceClient metastoreServiceClient = MetastoreServiceClient.create()) {
   CatalogName parent = CatalogName.of("[PROJECT]", "[LOCATION]", "[CATALOG]");
   for (Database element : metastoreServiceClient.listDatabases(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
      Parameters:
      parent - Required. The parent, which owns this collection of databases. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}
      Throws:
      ApiException - if the remote call fails

    • listDatabases

      public final MetastoreServiceClient.ListDatabasesPagedResponse listDatabases(String parent)
      List all databases in a specified catalog.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (MetastoreServiceClient metastoreServiceClient = MetastoreServiceClient.create()) {
   String parent = CatalogName.of("[PROJECT]", "[LOCATION]", "[CATALOG]").toString();
   for (Database element : metastoreServiceClient.listDatabases(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
      Parameters:
      parent - Required. The parent, which owns this collection of databases. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}
      Throws:
      ApiException - if the remote call fails

    • listDatabases

      public final MetastoreServiceClient.ListDatabasesPagedResponse listDatabases(ListDatabasesRequest request)
      List all databases in a specified catalog.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (MetastoreServiceClient metastoreServiceClient = MetastoreServiceClient.create()) {
   ListDatabasesRequest request =
       ListDatabasesRequest.newBuilder()
           .setParent(CatalogName.of("[PROJECT]", "[LOCATION]", "[CATALOG]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (Database element : metastoreServiceClient.listDatabases(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • listDatabasesPagedCallable

      public final UnaryCallable<ListDatabasesRequest,MetastoreServiceClient.ListDatabasesPagedResponse> listDatabasesPagedCallable()
      List all databases in a specified catalog.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (MetastoreServiceClient metastoreServiceClient = MetastoreServiceClient.create()) {
   ListDatabasesRequest request =
       ListDatabasesRequest.newBuilder()
           .setParent(CatalogName.of("[PROJECT]", "[LOCATION]", "[CATALOG]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<Database> future =
       metastoreServiceClient.listDatabasesPagedCallable().futureCall(request);
   // Do something.
   for (Database element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

    • listDatabasesCallable

      public final UnaryCallable<ListDatabasesRequest,ListDatabasesResponse> listDatabasesCallable()
      List all databases in a specified catalog.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (MetastoreServiceClient metastoreServiceClient = MetastoreServiceClient.create()) {
   ListDatabasesRequest request =
       ListDatabasesRequest.newBuilder()
           .setParent(CatalogName.of("[PROJECT]", "[LOCATION]", "[CATALOG]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListDatabasesResponse response =
         metastoreServiceClient.listDatabasesCallable().call(request);
     for (Database element : response.getDatabasesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

    • createTable

      public final Table createTable(DatabaseName parent, Table table, String tableId)
      Creates a new table.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (MetastoreServiceClient metastoreServiceClient = MetastoreServiceClient.create()) {
   DatabaseName parent = DatabaseName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[DATABASE]");
   Table table = Table.newBuilder().build();
   String tableId = "tableId-1552905847";
   Table response = metastoreServiceClient.createTable(parent, table, tableId);
 }
      Parameters:
      parent - Required. The parent resource where this table will be created. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}/databases/{database_id}
      table - Required. The table to create. The `name` field does not need to be provided for the table creation.
      tableId - Required. The ID to use for the table, which will become the final component of the table's resource name.
      Throws:
      ApiException - if the remote call fails

    • createTable

      public final Table createTable(String parent, Table table, String tableId)
      Creates a new table.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (MetastoreServiceClient metastoreServiceClient = MetastoreServiceClient.create()) {
   String parent =
       DatabaseName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[DATABASE]").toString();
   Table table = Table.newBuilder().build();
   String tableId = "tableId-1552905847";
   Table response = metastoreServiceClient.createTable(parent, table, tableId);
 }
      Parameters:
      parent - Required. The parent resource where this table will be created. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}/databases/{database_id}
      table - Required. The table to create. The `name` field does not need to be provided for the table creation.
      tableId - Required. The ID to use for the table, which will become the final component of the table's resource name.
      Throws:
      ApiException - if the remote call fails

    • createTable

      public final Table createTable(CreateTableRequest request)
      Creates a new table.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (MetastoreServiceClient metastoreServiceClient = MetastoreServiceClient.create()) {
   CreateTableRequest request =
       CreateTableRequest.newBuilder()
           .setParent(
               DatabaseName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[DATABASE]").toString())
           .setTable(Table.newBuilder().build())
           .setTableId("tableId-1552905847")
           .build();
   Table response = metastoreServiceClient.createTable(request);
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • createTableCallable

      public final UnaryCallable<CreateTableRequest,Table> createTableCallable()
      Creates a new table.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (MetastoreServiceClient metastoreServiceClient = MetastoreServiceClient.create()) {
   CreateTableRequest request =
       CreateTableRequest.newBuilder()
           .setParent(
               DatabaseName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[DATABASE]").toString())
           .setTable(Table.newBuilder().build())
           .setTableId("tableId-1552905847")
           .build();
   ApiFuture<Table> future = metastoreServiceClient.createTableCallable().futureCall(request);
   // Do something.
   Table response = future.get();
 }

    • deleteTable

      public final Table deleteTable(TableName name)
      Deletes an existing table specified by the table ID.

      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 (MetastoreServiceClient metastoreServiceClient = MetastoreServiceClient.create()) {
   TableName name =
       TableName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[DATABASE]", "[TABLE]");
   Table response = metastoreServiceClient.deleteTable(name);
 }
      Parameters:
      name - Required. The name of the table to delete. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}/databases/{database_id}/tables/{table_id}
      Throws:
      ApiException - if the remote call fails

    • deleteTable

      public final Table deleteTable(String name)
      Deletes an existing table specified by the table ID.

      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 (MetastoreServiceClient metastoreServiceClient = MetastoreServiceClient.create()) {
   String name =
       TableName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[DATABASE]", "[TABLE]").toString();
   Table response = metastoreServiceClient.deleteTable(name);
 }
      Parameters:
      name - Required. The name of the table to delete. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}/databases/{database_id}/tables/{table_id}
      Throws:
      ApiException - if the remote call fails

    • deleteTable

      public final Table deleteTable(DeleteTableRequest request)
      Deletes an existing table specified by the table ID.

      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 (MetastoreServiceClient metastoreServiceClient = MetastoreServiceClient.create()) {
   DeleteTableRequest request =
       DeleteTableRequest.newBuilder()
           .setName(
               TableName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[DATABASE]", "[TABLE]")
                   .toString())
           .build();
   Table response = metastoreServiceClient.deleteTable(request);
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • deleteTableCallable

      public final UnaryCallable<DeleteTableRequest,Table> deleteTableCallable()
      Deletes an existing table specified by the table ID.

      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 (MetastoreServiceClient metastoreServiceClient = MetastoreServiceClient.create()) {
   DeleteTableRequest request =
       DeleteTableRequest.newBuilder()
           .setName(
               TableName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[DATABASE]", "[TABLE]")
                   .toString())
           .build();
   ApiFuture<Table> future = metastoreServiceClient.deleteTableCallable().futureCall(request);
   // Do something.
   Table response = future.get();
 }

    • updateTable

      public final Table updateTable(Table table, com.google.protobuf.FieldMask updateMask)
      Updates an existing table specified by the table ID.

      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 (MetastoreServiceClient metastoreServiceClient = MetastoreServiceClient.create()) {
   Table table = Table.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   Table response = metastoreServiceClient.updateTable(table, updateMask);
 }
      Parameters:
      table - Required. The table to update.

      The table's `name` field is used to identify the table to update. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}/databases/{database_id}/tables/{table_id}

      updateMask - The list of fields to update.

      For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask If not set, defaults to all of the fields that are allowed to update.

      Throws:
      ApiException - if the remote call fails

    • updateTable

      public final Table updateTable(UpdateTableRequest request)
      Updates an existing table specified by the table ID.

      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 (MetastoreServiceClient metastoreServiceClient = MetastoreServiceClient.create()) {
   UpdateTableRequest request =
       UpdateTableRequest.newBuilder()
           .setTable(Table.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   Table response = metastoreServiceClient.updateTable(request);
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • updateTableCallable

      public final UnaryCallable<UpdateTableRequest,Table> updateTableCallable()
      Updates an existing table specified by the table ID.

      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 (MetastoreServiceClient metastoreServiceClient = MetastoreServiceClient.create()) {
   UpdateTableRequest request =
       UpdateTableRequest.newBuilder()
           .setTable(Table.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<Table> future = metastoreServiceClient.updateTableCallable().futureCall(request);
   // Do something.
   Table response = future.get();
 }

    • renameTable

      public final Table renameTable(TableName name, TableName newName)
      Renames an existing table specified by the table ID.

      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 (MetastoreServiceClient metastoreServiceClient = MetastoreServiceClient.create()) {
   TableName name =
       TableName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[DATABASE]", "[TABLE]");
   TableName newName =
       TableName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[DATABASE]", "[TABLE]");
   Table response = metastoreServiceClient.renameTable(name, newName);
 }
      Parameters:
      name - Required. The table's `name` field is used to identify the table to rename. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}/databases/{database_id}/tables/{table_id}
      newName - Required. The new `name` for the specified table, must be in the same database. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}/databases/{database_id}/tables/{table_id}
      Throws:
      ApiException - if the remote call fails

    • renameTable

      public final Table renameTable(TableName name, String newName)
      Renames an existing table specified by the table ID.

      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 (MetastoreServiceClient metastoreServiceClient = MetastoreServiceClient.create()) {
   TableName name =
       TableName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[DATABASE]", "[TABLE]");
   String newName =
       TableName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[DATABASE]", "[TABLE]").toString();
   Table response = metastoreServiceClient.renameTable(name, newName);
 }
      Parameters:
      name - Required. The table's `name` field is used to identify the table to rename. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}/databases/{database_id}/tables/{table_id}
      newName - Required. The new `name` for the specified table, must be in the same database. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}/databases/{database_id}/tables/{table_id}
      Throws:
      ApiException - if the remote call fails

    • renameTable

      public final Table renameTable(String name, TableName newName)
      Renames an existing table specified by the table ID.

      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 (MetastoreServiceClient metastoreServiceClient = MetastoreServiceClient.create()) {
   String name =
       TableName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[DATABASE]", "[TABLE]").toString();
   TableName newName =
       TableName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[DATABASE]", "[TABLE]");
   Table response = metastoreServiceClient.renameTable(name, newName);
 }
      Parameters:
      name - Required. The table's `name` field is used to identify the table to rename. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}/databases/{database_id}/tables/{table_id}
      newName - Required. The new `name` for the specified table, must be in the same database. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}/databases/{database_id}/tables/{table_id}
      Throws:
      ApiException - if the remote call fails

    • renameTable

      public final Table renameTable(String name, String newName)
      Renames an existing table specified by the table ID.

      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 (MetastoreServiceClient metastoreServiceClient = MetastoreServiceClient.create()) {
   String name =
       TableName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[DATABASE]", "[TABLE]").toString();
   String newName =
       TableName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[DATABASE]", "[TABLE]").toString();
   Table response = metastoreServiceClient.renameTable(name, newName);
 }
      Parameters:
      name - Required. The table's `name` field is used to identify the table to rename. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}/databases/{database_id}/tables/{table_id}
      newName - Required. The new `name` for the specified table, must be in the same database. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}/databases/{database_id}/tables/{table_id}
      Throws:
      ApiException - if the remote call fails

    • renameTable

      public final Table renameTable(RenameTableRequest request)
      Renames an existing table specified by the table ID.

      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 (MetastoreServiceClient metastoreServiceClient = MetastoreServiceClient.create()) {
   RenameTableRequest request =
       RenameTableRequest.newBuilder()
           .setName(
               TableName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[DATABASE]", "[TABLE]")
                   .toString())
           .setNewName(
               TableName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[DATABASE]", "[TABLE]")
                   .toString())
           .build();
   Table response = metastoreServiceClient.renameTable(request);
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • renameTableCallable

      public final UnaryCallable<RenameTableRequest,Table> renameTableCallable()
      Renames an existing table specified by the table ID.

      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 (MetastoreServiceClient metastoreServiceClient = MetastoreServiceClient.create()) {
   RenameTableRequest request =
       RenameTableRequest.newBuilder()
           .setName(
               TableName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[DATABASE]", "[TABLE]")
                   .toString())
           .setNewName(
               TableName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[DATABASE]", "[TABLE]")
                   .toString())
           .build();
   ApiFuture<Table> future = metastoreServiceClient.renameTableCallable().futureCall(request);
   // Do something.
   Table response = future.get();
 }

    • getTable

      public final Table getTable(TableName name)
      Gets the table specified by the resource name.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (MetastoreServiceClient metastoreServiceClient = MetastoreServiceClient.create()) {
   TableName name =
       TableName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[DATABASE]", "[TABLE]");
   Table response = metastoreServiceClient.getTable(name);
 }
      Parameters:
      name - Required. The name of the table to retrieve. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}/databases/{database_id}/tables/{table_id}
      Throws:
      ApiException - if the remote call fails

    • getTable

      public final Table getTable(String name)
      Gets the table specified by the resource name.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (MetastoreServiceClient metastoreServiceClient = MetastoreServiceClient.create()) {
   String name =
       TableName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[DATABASE]", "[TABLE]").toString();
   Table response = metastoreServiceClient.getTable(name);
 }
      Parameters:
      name - Required. The name of the table to retrieve. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}/databases/{database_id}/tables/{table_id}
      Throws:
      ApiException - if the remote call fails

    • getTable

      public final Table getTable(GetTableRequest request)
      Gets the table specified by the resource name.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (MetastoreServiceClient metastoreServiceClient = MetastoreServiceClient.create()) {
   GetTableRequest request =
       GetTableRequest.newBuilder()
           .setName(
               TableName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[DATABASE]", "[TABLE]")
                   .toString())
           .build();
   Table response = metastoreServiceClient.getTable(request);
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • getTableCallable

      public final UnaryCallable<GetTableRequest,Table> getTableCallable()
      Gets the table specified by the resource name.

      Sample code: 

      
 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (MetastoreServiceClient metastoreServiceClient = MetastoreServiceClient.create()) {
   GetTableRequest request =
       GetTableRequest.newBuilder()
           .setName(
               TableName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[DATABASE]", "[TABLE]")
                   .toString())
           .build();
   ApiFuture<Table> future = metastoreServiceClient.getTableCallable().futureCall(request);
   // Do something.
   Table response = future.get();
 }

    • listTables

      public final MetastoreServiceClient.ListTablesPagedResponse listTables(DatabaseName parent)
      List all tables in a specified 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 (MetastoreServiceClient metastoreServiceClient = MetastoreServiceClient.create()) {
   DatabaseName parent = DatabaseName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[DATABASE]");
   for (Table element : metastoreServiceClient.listTables(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
      Parameters:
      parent - Required. The parent, which owns this collection of tables. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}/databases/{database_id}
      Throws:
      ApiException - if the remote call fails

    • listTables

      public final MetastoreServiceClient.ListTablesPagedResponse listTables(String parent)
      List all tables in a specified 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 (MetastoreServiceClient metastoreServiceClient = MetastoreServiceClient.create()) {
   String parent =
       DatabaseName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[DATABASE]").toString();
   for (Table element : metastoreServiceClient.listTables(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
      Parameters:
      parent - Required. The parent, which owns this collection of tables. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}/databases/{database_id}
      Throws:
      ApiException - if the remote call fails

    • listTables

      public final MetastoreServiceClient.ListTablesPagedResponse listTables(ListTablesRequest request)
      List all tables in a specified 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 (MetastoreServiceClient metastoreServiceClient = MetastoreServiceClient.create()) {
   ListTablesRequest request =
       ListTablesRequest.newBuilder()
           .setParent(
               DatabaseName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[DATABASE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setView(TableView.forNumber(0))
           .build();
   for (Table element : metastoreServiceClient.listTables(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • listTablesPagedCallable

      public final UnaryCallable<ListTablesRequest,MetastoreServiceClient.ListTablesPagedResponse> listTablesPagedCallable()
      List all tables in a specified 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 (MetastoreServiceClient metastoreServiceClient = MetastoreServiceClient.create()) {
   ListTablesRequest request =
       ListTablesRequest.newBuilder()
           .setParent(
               DatabaseName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[DATABASE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setView(TableView.forNumber(0))
           .build();
   ApiFuture<Table> future =
       metastoreServiceClient.listTablesPagedCallable().futureCall(request);
   // Do something.
   for (Table element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

    • listTablesCallable

      public final UnaryCallable<ListTablesRequest,ListTablesResponse> listTablesCallable()
      List all tables in a specified 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 (MetastoreServiceClient metastoreServiceClient = MetastoreServiceClient.create()) {
   ListTablesRequest request =
       ListTablesRequest.newBuilder()
           .setParent(
               DatabaseName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[DATABASE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setView(TableView.forNumber(0))
           .build();
   while (true) {
     ListTablesResponse response = metastoreServiceClient.listTablesCallable().call(request);
     for (Table element : response.getTablesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

    • createLock

      public final Lock createLock(DatabaseName parent, Lock lock)
      Creates a new lock.

      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 (MetastoreServiceClient metastoreServiceClient = MetastoreServiceClient.create()) {
   DatabaseName parent = DatabaseName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[DATABASE]");
   Lock lock = Lock.newBuilder().build();
   Lock response = metastoreServiceClient.createLock(parent, lock);
 }
      Parameters:
      parent - Required. The parent resource where this lock will be created. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}/databases/{database_id}
      lock - Required. The lock to create. The `name` field does not need to be provided for the lock creation.
      Throws:
      ApiException - if the remote call fails

    • createLock

      public final Lock createLock(String parent, Lock lock)
      Creates a new lock.

      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 (MetastoreServiceClient metastoreServiceClient = MetastoreServiceClient.create()) {
   String parent =
       DatabaseName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[DATABASE]").toString();
   Lock lock = Lock.newBuilder().build();
   Lock response = metastoreServiceClient.createLock(parent, lock);
 }
      Parameters:
      parent - Required. The parent resource where this lock will be created. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}/databases/{database_id}
      lock - Required. The lock to create. The `name` field does not need to be provided for the lock creation.
      Throws:
      ApiException - if the remote call fails

    • createLock

      public final Lock createLock(CreateLockRequest request)
      Creates a new lock.

      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 (MetastoreServiceClient metastoreServiceClient = MetastoreServiceClient.create()) {
   CreateLockRequest request =
       CreateLockRequest.newBuilder()
           .setParent(
               DatabaseName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[DATABASE]").toString())
           .setLock(Lock.newBuilder().build())
           .build();
   Lock response = metastoreServiceClient.createLock(request);
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • createLockCallable

      public final UnaryCallable<CreateLockRequest,Lock> createLockCallable()
      Creates a new lock.

      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 (MetastoreServiceClient metastoreServiceClient = MetastoreServiceClient.create()) {
   CreateLockRequest request =
       CreateLockRequest.newBuilder()
           .setParent(
               DatabaseName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[DATABASE]").toString())
           .setLock(Lock.newBuilder().build())
           .build();
   ApiFuture<Lock> future = metastoreServiceClient.createLockCallable().futureCall(request);
   // Do something.
   Lock response = future.get();
 }

    • deleteLock

      public final void deleteLock(LockName name)
      Deletes an existing lock specified by the lock ID.

      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 (MetastoreServiceClient metastoreServiceClient = MetastoreServiceClient.create()) {
   LockName name = LockName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[DATABASE]", "[LOCK]");
   metastoreServiceClient.deleteLock(name);
 }
      Parameters:
      name - Required. The name of the lock to delete. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}/databases/{database_id}/locks/{lock_id}
      Throws:
      ApiException - if the remote call fails

    • deleteLock

      public final void deleteLock(String name)
      Deletes an existing lock specified by the lock ID.

      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 (MetastoreServiceClient metastoreServiceClient = MetastoreServiceClient.create()) {
   String name =
       LockName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[DATABASE]", "[LOCK]").toString();
   metastoreServiceClient.deleteLock(name);
 }
      Parameters:
      name - Required. The name of the lock to delete. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}/databases/{database_id}/locks/{lock_id}
      Throws:
      ApiException - if the remote call fails

    • deleteLock

      public final void deleteLock(DeleteLockRequest request)
      Deletes an existing lock specified by the lock ID.

      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 (MetastoreServiceClient metastoreServiceClient = MetastoreServiceClient.create()) {
   DeleteLockRequest request =
       DeleteLockRequest.newBuilder()
           .setName(
               LockName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[DATABASE]", "[LOCK]")
                   .toString())
           .build();
   metastoreServiceClient.deleteLock(request);
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • deleteLockCallable

      public final UnaryCallable<DeleteLockRequest,com.google.protobuf.Empty> deleteLockCallable()
      Deletes an existing lock specified by the lock ID.

      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 (MetastoreServiceClient metastoreServiceClient = MetastoreServiceClient.create()) {
   DeleteLockRequest request =
       DeleteLockRequest.newBuilder()
           .setName(
               LockName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[DATABASE]", "[LOCK]")
                   .toString())
           .build();
   ApiFuture<Empty> future = metastoreServiceClient.deleteLockCallable().futureCall(request);
   // Do something.
   future.get();
 }

    • checkLock

      public final Lock checkLock(LockName name)
      Checks the state of a lock specified by the lock ID.

      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 (MetastoreServiceClient metastoreServiceClient = MetastoreServiceClient.create()) {
   LockName name = LockName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[DATABASE]", "[LOCK]");
   Lock response = metastoreServiceClient.checkLock(name);
 }
      Parameters:
      name - Required. The name of the lock to check. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}/databases/{database_id}/locks/{lock_id}
      Throws:
      ApiException - if the remote call fails

    • checkLock

      public final Lock checkLock(String name)
      Checks the state of a lock specified by the lock ID.

      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 (MetastoreServiceClient metastoreServiceClient = MetastoreServiceClient.create()) {
   String name =
       LockName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[DATABASE]", "[LOCK]").toString();
   Lock response = metastoreServiceClient.checkLock(name);
 }
      Parameters:
      name - Required. The name of the lock to check. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}/databases/{database_id}/locks/{lock_id}
      Throws:
      ApiException - if the remote call fails

    • checkLock

      public final Lock checkLock(CheckLockRequest request)
      Checks the state of a lock specified by the lock ID.

      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 (MetastoreServiceClient metastoreServiceClient = MetastoreServiceClient.create()) {
   CheckLockRequest request =
       CheckLockRequest.newBuilder()
           .setName(
               LockName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[DATABASE]", "[LOCK]")
                   .toString())
           .build();
   Lock response = metastoreServiceClient.checkLock(request);
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • checkLockCallable

      public final UnaryCallable<CheckLockRequest,Lock> checkLockCallable()
      Checks the state of a lock specified by the lock ID.

      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 (MetastoreServiceClient metastoreServiceClient = MetastoreServiceClient.create()) {
   CheckLockRequest request =
       CheckLockRequest.newBuilder()
           .setName(
               LockName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[DATABASE]", "[LOCK]")
                   .toString())
           .build();
   ApiFuture<Lock> future = metastoreServiceClient.checkLockCallable().futureCall(request);
   // Do something.
   Lock response = future.get();
 }

    • listLocks

      public final MetastoreServiceClient.ListLocksPagedResponse listLocks(DatabaseName parent)
      List all locks in a specified 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 (MetastoreServiceClient metastoreServiceClient = MetastoreServiceClient.create()) {
   DatabaseName parent = DatabaseName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[DATABASE]");
   for (Lock element : metastoreServiceClient.listLocks(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
      Parameters:
      parent - Required. The parent, which owns this collection of locks. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}/databases/{database_id}
      Throws:
      ApiException - if the remote call fails

    • listLocks

      public final MetastoreServiceClient.ListLocksPagedResponse listLocks(String parent)
      List all locks in a specified 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 (MetastoreServiceClient metastoreServiceClient = MetastoreServiceClient.create()) {
   String parent =
       DatabaseName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[DATABASE]").toString();
   for (Lock element : metastoreServiceClient.listLocks(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
      Parameters:
      parent - Required. The parent, which owns this collection of locks. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}/databases/{database_id}
      Throws:
      ApiException - if the remote call fails

    • listLocks

      public final MetastoreServiceClient.ListLocksPagedResponse listLocks(ListLocksRequest request)
      List all locks in a specified 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 (MetastoreServiceClient metastoreServiceClient = MetastoreServiceClient.create()) {
   ListLocksRequest request =
       ListLocksRequest.newBuilder()
           .setParent(
               DatabaseName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[DATABASE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (Lock element : metastoreServiceClient.listLocks(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • listLocksPagedCallable

      public final UnaryCallable<ListLocksRequest,MetastoreServiceClient.ListLocksPagedResponse> listLocksPagedCallable()
      List all locks in a specified 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 (MetastoreServiceClient metastoreServiceClient = MetastoreServiceClient.create()) {
   ListLocksRequest request =
       ListLocksRequest.newBuilder()
           .setParent(
               DatabaseName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[DATABASE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<Lock> future = metastoreServiceClient.listLocksPagedCallable().futureCall(request);
   // Do something.
   for (Lock element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

    • listLocksCallable

      public final UnaryCallable<ListLocksRequest,ListLocksResponse> listLocksCallable()
      List all locks in a specified 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 (MetastoreServiceClient metastoreServiceClient = MetastoreServiceClient.create()) {
   ListLocksRequest request =
       ListLocksRequest.newBuilder()
           .setParent(
               DatabaseName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[DATABASE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListLocksResponse response = metastoreServiceClient.listLocksCallable().call(request);
     for (Lock element : response.getLocksList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

    • close

      public final void close()
      Specified by:
      close in interface AutoCloseable

    • shutdown

      public void shutdown()
      Specified by:
      shutdown in interface BackgroundResource

    • isShutdown

      public boolean isShutdown()
      Specified by:
      isShutdown in interface BackgroundResource

    • isTerminated

      public boolean isTerminated()
      Specified by:
      isTerminated in interface BackgroundResource

    • shutdownNow

      public void shutdownNow()
      Specified by:
      shutdownNow in interface BackgroundResource

    • awaitTermination

      public boolean awaitTermination(long duration, TimeUnit unit) throws InterruptedException
      Specified by:
      awaitTermination in interface BackgroundResource
      Throws:
      InterruptedException