File: //snap/google-cloud-cli/396/help/man/man1/gcloud_alpha_spanner_backups_describe.1
.TH "GCLOUD_ALPHA_SPANNER_BACKUPS_DESCRIBE" 1
.SH "NAME"
.HP
gcloud alpha spanner backups describe \- retrieves information about a backup
.SH "SYNOPSIS"
.HP
\f5gcloud alpha spanner backups describe\fR (\fIBACKUP\fR\ :\ \fB\-\-instance\fR=\fIINSTANCE\fR) [\fIGCLOUD_WIDE_FLAG\ ...\fR]
.SH "DESCRIPTION"
\fB(ALPHA)\fR Retrieves information about a backup.
.SH "EXAMPLES"
To describe a backup, run:
.RS 2m
$ gcloud alpha spanner backups describe BACKUP_ID \e
\-\-instance=INSTANCE_NAME
.RE
.SH "POSITIONAL ARGUMENTS"
.RS 2m
.TP 2m
Backup resource \- Cloud Spanner backup to describe. 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 \f5project\fR attribute:
.RS 2m
.IP "\(em" 2m
provide the argument \f5backup\fR on the command line with a fully specified
name;
.IP "\(em" 2m
provide the argument \f5\-\-project\fR on the command line;
.IP "\(em" 2m
set the property \f5core/project\fR.
.RE
.sp
This must be specified.
.RS 2m
.TP 2m
\fIBACKUP\fR
ID of the backup or fully qualified identifier for the backup.
To set the \f5backup\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5backup\fR on the command line.
.RE
.sp
This positional argument must be specified if any of the other arguments in this
group are specified.
.TP 2m
\fB\-\-instance\fR=\fIINSTANCE\fR
The name of the Cloud Spanner instance.
To set the \f5instance\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5backup\fR on the command line with a fully specified
name;
.IP "\(bu" 2m
provide the argument \f5\-\-instance\fR on the command line;
.IP "\(bu" 2m
set the property \f5spanner/instance\fR.
.RE
.sp
.RE
.RE
.sp
.SH "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 \fB$ gcloud help\fR for details.
.SH "API REFERENCE"
This command uses the \fBspanner/v1\fR API. The full documentation for this API
can be found at: https://cloud.google.com/spanner/
.SH "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:
.RS 2m
$ gcloud spanner backups describe
.RE
.RS 2m
$ gcloud beta spanner backups describe
.RE