gcloud: Thu Sep 7 10:42:28 UTC 2023

gcloud/alpha/firestore/backups/delete

@@ -0,0 +1,44 @@
+NAME
+    gcloud alpha firestore backups delete - deletes a Cloud Firestore backup
+
+SYNOPSIS
+    gcloud alpha firestore backups delete --backup=BACKUP --location=LOCATION
+        [GCLOUD_WIDE_FLAG ...]
+
+EXAMPLES
+    To delete cf9f748a-7980-4703-b1a1-d1ffff591db0 backup in us-east1.
+
+        $ gcloud alpha firestore backups delete --location=us-east1 \
+          --backup=cf9f748a-7980-4703-b1a1-d1ffff591db0
+
+REQUIRED FLAGS
+     --backup=BACKUP
+        The backup to operate on.
+
+        For example, to operate on backup cf9f748a-7980-4703-b1a1-d1ffff591db0:
+
+            $ gcloud alpha firestore backups delete \
+                --backup='cf9f748a-7980-4703-b1a1-d1ffff591db0'
+
+     --location=LOCATION
+        The location to operate on. Available locations are listed at
+        https://cloud.google.com/firestore/docs/locations.
+
+        For example, to operate on location us-east1:
+
+            $ gcloud alpha firestore backups delete --location='us-east1'
+
+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 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.
+

gcloud/alpha/firestore/backups/describe

@@ -0,0 +1,46 @@
+NAME
+    gcloud alpha firestore backups describe - retrieves information about a
+        Cloud Firestore backup
+
+SYNOPSIS
+    gcloud alpha firestore backups describe --backup=BACKUP --location=LOCATION
+        [GCLOUD_WIDE_FLAG ...]
+
+EXAMPLES
+    To retrieve information about the cf9f748a-7980-4703-b1a1-d1ffff591db0
+    backup in us-east1.
+
+        $ gcloud alpha firestore backups describe --location=us-east1 \
+          --backup=cf9f748a-7980-4703-b1a1-d1ffff591db0
+
+REQUIRED FLAGS
+     --backup=BACKUP
+        The backup to operate on.
+
+        For example, to operate on backup cf9f748a-7980-4703-b1a1-d1ffff591db0:
+
+            $ gcloud alpha firestore backups describe \
+                --backup='cf9f748a-7980-4703-b1a1-d1ffff591db0'
+
+     --location=LOCATION
+        The location to operate on. Available locations are listed at
+        https://cloud.google.com/firestore/docs/locations.
+
+        For example, to operate on location us-east1:
+
+            $ gcloud alpha firestore backups describe --location='us-east1'
+
+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 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.
+

gcloud/alpha/firestore/backups/help

@@ -0,0 +1,39 @@
+NAME
+    gcloud alpha firestore backups - the set of commands to manage backups for
+        Cloud Firestore
+
+SYNOPSIS
+    gcloud alpha firestore backups GROUP | COMMAND [GCLOUD_WIDE_FLAG ...]
+
+DESCRIPTION
+    (ALPHA) The set of commands to manage backups for Cloud Firestore.
+
+GCLOUD WIDE FLAGS
+    These flags are available to all commands: --help.
+
+    Run $ gcloud help for details.
+
+GROUPS
+    GROUP is one of the following:
+
+     schedules
+        (ALPHA) Manage the backup schedules for a Cloud Firestore Database.
+
+COMMANDS
+    COMMAND is one of the following:
+
+     delete
+        (ALPHA) Deletes a Cloud Firestore backup.
+
+     describe
+        (ALPHA) Retrieves information about a Cloud Firestore backup.
+
+     list
+        (ALPHA) List backups available to Cloud Firestore.
+
+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.
+

gcloud/alpha/firestore/backups/list

