gcloud: Wed Mar 6 09:53:10 UTC 2024

2026-07-22 15:52:30 +00:00 · 2024-03-06 09:53:10 +00:00 · 2024-03-06 09:53:10 +00:00 · 7f632e0c5d
commit 7f632e0c5d
parent 37dd57701a
115 changed files with 5800 additions and 308 deletions
--- a/gcloud/alpha/bigtable/tables/update
+++ b/gcloud/alpha/bigtable/tables/update
@ -0,0 +1,128 @@
+NAME
+    gcloud alpha bigtable tables update - update an existing Cloud Bigtable
+        table
+
+SYNOPSIS
+    gcloud alpha bigtable tables update (TABLE : --instance=INSTANCE) [--async]
+        [--deletion-protection] [--disable-automated-backup]
+        [--enable-automated-backup]
+        [--change-stream-retention-period=CHANGE_STREAM_RETENTION_PERIOD
+          | --clear-change-stream-retention-period] [GCLOUD_WIDE_FLAG ...]
+
+DESCRIPTION
+    (ALPHA) Update an existing new Cloud Bigtable table with the specified
+    configuration.
+
+EXAMPLES
+    To enable deletion protection, run:
+
+        $ gcloud alpha bigtable tables update my-table \
+            --instance=my-instance --deletion-protection
+
+    To disable deletion protection, run:
+
+        $ gcloud alpha bigtable tables update my-table \
+            --instance=my-instance --no-deletion-protection
+
+    To enable a change stream with a retention period of 1 day, or to update
+    your table's change stream retention period to 1 day, run:
+
+        $ gcloud alpha bigtable tables update my-table \
+            --instance=my-instance --change-stream-retention-period=1d
+
+    To disable a change stream, run:
+
+        $ gcloud alpha bigtable tables update my-table \
+            --instance=my-instance --clear-change-stream-retention-period
+
+    To enable default automated backup policy (retention_period=72h,
+    frequency=24h), run:
+
+        $ gcloud alpha bigtable tables update my-table \
+            --instance=my-instance --enable-automated-backup
+
+    To disable automated backup: run:
+
+        $ gcloud alpha bigtable tables update my-table \
+            --instance=my-instance --disable-automated-backup
+
+POSITIONAL ARGUMENTS
+     Table resource - Cloud Bigtable table to update. The arguments in this
+     group can be used to specify the attributes of this 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 table 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.
+
+       TABLE
+          ID of the table or fully qualified identifier for the table.
+
+          To set the table attribute:
+          ▸ provide the argument table on the command line.
+
+          This positional argument must be specified if any of the other
+          arguments in this group are specified.
+
+       --instance=INSTANCE
+          Name of the Cloud Bigtable instance.
+
+          To set the instance attribute:
+          ▸ provide the argument table on the command line with a fully
+            specified name;
+          ▸ provide the argument --instance on the command line.
+
+FLAGS
+     --async
+        Return immediately, without waiting for the operation in progress to
+        complete.
+
+     --deletion-protection
+        Once specified, the table is deletion protected.
+
+     --disable-automated-backup
+        Once set, disables automated backup policy for the table.
+
+     --enable-automated-backup
+        Once set, enables the default automated backup policy
+        (retention_period=72h, frequency=24h) for the table.
+
+     At most one of these can be specified:
+
+       --change-stream-retention-period=CHANGE_STREAM_RETENTION_PERIOD
+          The length of time to retain change stream data for the table, in the
+          range of [1 day, 7 days]. Acceptable units are days (d), hours (h),
+          minutes (m), and seconds (s). If not already specified, enables a
+          change stream for the table. Examples: 5d or 48h.
+
+       --clear-change-stream-retention-period
+          This disables the change stream and eventually removes the change
+          stream data.
+
+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.
+
+API REFERENCE
+    This command uses the bigtableadmin/v2 API. The full documentation for this
+    API can be found at: https://cloud.google.com/bigtable/
+
+NOTES
+    This command is currently in alpha and might change without notice. If this
+    command fails with API permission errors despite specifying the correct
+    project, you might be trying to access an API with an invitation-only early
+    access allowlist. These variants are also available:
+
+        $ gcloud bigtable tables update
+
+        $ gcloud beta bigtable tables update
+