A client to BigLake API
The interfaces provided are listed below, along with usage samples.
MetastoreServiceClient
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/*
Sample for MetastoreServiceClient:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying 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);
}
Classes
Catalog
Catalog is the container of databases.
Protobuf type google.cloud.bigquery.biglake.v1alpha1.Catalog
Catalog.Builder
Catalog is the container of databases.
Protobuf type google.cloud.bigquery.biglake.v1alpha1.Catalog
CatalogName
CatalogName.Builder
Builder for projects/{project}/locations/{location}/catalogs/{catalog}.
CheckLockRequest
Request message for the CheckLock method.
Protobuf type google.cloud.bigquery.biglake.v1alpha1.CheckLockRequest
CheckLockRequest.Builder
Request message for the CheckLock method.
Protobuf type google.cloud.bigquery.biglake.v1alpha1.CheckLockRequest
CreateCatalogRequest
Request message for the CreateCatalog method.
Protobuf type google.cloud.bigquery.biglake.v1alpha1.CreateCatalogRequest
CreateCatalogRequest.Builder
Request message for the CreateCatalog method.
Protobuf type google.cloud.bigquery.biglake.v1alpha1.CreateCatalogRequest
CreateDatabaseRequest
Request message for the CreateDatabase method.
Protobuf type google.cloud.bigquery.biglake.v1alpha1.CreateDatabaseRequest
CreateDatabaseRequest.Builder
Request message for the CreateDatabase method.
Protobuf type google.cloud.bigquery.biglake.v1alpha1.CreateDatabaseRequest
CreateLockRequest
Request message for the CreateLock method.
Protobuf type google.cloud.bigquery.biglake.v1alpha1.CreateLockRequest
CreateLockRequest.Builder
Request message for the CreateLock method.
Protobuf type google.cloud.bigquery.biglake.v1alpha1.CreateLockRequest
CreateTableRequest
Request message for the CreateTable method.
Protobuf type google.cloud.bigquery.biglake.v1alpha1.CreateTableRequest
CreateTableRequest.Builder
Request message for the CreateTable method.
Protobuf type google.cloud.bigquery.biglake.v1alpha1.CreateTableRequest
Database
Database is the container of tables.
Protobuf type google.cloud.bigquery.biglake.v1alpha1.Database
Database.Builder
Database is the container of tables.
Protobuf type google.cloud.bigquery.biglake.v1alpha1.Database
DatabaseName
DatabaseName.Builder
Builder for projects/{project}/locations/{location}/catalogs/{catalog}/databases/{database}.
DeleteCatalogRequest
Request message for the DeleteCatalog method.
Protobuf type google.cloud.bigquery.biglake.v1alpha1.DeleteCatalogRequest
DeleteCatalogRequest.Builder
Request message for the DeleteCatalog method.
Protobuf type google.cloud.bigquery.biglake.v1alpha1.DeleteCatalogRequest
DeleteDatabaseRequest
Request message for the DeleteDatabase method.
Protobuf type google.cloud.bigquery.biglake.v1alpha1.DeleteDatabaseRequest
DeleteDatabaseRequest.Builder
Request message for the DeleteDatabase method.
Protobuf type google.cloud.bigquery.biglake.v1alpha1.DeleteDatabaseRequest
DeleteLockRequest
Request message for the DeleteLock method.
Protobuf type google.cloud.bigquery.biglake.v1alpha1.DeleteLockRequest
DeleteLockRequest.Builder
Request message for the DeleteLock method.
Protobuf type google.cloud.bigquery.biglake.v1alpha1.DeleteLockRequest
DeleteTableRequest
Request message for the DeleteTable method.
Protobuf type google.cloud.bigquery.biglake.v1alpha1.DeleteTableRequest
DeleteTableRequest.Builder
Request message for the DeleteTable method.
Protobuf type google.cloud.bigquery.biglake.v1alpha1.DeleteTableRequest
GetCatalogRequest
Request message for the GetCatalog method.
Protobuf type google.cloud.bigquery.biglake.v1alpha1.GetCatalogRequest
GetCatalogRequest.Builder
Request message for the GetCatalog method.
Protobuf type google.cloud.bigquery.biglake.v1alpha1.GetCatalogRequest
GetDatabaseRequest
Request message for the GetDatabase method.
Protobuf type google.cloud.bigquery.biglake.v1alpha1.GetDatabaseRequest
GetDatabaseRequest.Builder
Request message for the GetDatabase method.
Protobuf type google.cloud.bigquery.biglake.v1alpha1.GetDatabaseRequest
GetTableRequest
Request message for the GetTable method.
Protobuf type google.cloud.bigquery.biglake.v1alpha1.GetTableRequest
GetTableRequest.Builder
Request message for the GetTable method.
Protobuf type google.cloud.bigquery.biglake.v1alpha1.GetTableRequest
HiveDatabaseOptions
Options of a Hive database.
Protobuf type google.cloud.bigquery.biglake.v1alpha1.HiveDatabaseOptions
HiveDatabaseOptions.Builder
Options of a Hive database.
Protobuf type google.cloud.bigquery.biglake.v1alpha1.HiveDatabaseOptions
HiveTableOptions
Options of a Hive table.
Protobuf type google.cloud.bigquery.biglake.v1alpha1.HiveTableOptions
HiveTableOptions.Builder
Options of a Hive table.
Protobuf type google.cloud.bigquery.biglake.v1alpha1.HiveTableOptions
HiveTableOptions.SerDeInfo
Serializer and deserializer information.
Protobuf type google.cloud.bigquery.biglake.v1alpha1.HiveTableOptions.SerDeInfo
HiveTableOptions.SerDeInfo.Builder
Serializer and deserializer information.
Protobuf type google.cloud.bigquery.biglake.v1alpha1.HiveTableOptions.SerDeInfo
HiveTableOptions.StorageDescriptor
Stores physical storage information of the data.
Protobuf type google.cloud.bigquery.biglake.v1alpha1.HiveTableOptions.StorageDescriptor
HiveTableOptions.StorageDescriptor.Builder
Stores physical storage information of the data.
Protobuf type
google.cloud.bigquery.biglake.v1alpha1.HiveTableOptions.StorageDescriptor
ListCatalogsRequest
Request message for the ListCatalogs method.
Protobuf type google.cloud.bigquery.biglake.v1alpha1.ListCatalogsRequest
ListCatalogsRequest.Builder
Request message for the ListCatalogs method.
Protobuf type google.cloud.bigquery.biglake.v1alpha1.ListCatalogsRequest
ListCatalogsResponse
Response message for the ListCatalogs method.
Protobuf type google.cloud.bigquery.biglake.v1alpha1.ListCatalogsResponse
ListCatalogsResponse.Builder
Response message for the ListCatalogs method.
Protobuf type google.cloud.bigquery.biglake.v1alpha1.ListCatalogsResponse
ListDatabasesRequest
Request message for the ListDatabases method.
Protobuf type google.cloud.bigquery.biglake.v1alpha1.ListDatabasesRequest
ListDatabasesRequest.Builder
Request message for the ListDatabases method.
Protobuf type google.cloud.bigquery.biglake.v1alpha1.ListDatabasesRequest
ListDatabasesResponse
Response message for the ListDatabases method.
Protobuf type google.cloud.bigquery.biglake.v1alpha1.ListDatabasesResponse
ListDatabasesResponse.Builder
Response message for the ListDatabases method.
Protobuf type google.cloud.bigquery.biglake.v1alpha1.ListDatabasesResponse
ListLocksRequest
Request message for the ListLocks method.
Protobuf type google.cloud.bigquery.biglake.v1alpha1.ListLocksRequest
ListLocksRequest.Builder
Request message for the ListLocks method.
Protobuf type google.cloud.bigquery.biglake.v1alpha1.ListLocksRequest
ListLocksResponse
Response message for the ListLocks method.
Protobuf type google.cloud.bigquery.biglake.v1alpha1.ListLocksResponse
ListLocksResponse.Builder
Response message for the ListLocks method.
Protobuf type google.cloud.bigquery.biglake.v1alpha1.ListLocksResponse
ListTablesRequest
Request message for the ListTables method.
Protobuf type google.cloud.bigquery.biglake.v1alpha1.ListTablesRequest
ListTablesRequest.Builder
Request message for the ListTables method.
Protobuf type google.cloud.bigquery.biglake.v1alpha1.ListTablesRequest
ListTablesResponse
Response message for the ListTables method.
Protobuf type google.cloud.bigquery.biglake.v1alpha1.ListTablesResponse
ListTablesResponse.Builder
Response message for the ListTables method.
Protobuf type google.cloud.bigquery.biglake.v1alpha1.ListTablesResponse
LocationName
LocationName.Builder
Builder for projects/{project}/locations/{location}.
Lock
Represents a lock.
Protobuf type google.cloud.bigquery.biglake.v1alpha1.Lock
Lock.Builder
Represents a lock.
Protobuf type google.cloud.bigquery.biglake.v1alpha1.Lock
LockName
LockName.Builder
Builder for projects/{project}/locations/{location}/catalogs/{catalog}/databases/{database}/locks/{lock}.
MetastoreProto
MetastoreServiceClient
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.
MetastoreServiceClient.ListCatalogsFixedSizeCollection
MetastoreServiceClient.ListCatalogsPage
MetastoreServiceClient.ListCatalogsPagedResponse
MetastoreServiceClient.ListDatabasesFixedSizeCollection
MetastoreServiceClient.ListDatabasesPage
MetastoreServiceClient.ListDatabasesPagedResponse
MetastoreServiceClient.ListLocksFixedSizeCollection
MetastoreServiceClient.ListLocksPage
MetastoreServiceClient.ListLocksPagedResponse
MetastoreServiceClient.ListTablesFixedSizeCollection
MetastoreServiceClient.ListTablesPage
MetastoreServiceClient.ListTablesPagedResponse
MetastoreServiceGrpc
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/*
MetastoreServiceGrpc.MetastoreServiceBlockingStub
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/*
MetastoreServiceGrpc.MetastoreServiceFutureStub
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/*
MetastoreServiceGrpc.MetastoreServiceImplBase
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/*
MetastoreServiceGrpc.MetastoreServiceStub
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/*
MetastoreServiceSettings
Settings class to configure an instance of MetastoreServiceClient.
The default instance has everything set to sensible defaults:
- The default service address (biglake.googleapis.com) and default port (443) are used.
- Credentials are acquired automatically through Application Default Credentials.
- Retries are configured for idempotent methods but not for non-idempotent methods.
The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.
For example, to set the total timeout of createCatalog to 30 seconds:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require 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.Builder metastoreServiceSettingsBuilder =
MetastoreServiceSettings.newBuilder();
metastoreServiceSettingsBuilder
.createCatalogSettings()
.setRetrySettings(
metastoreServiceSettingsBuilder
.createCatalogSettings()
.getRetrySettings()
.toBuilder()
.setTotalTimeout(Duration.ofSeconds(30))
.build());
MetastoreServiceSettings metastoreServiceSettings = metastoreServiceSettingsBuilder.build();
MetastoreServiceSettings.Builder
Builder for MetastoreServiceSettings.
Table
Represents a table.
Protobuf type google.cloud.bigquery.biglake.v1alpha1.Table
Table.Builder
Represents a table.
Protobuf type google.cloud.bigquery.biglake.v1alpha1.Table
TableName
TableName.Builder
Builder for projects/{project}/locations/{location}/catalogs/{catalog}/databases/{database}/tables/{table}.
UpdateDatabaseRequest
Request message for the UpdateDatabase method.
Protobuf type google.cloud.bigquery.biglake.v1alpha1.UpdateDatabaseRequest
UpdateDatabaseRequest.Builder
Request message for the UpdateDatabase method.
Protobuf type google.cloud.bigquery.biglake.v1alpha1.UpdateDatabaseRequest
UpdateTableRequest
Request message for the UpdateTable method.
Protobuf type google.cloud.bigquery.biglake.v1alpha1.UpdateTableRequest
UpdateTableRequest.Builder
Request message for the UpdateTable method.
Protobuf type google.cloud.bigquery.biglake.v1alpha1.UpdateTableRequest
Interfaces
CatalogOrBuilder
CheckLockRequestOrBuilder
CreateCatalogRequestOrBuilder
CreateDatabaseRequestOrBuilder
CreateLockRequestOrBuilder
CreateTableRequestOrBuilder
DatabaseOrBuilder
DeleteCatalogRequestOrBuilder
DeleteDatabaseRequestOrBuilder
DeleteLockRequestOrBuilder
DeleteTableRequestOrBuilder
GetCatalogRequestOrBuilder
GetDatabaseRequestOrBuilder
GetTableRequestOrBuilder
HiveDatabaseOptionsOrBuilder
HiveTableOptions.SerDeInfoOrBuilder
HiveTableOptions.StorageDescriptorOrBuilder
HiveTableOptionsOrBuilder
ListCatalogsRequestOrBuilder
ListCatalogsResponseOrBuilder
ListDatabasesRequestOrBuilder
ListDatabasesResponseOrBuilder
ListLocksRequestOrBuilder
ListLocksResponseOrBuilder
ListTablesRequestOrBuilder
ListTablesResponseOrBuilder
LockOrBuilder
TableOrBuilder
UpdateDatabaseRequestOrBuilder
UpdateTableRequestOrBuilder
Enums
Database.OptionsCase
Database.Type
The database type.
Protobuf enum google.cloud.bigquery.biglake.v1alpha1.Database.Type
Lock.ResourcesCase
Lock.State
The lock state.
Protobuf enum google.cloud.bigquery.biglake.v1alpha1.Lock.State
Lock.Type
The lock type.
Protobuf enum google.cloud.bigquery.biglake.v1alpha1.Lock.Type
Table.OptionsCase
Table.Type
The table type.
Protobuf enum google.cloud.bigquery.biglake.v1alpha1.Table.Type