gcloud biglake iceberg catalogs update

NAME
gcloud biglake iceberg catalogs update - update a BigLake Iceberg REST catalog
SYNOPSIS
gcloud biglake iceberg catalogs update CATALOG [--catalog-type=CATALOG_TYPE] [--credential-mode=CREDENTIAL_MODE; default="end-user"] [--cross-cloud-cache=CROSS_CLOUD_CACHE] [--description=DESCRIPTION] [--restricted-locations=[LOCATION,…]] [--kms-key=KMS_KEY : --kms-keyring=KMS_KEYRING --kms-location=KMS_LOCATION --kms-project=KMS_PROJECT] [GCLOUD_WIDE_FLAG …]
DESCRIPTION
Update a BigLake Iceberg REST catalog.
EXAMPLES
To update the description of a catalog my-catalog, run: 
gcloud biglake iceberg catalogs update my-catalog --description="updated description"

To update a catalog my-lakehouse-catalog to catalog type lakehouse with restricted locations, run: 

gcloud biglake iceberg catalogs update my-lakehouse-catalog --catalog-type=lakehouse --restricted-locations=gs://my-bucket1,gs://my-bucket2 To update a catalog `my-lakehouse-catalog` to enable cross-cloud cache, run:
 
gcloud biglake iceberg catalogs update my-lakehouse-catalog --cross-cloud-cache=enabled

To update the Cloud KMS key of a catalog my-catalog, run: 

gcloud biglake iceberg catalogs update my-catalog --kms-key=projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-new-key
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 or Lakehouse catalog type is supported. CATALOG_TYPE must be one of:
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. Note: biglake and lakehouse catalog types are the same.
lakehouse
BigLake Iceberg catalog. Catalog type which allows namespaces and tables within a catalog to be mapped to locations beyond the catalog's designated default. Note: biglake and lakehouse catalog types are the same.
--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.
--cross-cloud-cache=CROSS_CLOUD_CACHE
Whether to enable caching of remote data on Google Cloud. This may result in data being temporarily persisted on Google Cloud. CROSS_CLOUD_CACHE must be one of: enabled, disabled.
--description=DESCRIPTION
Description of the resource.
--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.
Key resource - The Cloud KMS (Key Management Service) cryptokey that will be used to protect the catalog. The BigQuery encryption service account (bq-<project_number>@bigquery-encryption.iam.gserviceaccount.com) must hold permission 'Cloud KMS CryptoKey Encrypter/Decrypter'. The arguments in this group can be used to specify the attributes of this resource.
--kms-key=KMS_KEY
ID of the key or fully qualified identifier for the key.

To set the kms-key attribute:

  • provide the argument --kms-key on the command line.

This flag argument must be specified if any of the other arguments in this group are specified.

--kms-keyring=KMS_KEYRING
The KMS keyring of the key.

To set the kms-keyring attribute:

  • provide the argument --kms-key on the command line with a fully specified name;
  • provide the argument --kms-keyring on the command line.
--kms-location=KMS_LOCATION
The Google Cloud location for the key.

To set the kms-location attribute:

  • provide the argument --kms-key on the command line with a fully specified name;
  • provide the argument --kms-location on the command line.
--kms-project=KMS_PROJECT
The Google Cloud project for the key.

To set the kms-project attribute:

  • provide the argument --kms-key on the command line with a fully specified name;
  • provide the argument --kms-project on the command line;
  • set the property core/project.
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
These variants are also available: 
gcloud alpha biglake iceberg catalogs update
 
gcloud beta biglake iceberg catalogs update