@@ -0,0 +1,75 @@
+NAME
+    gcloud alpha firestore backups list - list backups available to Cloud
+        Firestore
+
+SYNOPSIS
+    gcloud alpha firestore backups list [--location=LOCATION]
+        [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE]
+        [--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...]
+
+EXAMPLES
+    To list all backups in location us-east1.
+
+        $ gcloud alpha firestore backups list --location=us-east1 \
+          --format="table(name, database, state)"
+
+    To list all backups in all location.
+
+        $ gcloud alpha firestore backups list \
+          --format="table(name, database, state)"
+
+FLAGS
+     --location=LOCATION
+        The location to operate on. Available locations are listed at
+        https://cloud.google.com/firestore/docs/locations.
+
+        For example, to operate on location us-east1:
+
+            $ gcloud alpha firestore backups list --location='us-east1'
+
+LIST COMMAND FLAGS
+     --filter=EXPRESSION
+        Apply a Boolean filter EXPRESSION to each resource item to be listed.
+        If the expression evaluates True, then that item is listed. For more
+        details and examples of filter expressions, run $ gcloud topic filters.
+        This flag interacts with other flags that are applied in this order:
+        --flatten, --sort-by, --filter, --limit.
+
+     --limit=LIMIT
+        Maximum number of resources to list. The default is unlimited. This
+        flag interacts with other flags that are applied in this order:
+        --flatten, --sort-by, --filter, --limit.
+
+     --page-size=PAGE_SIZE
+        Some services group resource list output into pages. This flag
+        specifies the maximum number of resources per page. The default is
+        determined by the service if it supports paging, otherwise it is
+        unlimited (no paging). Paging may be applied before or after --filter
+        and --limit depending on the service.
+
+     --sort-by=[FIELD,...]
+        Comma-separated list of resource field key names to sort by. The
+        default order is ascending. Prefix a field with ``~'' for descending
+        order on that field. This flag interacts with other flags that are
+        applied in this order: --flatten, --sort-by, --filter, --limit.
+
+     --uri
+        Print a list of resource URIs instead of the default output, and change
+        the command output to a list of URIs. If this flag is used with
+        --format, the formatting is applied on this URI list. To display URIs
+        alongside other keys instead, use the uri() transform.
+
+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 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.
+

gcloud/alpha/firestore/backups/schedules/create

@@ -0,0 +1,85 @@
+NAME
+    gcloud alpha firestore backups schedules create - creates a Cloud Firestore
+        backup schedule
+
+SYNOPSIS
+    gcloud alpha firestore backups schedules create --database=DATABASE
+        --retention=RETENTION
+        (--recurrence=RECURRENCE : --day-of-week=DAY_OF_WEEK)
+        [GCLOUD_WIDE_FLAG ...]
+
+EXAMPLES
+    To create a backup schedule with 7 days retention and daily recurrence
+    under database testdb.
+
+        $ gcloud alpha firestore backups schedules create \
+          --database=testdb --retention=7d --recurrence=daily
+
+    To create a backup schedule with 7 days retention and weekly recurrence on
+    Monday under database testdb.
+
+        $ gcloud alpha firestore backups schedules create \
+          --database=testdb --retention=7d --recurrence=weekly \
+          --day-of-week=MON
+
+REQUIRED FLAGS
+     --database=DATABASE
+        The database to operate on. The default value is (default).
+
+        For example, to operate on database foo:
+
+            $ gcloud alpha firestore backups schedules create --database='foo'
+
+     --retention=RETENTION
+        The rention of the backup. At what relative time in the future,
+        compared to the creation time of the backup should the backup be
+        deleted, i.e. keep backups for 7 days.
+
+        For example, to set retention as 7 days.
+
+            $ gcloud alpha firestore backups schedules create --retention=7d
+
+     Recurrence settings of a backup schedule.
+
+     This must be specified.
+
+       --recurrence=RECURRENCE
+          The recurrence settings of a backup schedule.
+
+          Currently only daily and weekly backup schedules are supported.
+
+          When a weekly backup schedule is created, day-of-week is needed.
+
+          For example, to create a weekly backup schedule which creates backups
+          on Monday.
+
+              $ gcloud alpha firestore backups schedules create \
+                  --recurrence=weekly --day-of-week=MON
+
+          This flag argument must be specified if any of the other arguments in
+          this group are specified.
+
+       --day-of-week=DAY_OF_WEEK
+          The day of week (UTC time zone) of when backups are created.
+
+              The available values are: `MON`, `TUE`, `WED`, `THU`, `FRI`, `SAT`,`SUN`.
+              Values are case insensitive.
+
+              This is required when creating a weekly backup schedule.
+
+          DAY_OF_WEEK must be one of: SUN, MON, TUE, WED, THU, FRI, SAT.
+
+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 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.
+

gcloud/alpha/firestore/backups/schedules/delete

@@ -0,0 +1,48 @@
+NAME
+    gcloud alpha firestore backups schedules delete - deletes a Cloud Firestore
+        backup schedule
+
+SYNOPSIS
+    gcloud alpha firestore backups schedules delete
+        --backup-schedule=BACKUP_SCHEDULE --database=DATABASE
+        [GCLOUD_WIDE_FLAG ...]
+
+EXAMPLES
+    To delete backup schedule 'cf9f748a-7980-4703-b1a1-d1ffff591db0' under
+    database testdb.
+
+        $ gcloud alpha firestore backups schedules delete \
+          --database='testdb' \
+          --backup-schedule='cf9f748a-7980-4703-b1a1-d1ffff591db0'
+
+REQUIRED FLAGS
+     --backup-schedule=BACKUP_SCHEDULE
+        The backup schedule to operate on.
+
+        For example, to operate on backup schedule
+        091a49a0-223f-4c98-8c69-a284abbdb26b:
+
+            $ gcloud alpha firestore backups schedules delete \
+                --backup-schedule='091a49a0-223f-4c98-8c69-a284abbdb26b'
+
+     --database=DATABASE
+        The database to operate on. The default value is (default).
+
+        For example, to operate on database foo:
+
+            $ gcloud alpha firestore backups schedules delete --database='foo'
+
+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 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.
+

