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