gcloud alpha spanner backups update-metadata Stay organized with collections Save and categorize content based on your preferences.
- NAME
- gcloud alpha spanner backups update-metadata - updates the metadata of a Cloud Spanner a backup
- SYNOPSIS
gcloud alpha spanner backups update-metadata(BACKUP:--instance=INSTANCE)(--expiration-date=EXPIRATION_DATE|--retention-period=RETENTION_PERIOD)[GCLOUD_WIDE_FLAG …]
- DESCRIPTION
(ALPHA)Updates the metadata of a Cloud Spanner a backup.- EXAMPLES
- To update the backup metadata with an exact expiration date, run:
gcloudalphaspannerbackupsupdate-metadataBACKUP_ID--instance=INSTANCE_NAME--expiration-date=2020-03-29T10:49:41ZTo update the backup metadata with a retention period, run:
gcloudalphaspannerbackupsupdate-metadataBACKUP_ID--instance=INSTANCE_NAME--retention-period=2w - POSITIONAL ARGUMENTS
- Backup resource - The Cloud Spanner backup to update. The arguments in thisgroup can be used to specify the attributes of this resource. (NOTE) Someattributes are not given arguments in this group but can be set in other ways.
To set the
projectattribute:- provide the argument
backupon the command line with a fullyspecified name; - provide the argument
--projecton the command line; - set the property
core/project.
This must be specified.
BACKUP- ID of the backup or fully qualified identifier for the backup.
To set the
backupattribute:- provide the argument
backupon the command line.
This positional argument must be specified if any of the other arguments in thisgroup are specified.
- provide the argument
--instance=INSTANCE- The name of the Cloud Spanner instance.To set the
instanceattribute:- provide the argument
backupon the command line with a fullyspecified name; - provide the argument
--instanceon the command line; - set the property
spanner/instance.
- provide the argument
- provide the argument
- Backup resource - The Cloud Spanner backup to update. The arguments in thisgroup can be used to specify the attributes of this resource. (NOTE) Someattributes are not given arguments in this group but can be set in other ways.
- REQUIRED FLAGS
- Exactly one of these must be specified:
--expiration-date=EXPIRATION_DATE- Expiration time of the backup, must be at least 6 hours and at most 366 daysfrom the time of creation. See
$gcloud topic datetimesfor information on date/time formats. --retention-period=RETENTION_PERIOD- Retention period of the backup relative from now, must be at least 6 hours andat most a year from the time of creation. See
$gcloud topic datetimesfor information on duration formats.
- Exactly one of these must be specified:
- 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 helpfor details. - API REFERENCE
- This command uses the
spanner/v1API. The full documentation forthis API can be found at:https://cloud.google.com/spanner/ - NOTES
- This command is currently in alpha and might change without notice. If thiscommand fails with API permission errors despite specifying the correct project,you might be trying to access an API with an invitation-only early accessallowlist. These variants are also available:
gcloudspannerbackupsupdate-metadatagcloudbetaspannerbackupsupdate-metadata
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-05-07 UTC.