Package com.google.cloud.biglake.v1
Class IcebergCatalogServiceGrpc.IcebergCatalogServiceStub
java.lang.Object
io.grpc.stub.AbstractStub<S>
io.grpc.stub.AbstractAsyncStub<IcebergCatalogServiceGrpc.IcebergCatalogServiceStub>
com.google.cloud.biglake.v1.IcebergCatalogServiceGrpc.IcebergCatalogServiceStub
- Enclosing class:
- IcebergCatalogServiceGrpc
public static final class IcebergCatalogServiceGrpc.IcebergCatalogServiceStub
extends io.grpc.stub.AbstractAsyncStub<IcebergCatalogServiceGrpc.IcebergCatalogServiceStub>
A stub to allow clients to do asynchronous rpc calls to service IcebergCatalogService.
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.
-
Nested Class Summary
Nested classes/interfaces inherited from class io.grpc.stub.AbstractStub
io.grpc.stub.AbstractStub.StubFactory<T extends io.grpc.stub.AbstractStub<T>> -
Method Summary
Modifier and TypeMethodDescriptionbuild(io.grpc.Channel channel, io.grpc.CallOptions callOptions) voidcheckIcebergNamespaceExists(GetIcebergNamespaceRequest request, io.grpc.stub.StreamObserver<com.google.protobuf.Empty> responseObserver) Returns 204 if the namespace exists, 404 otherwise.voidcheckIcebergTableExists(GetIcebergTableRequest request, io.grpc.stub.StreamObserver<com.google.protobuf.Empty> responseObserver) Returns 204 if the table exists, 404 otherwise.voidcreateIcebergCatalog(CreateIcebergCatalogRequest request, io.grpc.stub.StreamObserver<IcebergCatalog> responseObserver) Creates the Iceberg REST Catalog.voidcreateIcebergNamespace(CreateIcebergNamespaceRequest request, io.grpc.stub.StreamObserver<IcebergNamespace> responseObserver) Creates a namespace in the catalog.voidcreateIcebergTable(CreateIcebergTableRequest request, io.grpc.stub.StreamObserver<HttpBody> responseObserver) Creates a table in the namespace.voiddeleteIcebergCatalog(DeleteIcebergCatalogRequest request, io.grpc.stub.StreamObserver<com.google.protobuf.Empty> responseObserver) Deletes the Iceberg REST Catalog.voiddeleteIcebergNamespace(DeleteIcebergNamespaceRequest request, io.grpc.stub.StreamObserver<com.google.protobuf.Empty> responseObserver) Returns 204, not 200 on success.voiddeleteIcebergTable(DeleteIcebergTableRequest request, io.grpc.stub.StreamObserver<com.google.protobuf.Empty> responseObserver) Deletes a table in the namespace.voidfailoverIcebergCatalog(FailoverIcebergCatalogRequest request, io.grpc.stub.StreamObserver<FailoverIcebergCatalogResponse> responseObserver) Failover the catalog to a new primary replica region.voidgetIcebergCatalog(GetIcebergCatalogRequest request, io.grpc.stub.StreamObserver<IcebergCatalog> responseObserver) Returns the Iceberg REST Catalog configuration options.voidgetIcebergCatalogConfig(GetIcebergCatalogConfigRequest request, io.grpc.stub.StreamObserver<IcebergCatalogConfig> responseObserver) GetIcebergCatalogConfig lists all catalog configuration settings.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).voidgetIcebergTable(GetIcebergTableRequest request, io.grpc.stub.StreamObserver<HttpBody> responseObserver) Gets a table in the namespace.voidlistIcebergCatalogs(ListIcebergCatalogsRequest request, io.grpc.stub.StreamObserver<ListIcebergCatalogsResponse> responseObserver) Lists the Iceberg REST Catalogs.voidlistIcebergNamespaces(ListIcebergNamespacesRequest request, io.grpc.stub.StreamObserver<ListIcebergNamespacesResponse> responseObserver) Lists Iceberg namespaces in the catalog.voidlistIcebergTableIdentifiers(ListIcebergTableIdentifiersRequest request, io.grpc.stub.StreamObserver<ListIcebergTableIdentifiersResponse> responseObserver) Lists table identifiers (not *tables*) in the namespace.voidloadIcebergTableCredentials(GetIcebergTableRequest request, io.grpc.stub.StreamObserver<LoadIcebergTableCredentialsResponse> responseObserver) Loads credentials for a table in the namespace.voidregisterIcebergTable(RegisterIcebergTableRequest request, io.grpc.stub.StreamObserver<HttpBody> responseObserver) Register a table using given metadata file location.voidupdateIcebergCatalog(UpdateIcebergCatalogRequest request, io.grpc.stub.StreamObserver<IcebergCatalog> responseObserver) Update the Iceberg REST Catalog configuration options.voidupdateIcebergNamespace(UpdateIcebergNamespaceRequest request, io.grpc.stub.StreamObserver<UpdateIcebergNamespaceResponse> responseObserver) Updates namespace properties.voidupdateIcebergTable(UpdateIcebergTableRequest request, io.grpc.stub.StreamObserver<HttpBody> responseObserver) This is CommitTable Iceberg API, which maps to `UpdateIcebergTable` in the Google API nomenclature.Methods inherited from class io.grpc.stub.AbstractAsyncStub
newStub, newStubMethods inherited from class io.grpc.stub.AbstractStub
getCallOptions, getChannel, withCallCredentials, withChannel, withCompression, withDeadline, withDeadlineAfter, withDeadlineAfter, withExecutor, withInterceptors, withMaxInboundMessageSize, withMaxOutboundMessageSize, withOnReadyThreshold, withOption, withWaitForReady
-
Method Details
-
build
protected IcebergCatalogServiceGrpc.IcebergCatalogServiceStub build(io.grpc.Channel channel, io.grpc.CallOptions callOptions) - Specified by:
buildin classio.grpc.stub.AbstractStub<IcebergCatalogServiceGrpc.IcebergCatalogServiceStub>
-
getIcebergCatalogConfig
public 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
public 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
public void checkIcebergNamespaceExists(GetIcebergNamespaceRequest request, io.grpc.stub.StreamObserver<com.google.protobuf.Empty> responseObserver) Returns 204 if the namespace exists, 404 otherwise.
-
getIcebergNamespace
public 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
public void createIcebergNamespace(CreateIcebergNamespaceRequest request, io.grpc.stub.StreamObserver<IcebergNamespace> responseObserver) Creates a namespace in the catalog.
-
deleteIcebergNamespace
public void deleteIcebergNamespace(DeleteIcebergNamespaceRequest request, io.grpc.stub.StreamObserver<com.google.protobuf.Empty> responseObserver) Returns 204, not 200 on success.
-
updateIcebergNamespace
public void updateIcebergNamespace(UpdateIcebergNamespaceRequest request, io.grpc.stub.StreamObserver<UpdateIcebergNamespaceResponse> responseObserver) Updates namespace properties.
-
listIcebergTableIdentifiers
public void listIcebergTableIdentifiers(ListIcebergTableIdentifiersRequest request, io.grpc.stub.StreamObserver<ListIcebergTableIdentifiersResponse> responseObserver) Lists table identifiers (not *tables*) in the namespace.
-
createIcebergTable
public void createIcebergTable(CreateIcebergTableRequest request, io.grpc.stub.StreamObserver<HttpBody> responseObserver) Creates a table in the namespace.
-
checkIcebergTableExists
public 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
public void deleteIcebergTable(DeleteIcebergTableRequest request, io.grpc.stub.StreamObserver<com.google.protobuf.Empty> responseObserver) Deletes a table in the namespace.
-
getIcebergTable
public void getIcebergTable(GetIcebergTableRequest request, io.grpc.stub.StreamObserver<HttpBody> responseObserver) Gets a table in the namespace.
-
loadIcebergTableCredentials
public void loadIcebergTableCredentials(GetIcebergTableRequest request, io.grpc.stub.StreamObserver<LoadIcebergTableCredentialsResponse> responseObserver) Loads credentials for a table in the namespace.
-
updateIcebergTable
public 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
public void registerIcebergTable(RegisterIcebergTableRequest request, io.grpc.stub.StreamObserver<HttpBody> responseObserver) Register a table using given metadata file location.
-
getIcebergCatalog
public void getIcebergCatalog(GetIcebergCatalogRequest request, io.grpc.stub.StreamObserver<IcebergCatalog> responseObserver) Returns the Iceberg REST Catalog configuration options.
-
listIcebergCatalogs
public void listIcebergCatalogs(ListIcebergCatalogsRequest request, io.grpc.stub.StreamObserver<ListIcebergCatalogsResponse> responseObserver) Lists the Iceberg REST Catalogs.
-
deleteIcebergCatalog
public 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
public void updateIcebergCatalog(UpdateIcebergCatalogRequest request, io.grpc.stub.StreamObserver<IcebergCatalog> responseObserver) Update the Iceberg REST Catalog configuration options.
-
createIcebergCatalog
public 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
public void failoverIcebergCatalog(FailoverIcebergCatalogRequest request, io.grpc.stub.StreamObserver<FailoverIcebergCatalogResponse> responseObserver) Failover the catalog to a new primary replica region.
-