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. + * + *
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: + * + *
{@code
+ * // 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 (IcebergCatalogServiceClient icebergCatalogServiceClient =
+ * IcebergCatalogServiceClient.create()) {
+ * CatalogName name = CatalogName.of("[PROJECT]", "[CATALOG]");
+ * IcebergCatalog response = icebergCatalogServiceClient.getIcebergCatalog(name);
+ * }
+ * }
+ *
+ * Note: close() needs to be called on the IcebergCatalogServiceClient object to clean up + * resources such as threads. In the example above, try-with-resources is used, which automatically + * calls close(). + * + *
| Method | + *Description | + *Method Variants | + *
|---|---|---|
GetIcebergCatalog |
+ * Returns the Iceberg REST Catalog configuration options. |
+ *
+ * Request object method variants only take one parameter, a request object, which must be constructed before the call. + *
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. + *
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. + *
|
+ *
ListIcebergCatalogs |
+ * Lists the Iceberg REST Catalogs. |
+ *
+ * Request object method variants only take one parameter, a request object, which must be constructed before the call. + *
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. + *
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. + *
|
+ *
UpdateIcebergCatalog |
+ * Update the Iceberg REST Catalog configuration options. |
+ *
+ * Request object method variants only take one parameter, a request object, which must be constructed before the call. + *
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. + *
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. + *
|
+ *
CreateIcebergCatalog |
+ * 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. |
+ *
+ * Request object method variants only take one parameter, a request object, which must be constructed before the call. + *
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. + *
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. + *
|
+ *
FailoverIcebergCatalog |
+ * Failover the catalog to a new primary replica region. |
+ *
+ * Request object method variants only take one parameter, a request object, which must be constructed before the call. + *
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. + *
Callable method variants take no parameters and return 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 IcebergCatalogServiceSettings + * to create(). For example: + * + *
To customize credentials: + * + *
{@code
+ * // 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
+ * IcebergCatalogServiceSettings icebergCatalogServiceSettings =
+ * IcebergCatalogServiceSettings.newBuilder()
+ * .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
+ * .build();
+ * IcebergCatalogServiceClient icebergCatalogServiceClient =
+ * IcebergCatalogServiceClient.create(icebergCatalogServiceSettings);
+ * }
+ *
+ * To customize the endpoint: + * + *
{@code
+ * // 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
+ * IcebergCatalogServiceSettings icebergCatalogServiceSettings =
+ * IcebergCatalogServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
+ * IcebergCatalogServiceClient icebergCatalogServiceClient =
+ * IcebergCatalogServiceClient.create(icebergCatalogServiceSettings);
+ * }
+ *
+ * To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over + * the wire: + * + *
{@code
+ * // 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
+ * IcebergCatalogServiceSettings icebergCatalogServiceSettings =
+ * IcebergCatalogServiceSettings.newHttpJsonBuilder().build();
+ * IcebergCatalogServiceClient icebergCatalogServiceClient =
+ * IcebergCatalogServiceClient.create(icebergCatalogServiceSettings);
+ * }
+ *
+ * Please refer to the GitHub repository's samples for more quickstart code snippets. + */ +@Generated("by gapic-generator-java") +public class IcebergCatalogServiceClient implements BackgroundResource { + private final IcebergCatalogServiceSettings settings; + private final IcebergCatalogServiceStub stub; + + /** Constructs an instance of IcebergCatalogServiceClient with default settings. */ + public static final IcebergCatalogServiceClient create() throws IOException { + return create(IcebergCatalogServiceSettings.newBuilder().build()); + } + + /** + * Constructs an instance of IcebergCatalogServiceClient, using the given settings. The channels + * are created based on the settings passed in, or defaults for any settings that are not set. + */ + public static final IcebergCatalogServiceClient create(IcebergCatalogServiceSettings settings) + throws IOException { + return new IcebergCatalogServiceClient(settings); + } + + /** + * Constructs an instance of IcebergCatalogServiceClient, using the given stub for making calls. + * This is for advanced usage - prefer using create(IcebergCatalogServiceSettings). + */ + public static final IcebergCatalogServiceClient create(IcebergCatalogServiceStub stub) { + return new IcebergCatalogServiceClient(stub); + } + + /** + * Constructs an instance of IcebergCatalogServiceClient, using the given settings. This is + * protected so that it is easy to make a subclass, but otherwise, the static factory methods + * should be preferred. + */ + protected IcebergCatalogServiceClient(IcebergCatalogServiceSettings settings) throws IOException { + this.settings = settings; + this.stub = ((IcebergCatalogServiceStubSettings) settings.getStubSettings()).createStub(); + } + + protected IcebergCatalogServiceClient(IcebergCatalogServiceStub stub) { + this.settings = null; + this.stub = stub; + } + + public final IcebergCatalogServiceSettings getSettings() { + return settings; + } + + public IcebergCatalogServiceStub getStub() { + return stub; + } + + // AUTO-GENERATED DOCUMENTATION AND METHOD. + /** + * Returns the Iceberg REST Catalog configuration options. + * + *
Sample code: + * + *
{@code
+ * // 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 (IcebergCatalogServiceClient icebergCatalogServiceClient =
+ * IcebergCatalogServiceClient.create()) {
+ * CatalogName name = CatalogName.of("[PROJECT]", "[CATALOG]");
+ * IcebergCatalog response = icebergCatalogServiceClient.getIcebergCatalog(name);
+ * }
+ * }
+ *
+ * @param name Required. The catalog to get.
+ * @throws com.google.api.gax.rpc.ApiException if the remote call fails
+ */
+ public final IcebergCatalog getIcebergCatalog(CatalogName name) {
+ GetIcebergCatalogRequest request =
+ GetIcebergCatalogRequest.newBuilder()
+ .setName(name == null ? null : name.toString())
+ .build();
+ return getIcebergCatalog(request);
+ }
+
+ // AUTO-GENERATED DOCUMENTATION AND METHOD.
+ /**
+ * Returns the Iceberg REST Catalog configuration options.
+ *
+ * Sample code: + * + *
{@code
+ * // 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 (IcebergCatalogServiceClient icebergCatalogServiceClient =
+ * IcebergCatalogServiceClient.create()) {
+ * String name = CatalogName.of("[PROJECT]", "[CATALOG]").toString();
+ * IcebergCatalog response = icebergCatalogServiceClient.getIcebergCatalog(name);
+ * }
+ * }
+ *
+ * @param name Required. The catalog to get.
+ * @throws com.google.api.gax.rpc.ApiException if the remote call fails
+ */
+ public final IcebergCatalog getIcebergCatalog(String name) {
+ GetIcebergCatalogRequest request = GetIcebergCatalogRequest.newBuilder().setName(name).build();
+ return getIcebergCatalog(request);
+ }
+
+ // AUTO-GENERATED DOCUMENTATION AND METHOD.
+ /**
+ * Returns the Iceberg REST Catalog configuration options.
+ *
+ * Sample code: + * + *
{@code
+ * // 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 (IcebergCatalogServiceClient icebergCatalogServiceClient =
+ * IcebergCatalogServiceClient.create()) {
+ * GetIcebergCatalogRequest request =
+ * GetIcebergCatalogRequest.newBuilder()
+ * .setName(CatalogName.of("[PROJECT]", "[CATALOG]").toString())
+ * .build();
+ * IcebergCatalog response = icebergCatalogServiceClient.getIcebergCatalog(request);
+ * }
+ * }
+ *
+ * @param request The request object containing all of the parameters for the API call.
+ * @throws com.google.api.gax.rpc.ApiException if the remote call fails
+ */
+ public final IcebergCatalog getIcebergCatalog(GetIcebergCatalogRequest request) {
+ return getIcebergCatalogCallable().call(request);
+ }
+
+ // AUTO-GENERATED DOCUMENTATION AND METHOD.
+ /**
+ * Returns the Iceberg REST Catalog configuration options.
+ *
+ * Sample code: + * + *
{@code
+ * // 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 (IcebergCatalogServiceClient icebergCatalogServiceClient =
+ * IcebergCatalogServiceClient.create()) {
+ * GetIcebergCatalogRequest request =
+ * GetIcebergCatalogRequest.newBuilder()
+ * .setName(CatalogName.of("[PROJECT]", "[CATALOG]").toString())
+ * .build();
+ * ApiFuture future =
+ * icebergCatalogServiceClient.getIcebergCatalogCallable().futureCall(request);
+ * // Do something.
+ * IcebergCatalog response = future.get();
+ * }
+ * }
+ */
+ public final UnaryCallableSample code: + * + *
{@code
+ * // 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 (IcebergCatalogServiceClient icebergCatalogServiceClient =
+ * IcebergCatalogServiceClient.create()) {
+ * ProjectName parent = ProjectName.of("[PROJECT]");
+ * for (IcebergCatalog element :
+ * icebergCatalogServiceClient.listIcebergCatalogs(parent).iterateAll()) {
+ * // doThingsWith(element);
+ * }
+ * }
+ * }
+ *
+ * @param parent Required. The parent resource where this catalog will be created. Format:
+ * projects/{project_id}
+ * @throws com.google.api.gax.rpc.ApiException if the remote call fails
+ */
+ public final ListIcebergCatalogsPagedResponse listIcebergCatalogs(ProjectName parent) {
+ ListIcebergCatalogsRequest request =
+ ListIcebergCatalogsRequest.newBuilder()
+ .setParent(parent == null ? null : parent.toString())
+ .build();
+ return listIcebergCatalogs(request);
+ }
+
+ // AUTO-GENERATED DOCUMENTATION AND METHOD.
+ /**
+ * Lists the Iceberg REST Catalogs.
+ *
+ * Sample code: + * + *
{@code
+ * // 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 (IcebergCatalogServiceClient icebergCatalogServiceClient =
+ * IcebergCatalogServiceClient.create()) {
+ * String parent = ProjectName.of("[PROJECT]").toString();
+ * for (IcebergCatalog element :
+ * icebergCatalogServiceClient.listIcebergCatalogs(parent).iterateAll()) {
+ * // doThingsWith(element);
+ * }
+ * }
+ * }
+ *
+ * @param parent Required. The parent resource where this catalog will be created. Format:
+ * projects/{project_id}
+ * @throws com.google.api.gax.rpc.ApiException if the remote call fails
+ */
+ public final ListIcebergCatalogsPagedResponse listIcebergCatalogs(String parent) {
+ ListIcebergCatalogsRequest request =
+ ListIcebergCatalogsRequest.newBuilder().setParent(parent).build();
+ return listIcebergCatalogs(request);
+ }
+
+ // AUTO-GENERATED DOCUMENTATION AND METHOD.
+ /**
+ * Lists the Iceberg REST Catalogs.
+ *
+ * Sample code: + * + *
{@code
+ * // 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 (IcebergCatalogServiceClient icebergCatalogServiceClient =
+ * IcebergCatalogServiceClient.create()) {
+ * ListIcebergCatalogsRequest request =
+ * ListIcebergCatalogsRequest.newBuilder()
+ * .setParent(ProjectName.of("[PROJECT]").toString())
+ * .setPageSize(883849137)
+ * .setPageToken("pageToken873572522")
+ * .build();
+ * for (IcebergCatalog element :
+ * icebergCatalogServiceClient.listIcebergCatalogs(request).iterateAll()) {
+ * // doThingsWith(element);
+ * }
+ * }
+ * }
+ *
+ * @param request The request object containing all of the parameters for the API call.
+ * @throws com.google.api.gax.rpc.ApiException if the remote call fails
+ */
+ public final ListIcebergCatalogsPagedResponse listIcebergCatalogs(
+ ListIcebergCatalogsRequest request) {
+ return listIcebergCatalogsPagedCallable().call(request);
+ }
+
+ // AUTO-GENERATED DOCUMENTATION AND METHOD.
+ /**
+ * Lists the Iceberg REST Catalogs.
+ *
+ * Sample code: + * + *
{@code
+ * // 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 (IcebergCatalogServiceClient icebergCatalogServiceClient =
+ * IcebergCatalogServiceClient.create()) {
+ * ListIcebergCatalogsRequest request =
+ * ListIcebergCatalogsRequest.newBuilder()
+ * .setParent(ProjectName.of("[PROJECT]").toString())
+ * .setPageSize(883849137)
+ * .setPageToken("pageToken873572522")
+ * .build();
+ * ApiFuture future =
+ * icebergCatalogServiceClient.listIcebergCatalogsPagedCallable().futureCall(request);
+ * // Do something.
+ * for (IcebergCatalog element : future.get().iterateAll()) {
+ * // doThingsWith(element);
+ * }
+ * }
+ * }
+ */
+ public final UnaryCallableSample code: + * + *
{@code
+ * // 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 (IcebergCatalogServiceClient icebergCatalogServiceClient =
+ * IcebergCatalogServiceClient.create()) {
+ * ListIcebergCatalogsRequest request =
+ * ListIcebergCatalogsRequest.newBuilder()
+ * .setParent(ProjectName.of("[PROJECT]").toString())
+ * .setPageSize(883849137)
+ * .setPageToken("pageToken873572522")
+ * .build();
+ * while (true) {
+ * ListIcebergCatalogsResponse response =
+ * icebergCatalogServiceClient.listIcebergCatalogsCallable().call(request);
+ * for (IcebergCatalog element : response.getIcebergCatalogsList()) {
+ * // doThingsWith(element);
+ * }
+ * String nextPageToken = response.getNextPageToken();
+ * if (!Strings.isNullOrEmpty(nextPageToken)) {
+ * request = request.toBuilder().setPageToken(nextPageToken).build();
+ * } else {
+ * break;
+ * }
+ * }
+ * }
+ * }
+ */
+ public final UnaryCallableSample code: + * + *
{@code
+ * // 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 (IcebergCatalogServiceClient icebergCatalogServiceClient =
+ * IcebergCatalogServiceClient.create()) {
+ * IcebergCatalog icebergCatalog = IcebergCatalog.newBuilder().build();
+ * FieldMask updateMask = FieldMask.newBuilder().build();
+ * IcebergCatalog response =
+ * icebergCatalogServiceClient.updateIcebergCatalog(icebergCatalog, updateMask);
+ * }
+ * }
+ *
+ * @param icebergCatalog Required. The catalog to update.
+ * @param updateMask Optional. The list of fields to update.
+ * @throws com.google.api.gax.rpc.ApiException if the remote call fails
+ */
+ public final IcebergCatalog updateIcebergCatalog(
+ IcebergCatalog icebergCatalog, FieldMask updateMask) {
+ UpdateIcebergCatalogRequest request =
+ UpdateIcebergCatalogRequest.newBuilder()
+ .setIcebergCatalog(icebergCatalog)
+ .setUpdateMask(updateMask)
+ .build();
+ return updateIcebergCatalog(request);
+ }
+
+ // AUTO-GENERATED DOCUMENTATION AND METHOD.
+ /**
+ * Update the Iceberg REST Catalog configuration options.
+ *
+ * Sample code: + * + *
{@code
+ * // 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 (IcebergCatalogServiceClient icebergCatalogServiceClient =
+ * IcebergCatalogServiceClient.create()) {
+ * UpdateIcebergCatalogRequest request =
+ * UpdateIcebergCatalogRequest.newBuilder()
+ * .setIcebergCatalog(IcebergCatalog.newBuilder().build())
+ * .setUpdateMask(FieldMask.newBuilder().build())
+ * .build();
+ * IcebergCatalog response = icebergCatalogServiceClient.updateIcebergCatalog(request);
+ * }
+ * }
+ *
+ * @param request The request object containing all of the parameters for the API call.
+ * @throws com.google.api.gax.rpc.ApiException if the remote call fails
+ */
+ public final IcebergCatalog updateIcebergCatalog(UpdateIcebergCatalogRequest request) {
+ return updateIcebergCatalogCallable().call(request);
+ }
+
+ // AUTO-GENERATED DOCUMENTATION AND METHOD.
+ /**
+ * Update the Iceberg REST Catalog configuration options.
+ *
+ * Sample code: + * + *
{@code
+ * // 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 (IcebergCatalogServiceClient icebergCatalogServiceClient =
+ * IcebergCatalogServiceClient.create()) {
+ * UpdateIcebergCatalogRequest request =
+ * UpdateIcebergCatalogRequest.newBuilder()
+ * .setIcebergCatalog(IcebergCatalog.newBuilder().build())
+ * .setUpdateMask(FieldMask.newBuilder().build())
+ * .build();
+ * ApiFuture future =
+ * icebergCatalogServiceClient.updateIcebergCatalogCallable().futureCall(request);
+ * // Do something.
+ * IcebergCatalog response = future.get();
+ * }
+ * }
+ */
+ public final UnaryCallableIf the bucket does not exist, of the caller does not have bucket metadata permissions, the + * catalog will not be created. + * + *
Sample code: + * + *
{@code
+ * // 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 (IcebergCatalogServiceClient icebergCatalogServiceClient =
+ * IcebergCatalogServiceClient.create()) {
+ * ProjectName parent = ProjectName.of("[PROJECT]");
+ * IcebergCatalog icebergCatalog = IcebergCatalog.newBuilder().build();
+ * String icebergCatalogId = "icebergCatalogId504062865";
+ * IcebergCatalog response =
+ * icebergCatalogServiceClient.createIcebergCatalog(
+ * parent, icebergCatalog, icebergCatalogId);
+ * }
+ * }
+ *
+ * @param parent Required. The parent resource where this catalog will be created. Format:
+ * projects/{project_id}
+ * @param icebergCatalog Required. The catalog to create. The required fields for creation are: -
+ * catalog_type. Optionally: credential_mode can be provided, if Credential Vending is
+ * desired.
+ * @param icebergCatalogId Required. The name of the catalog.
+ * @throws com.google.api.gax.rpc.ApiException if the remote call fails
+ */
+ public final IcebergCatalog createIcebergCatalog(
+ ProjectName parent, IcebergCatalog icebergCatalog, String icebergCatalogId) {
+ CreateIcebergCatalogRequest request =
+ CreateIcebergCatalogRequest.newBuilder()
+ .setParent(parent == null ? null : parent.toString())
+ .setIcebergCatalog(icebergCatalog)
+ .setIcebergCatalogId(icebergCatalogId)
+ .build();
+ return createIcebergCatalog(request);
+ }
+
+ // AUTO-GENERATED DOCUMENTATION AND METHOD.
+ /**
+ * 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. + * + *
Sample code: + * + *
{@code
+ * // 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 (IcebergCatalogServiceClient icebergCatalogServiceClient =
+ * IcebergCatalogServiceClient.create()) {
+ * String parent = ProjectName.of("[PROJECT]").toString();
+ * IcebergCatalog icebergCatalog = IcebergCatalog.newBuilder().build();
+ * String icebergCatalogId = "icebergCatalogId504062865";
+ * IcebergCatalog response =
+ * icebergCatalogServiceClient.createIcebergCatalog(
+ * parent, icebergCatalog, icebergCatalogId);
+ * }
+ * }
+ *
+ * @param parent Required. The parent resource where this catalog will be created. Format:
+ * projects/{project_id}
+ * @param icebergCatalog Required. The catalog to create. The required fields for creation are: -
+ * catalog_type. Optionally: credential_mode can be provided, if Credential Vending is
+ * desired.
+ * @param icebergCatalogId Required. The name of the catalog.
+ * @throws com.google.api.gax.rpc.ApiException if the remote call fails
+ */
+ public final IcebergCatalog createIcebergCatalog(
+ String parent, IcebergCatalog icebergCatalog, String icebergCatalogId) {
+ CreateIcebergCatalogRequest request =
+ CreateIcebergCatalogRequest.newBuilder()
+ .setParent(parent)
+ .setIcebergCatalog(icebergCatalog)
+ .setIcebergCatalogId(icebergCatalogId)
+ .build();
+ return createIcebergCatalog(request);
+ }
+
+ // AUTO-GENERATED DOCUMENTATION AND METHOD.
+ /**
+ * 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. + * + *
Sample code: + * + *
{@code
+ * // 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 (IcebergCatalogServiceClient icebergCatalogServiceClient =
+ * IcebergCatalogServiceClient.create()) {
+ * CreateIcebergCatalogRequest request =
+ * CreateIcebergCatalogRequest.newBuilder()
+ * .setParent(ProjectName.of("[PROJECT]").toString())
+ * .setIcebergCatalogId("icebergCatalogId504062865")
+ * .setIcebergCatalog(IcebergCatalog.newBuilder().build())
+ * .build();
+ * IcebergCatalog response = icebergCatalogServiceClient.createIcebergCatalog(request);
+ * }
+ * }
+ *
+ * @param request The request object containing all of the parameters for the API call.
+ * @throws com.google.api.gax.rpc.ApiException if the remote call fails
+ */
+ public final IcebergCatalog createIcebergCatalog(CreateIcebergCatalogRequest request) {
+ return createIcebergCatalogCallable().call(request);
+ }
+
+ // AUTO-GENERATED DOCUMENTATION AND METHOD.
+ /**
+ * 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. + * + *
Sample code: + * + *
{@code
+ * // 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 (IcebergCatalogServiceClient icebergCatalogServiceClient =
+ * IcebergCatalogServiceClient.create()) {
+ * CreateIcebergCatalogRequest request =
+ * CreateIcebergCatalogRequest.newBuilder()
+ * .setParent(ProjectName.of("[PROJECT]").toString())
+ * .setIcebergCatalogId("icebergCatalogId504062865")
+ * .setIcebergCatalog(IcebergCatalog.newBuilder().build())
+ * .build();
+ * ApiFuture future =
+ * icebergCatalogServiceClient.createIcebergCatalogCallable().futureCall(request);
+ * // Do something.
+ * IcebergCatalog response = future.get();
+ * }
+ * }
+ */
+ public final UnaryCallableSample code: + * + *
{@code
+ * // 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 (IcebergCatalogServiceClient icebergCatalogServiceClient =
+ * IcebergCatalogServiceClient.create()) {
+ * String name = "name3373707";
+ * String primaryReplica = "primaryReplica-389090218";
+ * FailoverIcebergCatalogResponse response =
+ * icebergCatalogServiceClient.failoverIcebergCatalog(name, primaryReplica);
+ * }
+ * }
+ *
+ * @param name Required. The name of the catalog in the form
+ * "projects/{project_id}/catalogs/{catalog_id}"
+ * @param primaryReplica Required. The region being assigned as the new primary replica region.
+ * For example "us-east1". This must be one of the replica regions in the catalog's list of
+ * replicas marked as a "secondary".
+ * @throws com.google.api.gax.rpc.ApiException if the remote call fails
+ */
+ public final FailoverIcebergCatalogResponse failoverIcebergCatalog(
+ String name, String primaryReplica) {
+ FailoverIcebergCatalogRequest request =
+ FailoverIcebergCatalogRequest.newBuilder()
+ .setName(name)
+ .setPrimaryReplica(primaryReplica)
+ .build();
+ return failoverIcebergCatalog(request);
+ }
+
+ // AUTO-GENERATED DOCUMENTATION AND METHOD.
+ /**
+ * Failover the catalog to a new primary replica region.
+ *
+ * Sample code: + * + *
{@code
+ * // 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 (IcebergCatalogServiceClient icebergCatalogServiceClient =
+ * IcebergCatalogServiceClient.create()) {
+ * FailoverIcebergCatalogRequest request =
+ * FailoverIcebergCatalogRequest.newBuilder()
+ * .setName("name3373707")
+ * .setPrimaryReplica("primaryReplica-389090218")
+ * .setValidateOnly(true)
+ * .setConditionalFailoverReplicationTime(Timestamp.newBuilder().build())
+ * .build();
+ * FailoverIcebergCatalogResponse response =
+ * icebergCatalogServiceClient.failoverIcebergCatalog(request);
+ * }
+ * }
+ *
+ * @param request The request object containing all of the parameters for the API call.
+ * @throws com.google.api.gax.rpc.ApiException if the remote call fails
+ */
+ public final FailoverIcebergCatalogResponse failoverIcebergCatalog(
+ FailoverIcebergCatalogRequest request) {
+ return failoverIcebergCatalogCallable().call(request);
+ }
+
+ // AUTO-GENERATED DOCUMENTATION AND METHOD.
+ /**
+ * Failover the catalog to a new primary replica region.
+ *
+ * Sample code: + * + *
{@code
+ * // 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 (IcebergCatalogServiceClient icebergCatalogServiceClient =
+ * IcebergCatalogServiceClient.create()) {
+ * FailoverIcebergCatalogRequest request =
+ * FailoverIcebergCatalogRequest.newBuilder()
+ * .setName("name3373707")
+ * .setPrimaryReplica("primaryReplica-389090218")
+ * .setValidateOnly(true)
+ * .setConditionalFailoverReplicationTime(Timestamp.newBuilder().build())
+ * .build();
+ * ApiFuture future =
+ * icebergCatalogServiceClient.failoverIcebergCatalogCallable().futureCall(request);
+ * // Do something.
+ * FailoverIcebergCatalogResponse response = future.get();
+ * }
+ * }
+ */
+ public final UnaryCallableThe default instance has everything set to sensible defaults: + * + *
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 + * [RetrySettings](https://cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.retrying.RetrySettings) + * of getIcebergCatalog: + * + *
{@code
+ * // 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
+ * IcebergCatalogServiceSettings.Builder icebergCatalogServiceSettingsBuilder =
+ * IcebergCatalogServiceSettings.newBuilder();
+ * icebergCatalogServiceSettingsBuilder
+ * .getIcebergCatalogSettings()
+ * .setRetrySettings(
+ * icebergCatalogServiceSettingsBuilder
+ * .getIcebergCatalogSettings()
+ * .getRetrySettings()
+ * .toBuilder()
+ * .setInitialRetryDelayDuration(Duration.ofSeconds(1))
+ * .setInitialRpcTimeoutDuration(Duration.ofSeconds(5))
+ * .setMaxAttempts(5)
+ * .setMaxRetryDelayDuration(Duration.ofSeconds(30))
+ * .setMaxRpcTimeoutDuration(Duration.ofSeconds(60))
+ * .setRetryDelayMultiplier(1.3)
+ * .setRpcTimeoutMultiplier(1.5)
+ * .setTotalTimeoutDuration(Duration.ofSeconds(300))
+ * .build());
+ * IcebergCatalogServiceSettings icebergCatalogServiceSettings =
+ * icebergCatalogServiceSettingsBuilder.build();
+ * }
+ *
+ * Please refer to the [Client Side Retry
+ * Guide](https://github.com/googleapis/google-cloud-java/blob/main/docs/client_retries.md) for
+ * additional support in setting retries.
+ */
+@Generated("by gapic-generator-java")
+public class IcebergCatalogServiceSettings extends ClientSettingsNote: This method does not support applying settings to streaming methods.
+ */
+ public Builder applyToAllUnaryMethods(
+ ApiFunction The interfaces provided are listed below, along with usage samples.
+ *
+ * ======================= IcebergCatalogServiceClient =======================
+ *
+ * Service Description: 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.
+ *
+ * Sample for IcebergCatalogServiceClient:
+ *
+ * This class is for advanced usage.
+ */
+@Generated("by gapic-generator-java")
+public class GrpcIcebergCatalogServiceCallableFactory implements GrpcStubCallableFactory {
+
+ @Override
+ public This class is for advanced usage and reflects the underlying API directly.
+ */
+@Generated("by gapic-generator-java")
+public class GrpcIcebergCatalogServiceStub extends IcebergCatalogServiceStub {
+ private static final MethodDescriptor This class is for advanced usage.
+ */
+@Generated("by gapic-generator-java")
+public class HttpJsonIcebergCatalogServiceCallableFactory
+ implements HttpJsonStubCallableFactory This class is for advanced usage and reflects the underlying API directly.
+ */
+@Generated("by gapic-generator-java")
+public class HttpJsonIcebergCatalogServiceStub extends IcebergCatalogServiceStub {
+ private static final TypeRegistry typeRegistry = TypeRegistry.newBuilder().build();
+
+ private static final ApiMethodDescriptor This class is for advanced usage and reflects the underlying API directly.
+ */
+@Generated("by gapic-generator-java")
+public abstract class IcebergCatalogServiceStub implements BackgroundResource {
+
+ public UnaryCallable The default instance has everything set to sensible defaults:
+ *
+ * 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
+ * [RetrySettings](https://cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.retrying.RetrySettings)
+ * of getIcebergCatalog:
+ *
+ * Note: This method does not support applying settings to streaming methods.
+ */
+ public Builder applyToAllUnaryMethods(
+ ApiFunction{@code
+ * // 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 (IcebergCatalogServiceClient icebergCatalogServiceClient =
+ * IcebergCatalogServiceClient.create()) {
+ * CatalogName name = CatalogName.of("[PROJECT]", "[CATALOG]");
+ * IcebergCatalog response = icebergCatalogServiceClient.getIcebergCatalog(name);
+ * }
+ * }
+ */
+@Generated("by gapic-generator-java")
+package com.google.cloud.biglake.v1;
+
+import javax.annotation.Generated;
diff --git a/java-biglake/google-cloud-biglake/src/main/java/com/google/cloud/biglake/v1/stub/GrpcIcebergCatalogServiceCallableFactory.java b/java-biglake/google-cloud-biglake/src/main/java/com/google/cloud/biglake/v1/stub/GrpcIcebergCatalogServiceCallableFactory.java
new file mode 100644
index 000000000000..bdf30fc11364
--- /dev/null
+++ b/java-biglake/google-cloud-biglake/src/main/java/com/google/cloud/biglake/v1/stub/GrpcIcebergCatalogServiceCallableFactory.java
@@ -0,0 +1,113 @@
+/*
+ * Copyright 2025 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.google.cloud.biglake.v1.stub;
+
+import com.google.api.gax.grpc.GrpcCallSettings;
+import com.google.api.gax.grpc.GrpcCallableFactory;
+import com.google.api.gax.grpc.GrpcStubCallableFactory;
+import com.google.api.gax.rpc.BatchingCallSettings;
+import com.google.api.gax.rpc.BidiStreamingCallable;
+import com.google.api.gax.rpc.ClientContext;
+import com.google.api.gax.rpc.ClientStreamingCallable;
+import com.google.api.gax.rpc.OperationCallSettings;
+import com.google.api.gax.rpc.OperationCallable;
+import com.google.api.gax.rpc.PagedCallSettings;
+import com.google.api.gax.rpc.ServerStreamingCallSettings;
+import com.google.api.gax.rpc.ServerStreamingCallable;
+import com.google.api.gax.rpc.StreamingCallSettings;
+import com.google.api.gax.rpc.UnaryCallSettings;
+import com.google.api.gax.rpc.UnaryCallable;
+import com.google.longrunning.Operation;
+import com.google.longrunning.stub.OperationsStub;
+import javax.annotation.Generated;
+
+// AUTO-GENERATED DOCUMENTATION AND CLASS.
+/**
+ * gRPC callable factory implementation for the IcebergCatalogService service API.
+ *
+ *
+ *
+ *
+ * {@code
+ * // 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
+ * IcebergCatalogServiceStubSettings.Builder icebergCatalogServiceSettingsBuilder =
+ * IcebergCatalogServiceStubSettings.newBuilder();
+ * icebergCatalogServiceSettingsBuilder
+ * .getIcebergCatalogSettings()
+ * .setRetrySettings(
+ * icebergCatalogServiceSettingsBuilder
+ * .getIcebergCatalogSettings()
+ * .getRetrySettings()
+ * .toBuilder()
+ * .setInitialRetryDelayDuration(Duration.ofSeconds(1))
+ * .setInitialRpcTimeoutDuration(Duration.ofSeconds(5))
+ * .setMaxAttempts(5)
+ * .setMaxRetryDelayDuration(Duration.ofSeconds(30))
+ * .setMaxRpcTimeoutDuration(Duration.ofSeconds(60))
+ * .setRetryDelayMultiplier(1.3)
+ * .setRpcTimeoutMultiplier(1.5)
+ * .setTotalTimeoutDuration(Duration.ofSeconds(300))
+ * .build());
+ * IcebergCatalogServiceStubSettings icebergCatalogServiceSettings =
+ * icebergCatalogServiceSettingsBuilder.build();
+ * }
+ *
+ * Please refer to the [Client Side Retry
+ * Guide](https://github.com/googleapis/google-cloud-java/blob/main/docs/client_retries.md) for
+ * additional support in setting retries.
+ */
+@Generated("by gapic-generator-java")
+public class IcebergCatalogServiceStubSettings
+ extends StubSettings