Package com.google.cloud.biglake.v1
Interface IcebergCatalogServiceGrpc.AsyncService
- All Known Implementing Classes:
IcebergCatalogServiceGrpc.IcebergCatalogServiceImplBase
- Enclosing class:
- IcebergCatalogServiceGrpc
public static interface IcebergCatalogServiceGrpc.AsyncService
Iceberg Catalog Service API: this implements the open-source Iceberg REST Catalog API. See the API definition here: https://github.com/apache/iceberg/blob/main/open-api/rest-catalog-open-api.yaml The API is defined as OpenAPI 3.1.1 spec. Currently we only support the following methods: - GetConfig/GetIcebergCatalogConfig - ListIcebergNamespaces - CheckIcebergNamespaceExists - GetIcebergNamespace - CreateIcebergNamespace (only supports single level) - DeleteIcebergNamespace - UpdateIcebergNamespace properties - ListTableIdentifiers - CreateIcebergTable - DeleteIcebergTable - GetIcebergTable - UpdateIcebergTable (CommitTable) - LoadIcebergTableCredentials - RegisterTable Users are required to provided the `X-Goog-User-Project` header with the project id or number which can be different from the bucket project id. That project will be charged for the API calls and the calling user must have access to that project. The caller must have `serviceusage.services.use` permission on the project.
-
Method Summary
Modifier and TypeMethodDescriptiondefault voidcheckIcebergNamespaceExists(GetIcebergNamespaceRequest request, io.grpc.stub.StreamObserver<com.google.protobuf.Empty> responseObserver) Returns 204 if the namespace exists, 404 otherwise.default voidcheckIcebergTableExists(GetIcebergTableRequest request, io.grpc.stub.StreamObserver<com.google.protobuf.Empty> responseObserver) Returns 204 if the table exists, 404 otherwise.default voidcreateIcebergCatalog(CreateIcebergCatalogRequest request, io.grpc.stub.StreamObserver<IcebergCatalog> responseObserver) Creates the Iceberg REST Catalog.default voidcreateIcebergNamespace(CreateIcebergNamespaceRequest request, io.grpc.stub.StreamObserver<IcebergNamespace> responseObserver) Creates a namespace in the catalog.default voidcreateIcebergTable(CreateIcebergTableRequest request, io.grpc.stub.StreamObserver<HttpBody> responseObserver) Creates a table in the namespace.default voiddeleteIcebergCatalog(DeleteIcebergCatalogRequest request, io.grpc.stub.StreamObserver<com.google.protobuf.Empty> responseObserver) Deletes the Iceberg REST Catalog.default voiddeleteIcebergNamespace(DeleteIcebergNamespaceRequest request, io.grpc.stub.StreamObserver<com.google.protobuf.Empty> responseObserver) Returns 204, not 200 on success.default voiddeleteIcebergTable(DeleteIcebergTableRequest request, io.grpc.stub.StreamObserver<com.google.protobuf.Empty> responseObserver) Deletes a table in the namespace.default voidfailoverIcebergCatalog(FailoverIcebergCatalogRequest request, io.grpc.stub.StreamObserver<FailoverIcebergCatalogResponse> responseObserver) Failover the catalog to a new primary replica region.default voidgetIcebergCatalog(GetIcebergCatalogRequest request, io.grpc.stub.StreamObserver<IcebergCatalog> responseObserver) Returns the Iceberg REST Catalog configuration options.default voidgetIcebergCatalogConfig(GetIcebergCatalogConfigRequest request, io.grpc.stub.StreamObserver<IcebergCatalogConfig> responseObserver) GetIcebergCatalogConfig lists all catalog configuration settings.default voidgetIcebergNamespace(GetIcebergNamespaceRequest request, io.grpc.stub.StreamObserver<IcebergNamespace> responseObserver) Gets an Iceberg namespace in the catalog (or checks if it exists, if the method is HEAD).default voidgetIcebergTable(GetIcebergTableRequest request, io.grpc.stub.StreamObserver<HttpBody> responseObserver) Gets a table in the namespace.default voidlistIcebergCatalogs(ListIcebergCatalogsRequest request, io.grpc.stub.StreamObserver<ListIcebergCatalogsResponse> responseObserver) Lists the Iceberg REST Catalogs.default voidlistIcebergNamespaces(ListIcebergNamespacesRequest request, io.grpc.stub.StreamObserver<ListIcebergNamespacesResponse> responseObserver) Lists Iceberg namespaces in the catalog.default voidlistIcebergTableIdentifiers(ListIcebergTableIdentifiersRequest request, io.grpc.stub.StreamObserver<ListIcebergTableIdentifiersResponse> responseObserver) Lists table identifiers (not *tables*) in the namespace.default voidloadIcebergTableCredentials(GetIcebergTableRequest request, io.grpc.stub.StreamObserver<LoadIcebergTableCredentialsResponse> responseObserver) Loads credentials for a table in the namespace.default voidregisterIcebergTable(RegisterIcebergTableRequest request, io.grpc.stub.StreamObserver<HttpBody> responseObserver) Register a table using given metadata file location.default voidupdateIcebergCatalog(UpdateIcebergCatalogRequest request, io.grpc.stub.StreamObserver<IcebergCatalog> responseObserver) Update the Iceberg REST Catalog configuration options.default voidupdateIcebergNamespace(UpdateIcebergNamespaceRequest request, io.grpc.stub.StreamObserver<UpdateIcebergNamespaceResponse> responseObserver) Updates namespace properties.default voidupdateIcebergTable(UpdateIcebergTableRequest request, io.grpc.stub.StreamObserver<HttpBody> responseObserver) This is CommitTable Iceberg API, which maps to `UpdateIcebergTable` in the Google API nomenclature.
-
Method Details
-
getIcebergCatalogConfig
default void getIcebergCatalogConfig(GetIcebergCatalogConfigRequest request, io.grpc.stub.StreamObserver<IcebergCatalogConfig> responseObserver) GetIcebergCatalogConfig lists all catalog configuration settings. Most importantly it contains the optional `endpoints` field which lists what methods this catalog supports, since we are not supporting all the methods right now. It returns all the methods defined in this service (subject to project config allowlisting). This is not a GCP resource.
-
listIcebergNamespaces
default void listIcebergNamespaces(ListIcebergNamespacesRequest request, io.grpc.stub.StreamObserver<ListIcebergNamespacesResponse> responseObserver) Lists Iceberg namespaces in the catalog. We only support one level of nesting for namespaces.
-
checkIcebergNamespaceExists
default void checkIcebergNamespaceExists(GetIcebergNamespaceRequest request, io.grpc.stub.StreamObserver<com.google.protobuf.Empty> responseObserver) Returns 204 if the namespace exists, 404 otherwise.
-
getIcebergNamespace
default void getIcebergNamespace(GetIcebergNamespaceRequest request, io.grpc.stub.StreamObserver<IcebergNamespace> responseObserver) Gets an Iceberg namespace in the catalog (or checks if it exists, if the method is HEAD).
-
createIcebergNamespace
default void createIcebergNamespace(CreateIcebergNamespaceRequest request, io.grpc.stub.StreamObserver<IcebergNamespace> responseObserver) Creates a namespace in the catalog.
-
deleteIcebergNamespace
default void deleteIcebergNamespace(DeleteIcebergNamespaceRequest request, io.grpc.stub.StreamObserver<com.google.protobuf.Empty> responseObserver) Returns 204, not 200 on success.
-
updateIcebergNamespace
default void updateIcebergNamespace(UpdateIcebergNamespaceRequest request, io.grpc.stub.StreamObserver<UpdateIcebergNamespaceResponse> responseObserver) Updates namespace properties.
-
listIcebergTableIdentifiers
default void listIcebergTableIdentifiers(ListIcebergTableIdentifiersRequest request, io.grpc.stub.StreamObserver<ListIcebergTableIdentifiersResponse> responseObserver) Lists table identifiers (not *tables*) in the namespace.
-
createIcebergTable
default void createIcebergTable(CreateIcebergTableRequest request, io.grpc.stub.StreamObserver<HttpBody> responseObserver) Creates a table in the namespace.
-
checkIcebergTableExists
default void checkIcebergTableExists(GetIcebergTableRequest request, io.grpc.stub.StreamObserver<com.google.protobuf.Empty> responseObserver) Returns 204 if the table exists, 404 otherwise. This is a `HEAD` HTTP method.
-
deleteIcebergTable
default void deleteIcebergTable(DeleteIcebergTableRequest request, io.grpc.stub.StreamObserver<com.google.protobuf.Empty> responseObserver) Deletes a table in the namespace.
-
getIcebergTable
default void getIcebergTable(GetIcebergTableRequest request, io.grpc.stub.StreamObserver<HttpBody> responseObserver) Gets a table in the namespace.
-
loadIcebergTableCredentials
default void loadIcebergTableCredentials(GetIcebergTableRequest request, io.grpc.stub.StreamObserver<LoadIcebergTableCredentialsResponse> responseObserver) Loads credentials for a table in the namespace.
-
updateIcebergTable
default void updateIcebergTable(UpdateIcebergTableRequest request, io.grpc.stub.StreamObserver<HttpBody> responseObserver) This is CommitTable Iceberg API, which maps to `UpdateIcebergTable` in the Google API nomenclature.
-
registerIcebergTable
default void registerIcebergTable(RegisterIcebergTableRequest request, io.grpc.stub.StreamObserver<HttpBody> responseObserver) Register a table using given metadata file location.
-
getIcebergCatalog
default void getIcebergCatalog(GetIcebergCatalogRequest request, io.grpc.stub.StreamObserver<IcebergCatalog> responseObserver) Returns the Iceberg REST Catalog configuration options.
-
listIcebergCatalogs
default void listIcebergCatalogs(ListIcebergCatalogsRequest request, io.grpc.stub.StreamObserver<ListIcebergCatalogsResponse> responseObserver) Lists the Iceberg REST Catalogs.
-
deleteIcebergCatalog
default void deleteIcebergCatalog(DeleteIcebergCatalogRequest request, io.grpc.stub.StreamObserver<com.google.protobuf.Empty> responseObserver) Deletes the Iceberg REST Catalog. Delete does not delete a catalog that has contents -- at least one namespace. Delete is not supported for all catalog types.
-
updateIcebergCatalog
default void updateIcebergCatalog(UpdateIcebergCatalogRequest request, io.grpc.stub.StreamObserver<IcebergCatalog> responseObserver) Update the Iceberg REST Catalog configuration options.
-
createIcebergCatalog
default void createIcebergCatalog(CreateIcebergCatalogRequest request, io.grpc.stub.StreamObserver<IcebergCatalog> responseObserver) Creates the Iceberg REST Catalog. Currently only supports Google Cloud Storage Bucket catalogs. Google Cloud Storage Bucket catalog id is the bucket for which the catalog is created (e.g. `my-catalog` for `gs://my-catalog`). If the bucket does not exist, of the caller does not have bucket metadata permissions, the catalog will not be created.
-
failoverIcebergCatalog
default void failoverIcebergCatalog(FailoverIcebergCatalogRequest request, io.grpc.stub.StreamObserver<FailoverIcebergCatalogResponse> responseObserver) Failover the catalog to a new primary replica region.
-