Package com.google.cloud.biglake.v1
Class IcebergCatalogServiceGrpc.IcebergCatalogServiceFutureStub
java.lang.Object
io.grpc.stub.AbstractStub<S>
io.grpc.stub.AbstractFutureStub<IcebergCatalogServiceGrpc.IcebergCatalogServiceFutureStub>
com.google.cloud.biglake.v1.IcebergCatalogServiceGrpc.IcebergCatalogServiceFutureStub
- Enclosing class:
- IcebergCatalogServiceGrpc
public static final class IcebergCatalogServiceGrpc.IcebergCatalogServiceFutureStub
extends io.grpc.stub.AbstractFutureStub<IcebergCatalogServiceGrpc.IcebergCatalogServiceFutureStub>
A stub to allow clients to do ListenableFuture-style 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) com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty>Returns 204 if the namespace exists, 404 otherwise.com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty>Returns 204 if the table exists, 404 otherwise.com.google.common.util.concurrent.ListenableFuture<IcebergCatalog>Creates the Iceberg REST Catalog.com.google.common.util.concurrent.ListenableFuture<IcebergNamespace>Creates a namespace in the catalog.com.google.common.util.concurrent.ListenableFuture<HttpBody>Creates a table in the namespace.com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty>Deletes the Iceberg REST Catalog.com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty>Returns 204, not 200 on success.com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty>Deletes a table in the namespace.com.google.common.util.concurrent.ListenableFuture<FailoverIcebergCatalogResponse>Failover the catalog to a new primary replica region.com.google.common.util.concurrent.ListenableFuture<IcebergCatalog>Returns the Iceberg REST Catalog configuration options.com.google.common.util.concurrent.ListenableFuture<IcebergCatalogConfig>GetIcebergCatalogConfig lists all catalog configuration settings.com.google.common.util.concurrent.ListenableFuture<IcebergNamespace>Gets an Iceberg namespace in the catalog (or checks if it exists, if the method is HEAD).com.google.common.util.concurrent.ListenableFuture<HttpBody>getIcebergTable(GetIcebergTableRequest request) Gets a table in the namespace.com.google.common.util.concurrent.ListenableFuture<ListIcebergCatalogsResponse>Lists the Iceberg REST Catalogs.com.google.common.util.concurrent.ListenableFuture<ListIcebergNamespacesResponse>Lists Iceberg namespaces in the catalog.com.google.common.util.concurrent.ListenableFuture<ListIcebergTableIdentifiersResponse>Lists table identifiers (not *tables*) in the namespace.com.google.common.util.concurrent.ListenableFuture<LoadIcebergTableCredentialsResponse>Loads credentials for a table in the namespace.com.google.common.util.concurrent.ListenableFuture<HttpBody>Register a table using given metadata file location.com.google.common.util.concurrent.ListenableFuture<IcebergCatalog>Update the Iceberg REST Catalog configuration options.com.google.common.util.concurrent.ListenableFuture<UpdateIcebergNamespaceResponse>Updates namespace properties.com.google.common.util.concurrent.ListenableFuture<HttpBody>This is CommitTable Iceberg API, which maps to `UpdateIcebergTable` in the Google API nomenclature.Methods inherited from class io.grpc.stub.AbstractFutureStub
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.IcebergCatalogServiceFutureStub build(io.grpc.Channel channel, io.grpc.CallOptions callOptions) - Specified by:
buildin classio.grpc.stub.AbstractStub<IcebergCatalogServiceGrpc.IcebergCatalogServiceFutureStub>
-
getIcebergCatalogConfig
public com.google.common.util.concurrent.ListenableFuture<IcebergCatalogConfig> getIcebergCatalogConfig(GetIcebergCatalogConfigRequest request) 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 com.google.common.util.concurrent.ListenableFuture<ListIcebergNamespacesResponse> listIcebergNamespaces(ListIcebergNamespacesRequest request) Lists Iceberg namespaces in the catalog. We only support one level of nesting for namespaces.
-
checkIcebergNamespaceExists
public com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> checkIcebergNamespaceExists(GetIcebergNamespaceRequest request) Returns 204 if the namespace exists, 404 otherwise.
-
getIcebergNamespace
public com.google.common.util.concurrent.ListenableFuture<IcebergNamespace> getIcebergNamespace(GetIcebergNamespaceRequest request) Gets an Iceberg namespace in the catalog (or checks if it exists, if the method is HEAD).
-
createIcebergNamespace
public com.google.common.util.concurrent.ListenableFuture<IcebergNamespace> createIcebergNamespace(CreateIcebergNamespaceRequest request) Creates a namespace in the catalog.
-
deleteIcebergNamespace
public com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> deleteIcebergNamespace(DeleteIcebergNamespaceRequest request) Returns 204, not 200 on success.
-
updateIcebergNamespace
public com.google.common.util.concurrent.ListenableFuture<UpdateIcebergNamespaceResponse> updateIcebergNamespace(UpdateIcebergNamespaceRequest request) Updates namespace properties.
-
listIcebergTableIdentifiers
public com.google.common.util.concurrent.ListenableFuture<ListIcebergTableIdentifiersResponse> listIcebergTableIdentifiers(ListIcebergTableIdentifiersRequest request) Lists table identifiers (not *tables*) in the namespace.
-
createIcebergTable
public com.google.common.util.concurrent.ListenableFuture<HttpBody> createIcebergTable(CreateIcebergTableRequest request) Creates a table in the namespace.
-
checkIcebergTableExists
public com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> checkIcebergTableExists(GetIcebergTableRequest request) Returns 204 if the table exists, 404 otherwise. This is a `HEAD` HTTP method.
-
deleteIcebergTable
public com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> deleteIcebergTable(DeleteIcebergTableRequest request) Deletes a table in the namespace.
-
getIcebergTable
public com.google.common.util.concurrent.ListenableFuture<HttpBody> getIcebergTable(GetIcebergTableRequest request) Gets a table in the namespace.
-
loadIcebergTableCredentials
public com.google.common.util.concurrent.ListenableFuture<LoadIcebergTableCredentialsResponse> loadIcebergTableCredentials(GetIcebergTableRequest request) Loads credentials for a table in the namespace.
-
updateIcebergTable
public com.google.common.util.concurrent.ListenableFuture<HttpBody> updateIcebergTable(UpdateIcebergTableRequest request) This is CommitTable Iceberg API, which maps to `UpdateIcebergTable` in the Google API nomenclature.
-
registerIcebergTable
public com.google.common.util.concurrent.ListenableFuture<HttpBody> registerIcebergTable(RegisterIcebergTableRequest request) Register a table using given metadata file location.
-
getIcebergCatalog
public com.google.common.util.concurrent.ListenableFuture<IcebergCatalog> getIcebergCatalog(GetIcebergCatalogRequest request) Returns the Iceberg REST Catalog configuration options.
-
listIcebergCatalogs
public com.google.common.util.concurrent.ListenableFuture<ListIcebergCatalogsResponse> listIcebergCatalogs(ListIcebergCatalogsRequest request) Lists the Iceberg REST Catalogs.
-
deleteIcebergCatalog
public com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> deleteIcebergCatalog(DeleteIcebergCatalogRequest request) 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 com.google.common.util.concurrent.ListenableFuture<IcebergCatalog> updateIcebergCatalog(UpdateIcebergCatalogRequest request) Update the Iceberg REST Catalog configuration options.
-
createIcebergCatalog
public com.google.common.util.concurrent.ListenableFuture<IcebergCatalog> createIcebergCatalog(CreateIcebergCatalogRequest request) 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 com.google.common.util.concurrent.ListenableFuture<FailoverIcebergCatalogResponse> failoverIcebergCatalog(FailoverIcebergCatalogRequest request) Failover the catalog to a new primary replica region.
-