File: //snap/google-cloud-cli/396/help/man/man1/gcloud_alpha_bigtable_materialized-views_describe.1
.TH "GCLOUD_ALPHA_BIGTABLE_MATERIALIZED\-VIEWS_DESCRIBE" 1
.SH "NAME"
.HP
gcloud alpha bigtable materialized\-views describe \- describe an existing Bigtable materialized view
.SH "SYNOPSIS"
.HP
\f5gcloud alpha bigtable materialized\-views describe\fR (\fIMATERIALIZED_VIEW\fR\ :\ \fB\-\-instance\fR=\fIINSTANCE\fR) [\fB\-\-view\fR=\fIVIEW\fR;\ default="schema"] [\fIGCLOUD_WIDE_FLAG\ ...\fR]
.SH "DESCRIPTION"
\fB(ALPHA)\fR Describe an existing Bigtable materialized view.
.SH "EXAMPLES"
To get back information related to a view's schema (for example, description),
run:
.RS 2m
$ gcloud alpha bigtable materialized\-views describe \e
my\-materialized\-view\-id \-\-instance=my\-instance\-id \-\-view=schema
.RE
or (because schema is the default view) simply:
.RS 2m
$ gcloud alpha bigtable materialized\-views describe \e
my\-materialized\-view\-id \-\-instance=my\-instance\-id
.RE
To get back information related to the view's replication state, run:
.RS 2m
$ gcloud alpha bigtable materialized\-views describe \e
my\-materialized\-view\-id \-\-instance=my\-instance\-id \e
\-\-view=replication
.RE
To get back all information for the view, run:
.RS 2m
$ gcloud alpha bigtable materialized\-views describe \e
my\-materialized\-view\-id \-\-instance=my\-instance\-id \-\-view=full
.RE
.SH "POSITIONAL ARGUMENTS"
.RS 2m
.TP 2m
Materialized view resource \- The materialized view 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 \f5materialized_view\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
\fIMATERIALIZED_VIEW\fR
ID of the materialized view or fully qualified identifier for the materialized
view.
To set the \f5name\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5materialized_view\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
Bigtable instance for the materialized view.
To set the \f5instance\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5materialized_view\fR on the command line with a fully
specified name;
.IP "\(bu" 2m
provide the argument \f5\-\-instance\fR on the command line.
.RE
.sp
.RE
.RE
.sp
.SH "FLAGS"
.RS 2m
.TP 2m
\fB\-\-view\fR=\fIVIEW\fR; default="schema"
Specifies what type of information to return about the view. \fIVIEW\fR must be
one of: \fBfull\fR, \fBreplication\fR, \fBschema\fR.
.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 "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 bigtable materialized\-views describe
.RE
.RS 2m
$ gcloud beta bigtable materialized\-views describe
.RE