gcloud/alpha/firestore/backups/schedules/describe

@@ -0,0 +1,48 @@
+NAME
+    gcloud alpha firestore backups schedules describe - describes a Cloud
+        Firestore backup schedule
+
+SYNOPSIS
+    gcloud alpha firestore backups schedules describe
+        --backup-schedule=BACKUP_SCHEDULE --database=DATABASE
+        [GCLOUD_WIDE_FLAG ...]
+
+EXAMPLES
+    To describe backup schedule 'cf9f748a-7980-4703-b1a1-d1ffff591db0' under
+    database testdb.
+
+        $ gcloud alpha firestore backups schedules describe \
+          --database='testdb' \
+          --backup-schedule='cf9f748a-7980-4703-b1a1-d1ffff591db0'
+
+REQUIRED FLAGS
+     --backup-schedule=BACKUP_SCHEDULE
+        The backup schedule to operate on.
+
+        For example, to operate on backup schedule
+        091a49a0-223f-4c98-8c69-a284abbdb26b:
+
+            $ gcloud alpha firestore backups schedules describe \
+                --backup-schedule='091a49a0-223f-4c98-8c69-a284abbdb26b'
+
+     --database=DATABASE
+        The database to operate on. The default value is (default).
+
+        For example, to operate on database foo:
+
+            $ gcloud alpha firestore backups schedules describe --database='foo'
+
+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 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.
+

gcloud/alpha/firestore/backups/schedules/help

@@ -0,0 +1,39 @@
+NAME
+    gcloud alpha firestore backups schedules - manage the backup schedules for
+        a Cloud Firestore Database
+
+SYNOPSIS
+    gcloud alpha firestore backups schedules COMMAND [GCLOUD_WIDE_FLAG ...]
+
+DESCRIPTION
+    (ALPHA) Manage the backup schedules for a Cloud Firestore Database.
+
+GCLOUD WIDE FLAGS
+    These flags are available to all commands: --help.
+
+    Run $ gcloud help for details.
+
+COMMANDS
+    COMMAND is one of the following:
+
+     create
+        (ALPHA) Creates a Cloud Firestore backup schedule.
+
+     delete
+        (ALPHA) Deletes a Cloud Firestore backup schedule.
+
+     describe
+        (ALPHA) Describes a Cloud Firestore backup schedule.
+
+     list
+        (ALPHA) Lists backup schedules under a Cloud Firesore database.
+
+     update
+        (ALPHA) Updates a Cloud Firestore backup schedule.
+
+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.
+

gcloud/alpha/firestore/backups/schedules/list

@@ -0,0 +1,68 @@
+NAME
+    gcloud alpha firestore backups schedules list - lists backup schedules
+        under a Cloud Firesore database
+
+SYNOPSIS
+    gcloud alpha firestore backups schedules list --database=DATABASE
+        [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE]
+        [--sort-by=[FIELD,...]] [--uri] [GCLOUD_WIDE_FLAG ...]
+
+EXAMPLES
+    To list all backup schedules under database testdb.
+
+        $ gcloud alpha firestore backups schedules list --database='testdb'
+
+REQUIRED FLAGS
+     --database=DATABASE
+        The database to operate on. The default value is (default).
+
+        For example, to operate on database foo:
+
+            $ gcloud alpha firestore backups schedules list --database='foo'
+
+LIST COMMAND FLAGS
+     --filter=EXPRESSION
+        Apply a Boolean filter EXPRESSION to each resource item to be listed.
+        If the expression evaluates True, then that item is listed. For more
+        details and examples of filter expressions, run $ gcloud topic filters.
+        This flag interacts with other flags that are applied in this order:
+        --flatten, --sort-by, --filter, --limit.
+
+     --limit=LIMIT
+        Maximum number of resources to list. The default is unlimited. This
+        flag interacts with other flags that are applied in this order:
+        --flatten, --sort-by, --filter, --limit.
+
+     --page-size=PAGE_SIZE
+        Some services group resource list output into pages. This flag
+        specifies the maximum number of resources per page. The default is
+        determined by the service if it supports paging, otherwise it is
+        unlimited (no paging). Paging may be applied before or after --filter
+        and --limit depending on the service.
+
+     --sort-by=[FIELD,...]
+        Comma-separated list of resource field key names to sort by. The
+        default order is ascending. Prefix a field with ``~'' for descending
+        order on that field. This flag interacts with other flags that are
+        applied in this order: --flatten, --sort-by, --filter, --limit.
+
+     --uri
+        Print a list of resource URIs instead of the default output, and change
+        the command output to a list of URIs. If this flag is used with
+        --format, the formatting is applied on this URI list. To display URIs
+        alongside other keys instead, use the uri() transform.
+
+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 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.
+

