gcloud beta biglake iceberg catalogs update

NAME
gcloud beta biglake iceberg catalogs update - update a BigLake Iceberg REST catalog
SYNOPSIS
gcloud beta biglake iceberg catalogs update CATALOG [--catalog-type=CATALOG_TYPE] [--credential-mode=CREDENTIAL_MODE; default="end-user"] [--description=DESCRIPTION] [--glue-aws-role-arn=GLUE_AWS_ROLE_ARN] [--namespace-filters=[NAMESPACE,…]] [--refresh-interval=REFRESH_INTERVAL] [--restricted-locations=[LOCATION,…]] [--secret-name=SECRET_NAME] [--unity-service-principal-application-id=UNITY_SERVICE_PRINCIPAL_APPLICATION_ID] [GCLOUD_WIDE_FLAG]
DESCRIPTION
(BETA) Update a BigLake Iceberg REST catalog.
EXAMPLES
To update the description of a catalog my-catalog, run:
gcloud beta biglake iceberg catalogs update my-catalog --description="updated description"
To update the refresh interval and namespace filters for a federated catalog my-federated-catalog, run:
gcloud beta biglake iceberg catalogs update my-federated-catalog --refresh-interval=1h --namespace-filters=db1,db2
POSITIONAL ARGUMENTS
Catalog resource - The Iceberg Catalog to update. This represents a Cloud resource. (NOTE) Some attributes are not given arguments in this group but can be set in other ways.

To set the project attribute:

  • provide the argument catalog on the command line with a fully specified name;
  • provide the argument --project on the command line;
  • set the property core/project.

This must be specified.

CATALOG
ID of the catalog or fully qualified identifier for the catalog.

To set the catalog attribute:

  • provide the argument catalog on the command line.
FLAGS
--catalog-type=CATALOG_TYPE
Catalog type to update the catalog with. Currently only updating to a BigLake catalog type is supported. CATALOG_TYPE must be (only one value is supported):
biglake
BigLake Iceberg catalog. Catalog type which allows namespaces and tables within a catalog to be mapped to locations beyond the catalog's designated default.
--credential-mode=CREDENTIAL_MODE; default="end-user"
Credential mode to create the catalog with. CREDENTIAL_MODE must be one of:
end-user
Use end user credentials to access the catalog.
vended-credentials
Use vended credentials to access the catalog.
--description=DESCRIPTION
Description of the resource.
--glue-aws-role-arn=GLUE_AWS_ROLE_ARN
The AWS role ARN of the Glue catalog that the BigLake federated catalog will assume to access the catalog.
--namespace-filters=[NAMESPACE,…]
Filters to determine which namespaces are included in the refresh process. Empty list means include all namespaces.
--refresh-interval=REFRESH_INTERVAL
Interval for refreshing metadata from the remote catalog (e.g., "1hr5m30s"). Defaults to seconds if no unit is specified. If unset, the refresh interval will be set to 0s (background refresh disabled).
--restricted-locations=[LOCATION,…]
Additional Google Cloud Storage buckets and locations (e.g., gs://my-other-bucket/…) that are permitted for use by resources within a catalog. This field is currently only used for BigLake catalogs.If restricted_locations is empty and unrestricted catalog creation is enabled, all accessible locations are allowed. Otherwise, only default_location and locations in this list are allowed.
--secret-name=SECRET_NAME
Resource name of the Secret Manager secret, in the format projects/{project_id}/locations/{location}/secrets/{secret_id} or projects/{project_id}/locations/{location}/secrets/{secret_id}/versions/{version_id}.
--unity-service-principal-application-id=UNITY_SERVICE_PRINCIPAL_APPLICATION_ID
Optional. The application ID of the Databricks service principal that will be used to access the Unity Catalog in the OIDC authentication flow. With OIDC, the secret-name argument is not used.
GCLOUD WIDE FLAGS
These flags are available to all commands: --access-token-file, --account, --billing-project, --configuration, --flags-file, --flatten, --format, --help, --impersonate-service-account, --log-http, --project, --quiet, --trace-token, --user-output-enabled, --verbosity.

Run $ gcloud help for details.

NOTES
This command is currently in beta and might change without notice. These variants are also available:
gcloud biglake iceberg catalogs update
gcloud alpha biglake iceberg catalogs update