.TH "GCLOUD_FIRESTORE_INDEXES_COMPOSITE_DESCRIBE" 1



.SH "NAME"
.HP
gcloud firestore indexes composite describe \- describe the given composite index



.SH "SYNOPSIS"
.HP
\f5gcloud firestore indexes composite describe\fR (\fIINDEX\fR\ :\ \fB\-\-database\fR=\fIDATABASE\fR) [\fIGCLOUD_WIDE_FLAG\ ...\fR]



.SH "DESCRIPTION"

Describe the given composite index.



.SH "EXAMPLES"

The following command describes the composite index with ID \f53421ef\fR:

.RS 2m
$ gcloud firestore indexes composite describe 3421ef
.RE

.RS 2m
$ gcloud firestore indexes composite describe 3421ef \e
    \-\-database=(default)
.RE



.SH "POSITIONAL ARGUMENTS"

.RS 2m
.TP 2m

Composite index resource \- Index 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 \f5index\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

To set the \f5collection\-group\fR attribute:
.RS 2m
.IP "\(em" 2m
provide the argument \f5index\fR on the command line with a fully specified
name;
.IP "\(em" 2m
provide the argument [\-\-collection\-group] on the command line.
.RE
.sp

This must be specified.


.RS 2m
.TP 2m
\fIINDEX\fR

ID of the composite index or fully qualified identifier for the composite index.

To set the \f5index\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5index\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\-\-database\fR=\fIDATABASE\fR

Database of the composite index.


To set the \f5database\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5index\fR on the command line with a fully specified
name;
.IP "\(bu" 2m
provide the argument \f5\-\-database\fR on the command line;
.IP "\(bu" 2m
the default value of argument [\-\-database] is \f5(default)\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 \fBfirestore/v1\fR API. The full documentation for this
API can be found at: https://cloud.google.com/firestore



.SH "NOTES"

These variants are also available:

.RS 2m
$ gcloud alpha firestore indexes composite describe
.RE

.RS 2m
$ gcloud beta firestore indexes composite describe
.RE