gcloud spanner backups update-metadata

NAME
gcloud spanner backups update-metadata - updates the metadata of a Cloud Spanner a backup
SYNOPSIS
gcloud spanner backups update-metadata(BACKUP :--instance=INSTANCE)(--expiration-date=EXPIRATION_DATE    |--retention-period=RETENTION_PERIOD)[GCLOUD_WIDE_FLAG]
DESCRIPTION
Updates the metadata of a Cloud Spanner a backup.
EXAMPLES
To update the backup metadata with an exact expiration date, run:
gcloudspannerbackupsupdate-metadataBACKUP_ID--instance=INSTANCE_NAME--expiration-date=2020-03-29T10:49:41Z

To update the backup metadata with a retention period, run:

gcloudspannerbackupsupdate-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 theproject attribute:

  • provide the argumentbackup on the command line with a fullyspecified name;
  • provide the argument--project on the command line;
  • set the propertycore/project.

This must be specified.

BACKUP
ID of the backup or fully qualified identifier for the backup.

To set thebackup attribute:

  • provide the argumentbackup on the command line.

This positional argument must be specified if any of the other arguments in thisgroup are specified.

--instance=INSTANCE
The name of the Cloud Spanner instance.To set theinstance attribute:
  • provide the argumentbackup on the command line with a fullyspecified name;
  • provide the argument--instance on the command line;
  • set the propertyspanner/instance.
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.
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 thespanner/v1 API. The full documentation forthis API can be found at:https://cloud.google.com/spanner/
NOTES
These variants are also available:
gcloudalphaspannerbackupsupdate-metadata
gcloudbetaspannerbackupsupdate-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.