MetastoreServiceClient (Google BigLake 0.1.0 API)

java.lang.Object
- com.google.cloud.bigquery.biglake.v1alpha1.MetastoreServiceClient

All Implemented Interfaces:: com.google.api.gax.core.BackgroundResource, AutoCloseable

@BetaApi
 @Generated(value="by gapic-generator-java")
public class MetastoreServiceClient
extends Object
implements com.google.api.gax.core.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().

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

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

See the individual methods for example code.

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

This class can be customized by passing in a custom instance of 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.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`MetastoreServiceClient.ListCatalogsFixedSizeCollection`
`static class`	`MetastoreServiceClient.ListCatalogsPage`
`static class`	`MetastoreServiceClient.ListCatalogsPagedResponse`
`static class`	`MetastoreServiceClient.ListDatabasesFixedSizeCollection`
`static class`	`MetastoreServiceClient.ListDatabasesPage`
`static class`	`MetastoreServiceClient.ListDatabasesPagedResponse`
`static class`	`MetastoreServiceClient.ListLocksFixedSizeCollection`
`static class`	`MetastoreServiceClient.ListLocksPage`
`static class`	`MetastoreServiceClient.ListLocksPagedResponse`
`static class`	`MetastoreServiceClient.ListTablesFixedSizeCollection`
`static class`	`MetastoreServiceClient.ListTablesPage`
`static class`	`MetastoreServiceClient.ListTablesPagedResponse`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`MetastoreServiceClient(MetastoreServiceSettings settings)` Constructs an instance of MetastoreServiceClient, using the given settings.
`protected`	`MetastoreServiceClient(MetastoreServiceStub stub)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`awaitTermination(long duration, TimeUnit unit)`
`Lock`	`checkLock(CheckLockRequest request)` Checks the state of a lock specified by the lock ID.
`Lock`	`checkLock(LockName name)` Checks the state of a lock specified by the lock ID.
`Lock`	`checkLock(String name)` Checks the state of a lock specified by the lock ID.
`com.google.api.gax.rpc.UnaryCallable<CheckLockRequest,Lock>`	`checkLockCallable()` Checks the state of a lock specified by the lock ID.
`void`	`close()`
`static MetastoreServiceClient`	`create()` Constructs an instance of MetastoreServiceClient with default settings.
`static MetastoreServiceClient`	`create(MetastoreServiceSettings settings)` Constructs an instance of MetastoreServiceClient, using the given settings.
`static MetastoreServiceClient`	`create(MetastoreServiceStub stub)` Constructs an instance of MetastoreServiceClient, using the given stub for making calls.
`Catalog`	`createCatalog(CreateCatalogRequest request)` Creates a new catalog.
`Catalog`	`createCatalog(LocationName parent, Catalog catalog, String catalogId)` Creates a new catalog.
`Catalog`	`createCatalog(String parent, Catalog catalog, String catalogId)` Creates a new catalog.
`com.google.api.gax.rpc.UnaryCallable<CreateCatalogRequest,Catalog>`	`createCatalogCallable()` Creates a new catalog.
`Database`	`createDatabase(CatalogName parent, Database database, String databaseId)` Creates a new database.
`Database`	`createDatabase(CreateDatabaseRequest request)` Creates a new database.
`Database`	`createDatabase(String parent, Database database, String databaseId)` Creates a new database.
`com.google.api.gax.rpc.UnaryCallable<CreateDatabaseRequest,Database>`	`createDatabaseCallable()` Creates a new database.
`Lock`	`createLock(CreateLockRequest request)` Creates a new lock.
`Lock`	`createLock(DatabaseName parent, Lock lock)` Creates a new lock.
`Lock`	`createLock(String parent, Lock lock)` Creates a new lock.
`com.google.api.gax.rpc.UnaryCallable<CreateLockRequest,Lock>`	`createLockCallable()` Creates a new lock.
`Table`	`createTable(CreateTableRequest request)` Creates a new table.
`Table`	`createTable(DatabaseName parent, Table table, String tableId)` Creates a new table.
`Table`	`createTable(String parent, Table table, String tableId)` Creates a new table.
`com.google.api.gax.rpc.UnaryCallable<CreateTableRequest,Table>`	`createTableCallable()` Creates a new table.
`Catalog`	`deleteCatalog(CatalogName name)` Deletes an existing catalog specified by the catalog ID.
`Catalog`	`deleteCatalog(DeleteCatalogRequest request)` Deletes an existing catalog specified by the catalog ID.
`Catalog`	`deleteCatalog(String name)` Deletes an existing catalog specified by the catalog ID.
`com.google.api.gax.rpc.UnaryCallable<DeleteCatalogRequest,Catalog>`	`deleteCatalogCallable()` Deletes an existing catalog specified by the catalog ID.
`Database`	`deleteDatabase(DatabaseName name)` Deletes an existing database specified by the database ID.
`Database`	`deleteDatabase(DeleteDatabaseRequest request)` Deletes an existing database specified by the database ID.
`Database`	`deleteDatabase(String name)` Deletes an existing database specified by the database ID.
`com.google.api.gax.rpc.UnaryCallable<DeleteDatabaseRequest,Database>`	`deleteDatabaseCallable()` Deletes an existing database specified by the database ID.
`void`	`deleteLock(DeleteLockRequest request)` Deletes an existing lock specified by the lock ID.
`void`	`deleteLock(LockName name)` Deletes an existing lock specified by the lock ID.
`void`	`deleteLock(String name)` Deletes an existing lock specified by the lock ID.
`com.google.api.gax.rpc.UnaryCallable<DeleteLockRequest,com.google.protobuf.Empty>`	`deleteLockCallable()` Deletes an existing lock specified by the lock ID.
`Table`	`deleteTable(DeleteTableRequest request)` Deletes an existing table specified by the table ID.
`Table`	`deleteTable(String name)` Deletes an existing table specified by the table ID.
`Table`	`deleteTable(TableName name)` Deletes an existing table specified by the table ID.
`com.google.api.gax.rpc.UnaryCallable<DeleteTableRequest,Table>`	`deleteTableCallable()` Deletes an existing table specified by the table ID.
`Catalog`	`getCatalog(CatalogName name)` Gets the catalog specified by the resource name.
`Catalog`	`getCatalog(GetCatalogRequest request)` Gets the catalog specified by the resource name.
`Catalog`	`getCatalog(String name)` Gets the catalog specified by the resource name.
`com.google.api.gax.rpc.UnaryCallable<GetCatalogRequest,Catalog>`	`getCatalogCallable()` Gets the catalog specified by the resource name.
`Database`	`getDatabase(DatabaseName name)` Gets the database specified by the resource name.
`Database`	`getDatabase(GetDatabaseRequest request)` Gets the database specified by the resource name.
`Database`	`getDatabase(String name)` Gets the database specified by the resource name.
`com.google.api.gax.rpc.UnaryCallable<GetDatabaseRequest,Database>`	`getDatabaseCallable()` Gets the database specified by the resource name.
`MetastoreServiceSettings`	`getSettings()`
`MetastoreServiceStub`	`getStub()`
`Table`	`getTable(GetTableRequest request)` Gets the table specified by the resource name.
`Table`	`getTable(String name)` Gets the table specified by the resource name.
`Table`	`getTable(TableName name)` Gets the table specified by the resource name.
`com.google.api.gax.rpc.UnaryCallable<GetTableRequest,Table>`	`getTableCallable()` Gets the table specified by the resource name.
`boolean`	`isShutdown()`
`boolean`	`isTerminated()`
`MetastoreServiceClient.ListCatalogsPagedResponse`	`listCatalogs(ListCatalogsRequest request)` List all catalogs in a specified project.
`MetastoreServiceClient.ListCatalogsPagedResponse`	`listCatalogs(LocationName parent)` List all catalogs in a specified project.
`MetastoreServiceClient.ListCatalogsPagedResponse`	`listCatalogs(String parent)` List all catalogs in a specified project.
`com.google.api.gax.rpc.UnaryCallable<ListCatalogsRequest,ListCatalogsResponse>`	`listCatalogsCallable()` List all catalogs in a specified project.
`com.google.api.gax.rpc.UnaryCallable<ListCatalogsRequest,MetastoreServiceClient.ListCatalogsPagedResponse>`	`listCatalogsPagedCallable()` List all catalogs in a specified project.
`MetastoreServiceClient.ListDatabasesPagedResponse`	`listDatabases(CatalogName parent)` List all databases in a specified catalog.
`MetastoreServiceClient.ListDatabasesPagedResponse`	`listDatabases(ListDatabasesRequest request)` List all databases in a specified catalog.
`MetastoreServiceClient.ListDatabasesPagedResponse`	`listDatabases(String parent)` List all databases in a specified catalog.
`com.google.api.gax.rpc.UnaryCallable<ListDatabasesRequest,ListDatabasesResponse>`	`listDatabasesCallable()` List all databases in a specified catalog.
`com.google.api.gax.rpc.UnaryCallable<ListDatabasesRequest,MetastoreServiceClient.ListDatabasesPagedResponse>`	`listDatabasesPagedCallable()` List all databases in a specified catalog.
`MetastoreServiceClient.ListLocksPagedResponse`	`listLocks(DatabaseName parent)` List all locks in a specified database.
`MetastoreServiceClient.ListLocksPagedResponse`	`listLocks(ListLocksRequest request)` List all locks in a specified database.
`MetastoreServiceClient.ListLocksPagedResponse`	`listLocks(String parent)` List all locks in a specified database.
`com.google.api.gax.rpc.UnaryCallable<ListLocksRequest,ListLocksResponse>`	`listLocksCallable()` List all locks in a specified database.
`com.google.api.gax.rpc.UnaryCallable<ListLocksRequest,MetastoreServiceClient.ListLocksPagedResponse>`	`listLocksPagedCallable()` List all locks in a specified database.
`MetastoreServiceClient.ListTablesPagedResponse`	`listTables(DatabaseName parent)` List all tables in a specified database.
`MetastoreServiceClient.ListTablesPagedResponse`	`listTables(ListTablesRequest request)` List all tables in a specified database.
`MetastoreServiceClient.ListTablesPagedResponse`	`listTables(String parent)` List all tables in a specified database.
`com.google.api.gax.rpc.UnaryCallable<ListTablesRequest,ListTablesResponse>`	`listTablesCallable()` List all tables in a specified database.
`com.google.api.gax.rpc.UnaryCallable<ListTablesRequest,MetastoreServiceClient.ListTablesPagedResponse>`	`listTablesPagedCallable()` List all tables in a specified database.
`void`	`shutdown()`
`void`	`shutdownNow()`
`Database`	`updateDatabase(Database database, com.google.protobuf.FieldMask updateMask)` Updates an existing database specified by the database ID.
`Database`	`updateDatabase(UpdateDatabaseRequest request)` Updates an existing database specified by the database ID.
`com.google.api.gax.rpc.UnaryCallable<UpdateDatabaseRequest,Database>`	`updateDatabaseCallable()` Updates an existing database specified by the database ID.
`Table`	`updateTable(Table table, com.google.protobuf.FieldMask updateMask)` Updates an existing table specified by the table ID.
`Table`	`updateTable(UpdateTableRequest request)` Updates an existing table specified by the table ID.
`com.google.api.gax.rpc.UnaryCallable<UpdateTableRequest,Table>`	`updateTableCallable()` Updates an existing table specified by the table ID.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- 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 Detail

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:: com.google.api.gax.rpc.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:: com.google.api.gax.rpc.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:: com.google.api.gax.rpc.ApiException - if the remote call fails

createCatalogCallable

public final com.google.api.gax.rpc.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:: com.google.api.gax.rpc.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:: com.google.api.gax.rpc.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:: com.google.api.gax.rpc.ApiException - if the remote call fails

deleteCatalogCallable

public final com.google.api.gax.rpc.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:: com.google.api.gax.rpc.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:: com.google.api.gax.rpc.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:: com.google.api.gax.rpc.ApiException - if the remote call fails

getCatalogCallable

public final com.google.api.gax.rpc.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();
 }