gcloud/alpha/firestore/backups/schedules/update

@@ -0,0 +1,59 @@
+NAME
+    gcloud alpha firestore backups schedules update - updates a Cloud Firestore
+        backup schedule
+
+SYNOPSIS
+    gcloud alpha firestore backups schedules update
+        --backup-schedule=BACKUP_SCHEDULE --database=DATABASE
+        [--retention=RETENTION] [GCLOUD_WIDE_FLAG ...]
+
+EXAMPLES
+    To update backup schedule 'cf9f748a-7980-4703-b1a1-d1ffff591db0' under
+    database testdb to 7 days retention.
+
+        $ gcloud alpha firestore backups schedules update \
+          --database='testdb' \
+          --backup-schedule='cf9f748a-7980-4703-b1a1-d1ffff591db0' \
+          --retention='7d'
+
+REQUIRED FLAGS
+     --backup-schedule=BACKUP_SCHEDULE
+        The backup schedule to operate on.
+
+        For example, to operate on backup schedule
+        091a49a0-223f-4c98-8c69-a284abbdb26b:
+
+            $ gcloud alpha firestore backups schedules update \
+                --backup-schedule='091a49a0-223f-4c98-8c69-a284abbdb26b'
+
+     --database=DATABASE
+        The database to operate on. The default value is (default).
+
+        For example, to operate on database foo:
+
+            $ gcloud alpha firestore backups schedules update --database='foo'
+
+OPTIONAL FLAGS
+     --retention=RETENTION
+        The rention of the backup. At what relative time in the future,
+        compared to the creation time of the backup should the backup be
+        deleted, i.e. keep backups for 7 days.
+
+        For example, to set retention as 7 days.
+
+            $ gcloud alpha firestore backups schedules update --retention=7d
+
+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 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.
+

gcloud/alpha/firestore/databases/help

@@ -28,6 +28,9 @@ COMMANDS
      list
         (ALPHA) Lists all Firestore databases under the project.
 
+     restore
+        (ALPHA) Restores a Cloud Firestore database from a backup.
+
      update
         (ALPHA) Update the database configuration of a Cloud Firestore
         database.

gcloud/alpha/firestore/databases/restore

@@ -0,0 +1,50 @@
+NAME
+    gcloud alpha firestore databases restore - restores a Cloud Firestore
+        database from a backup
+
+SYNOPSIS
+    gcloud alpha firestore databases restore
+        --destination-database=DESTINATION_DATABASE
+        --source-backup=SOURCE_BACKUP [GCLOUD_WIDE_FLAG ...]
+
+EXAMPLES
+    To restore a database from a backup.
+
+        $ gcloud alpha firestore databases restore \
+          --source-backup=projects/PROJECT_ID/locations/LOCATION_ID/\
+        backups/BACKUP_ID --destination-database=DATABASE_ID
+
+REQUIRED FLAGS
+     --destination-database=DESTINATION_DATABASE
+        Destination database to restore to. Destination database will be
+        created in the same location as the source backup.
+
+        For example, to restore to database testdb:
+
+            $ gcloud alpha firestore databases restore \
+                --destination-database=testdb
+
+     --source-backup=SOURCE_BACKUP
+        The source backup to restore from.
+
+        For example, to restore from backup
+        cf9f748a-7980-4703-b1a1-d1ffff591db0 in us-east1:
+
+            $ gcloud alpha firestore databases restore \
+                --source-backup=projects/PROJECT_ID/locations/us-east1/backups/\
+            cf9f748a-7980-4703-b1a1-d1ffff591db0
+
+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 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.
+

gcloud/alpha/firestore/help

@@ -21,6 +21,9 @@ GCLOUD WIDE FLAGS
 GROUPS
     GROUP is one of the following:
 
+     backups
+        (ALPHA) The set of commands to manage backups for Cloud Firestore.
+
      databases
         (ALPHA) Manage Creation of Cloud Firestore in Native mode Database.