.TH "GCLOUD_FIRESTORE_INDEXES_FIELDS_DESCRIBE" 1



.SH "NAME"
.HP
gcloud firestore indexes fields describe \- describe the index configuration of the given field



.SH "SYNOPSIS"
.HP
\f5gcloud firestore indexes fields describe\fR [[\fIFIELD\fR]\ \fB\-\-collection\-group\fR=\fICOLLECTION_GROUP\fR\ \fB\-\-database\fR=\fIDATABASE\fR] [\fIGCLOUD_WIDE_FLAG\ ...\fR]



.SH "DESCRIPTION"

Describe the index configuration of the given field.



.SH "EXAMPLES"

The following command describes the database\-wide default index settings:

.RS 2m
$ gcloud firestore indexes fields describe
.RE

.RS 2m
$ gcloud firestore indexes fields describe \-\-database=(default)
.RE

The following command describes the index configuration of the \f5timestamp\fR
field in the \f5Events\fR collection group.

.RS 2m
$ gcloud firestore indexes fields describe timestamp \e
    \-\-collection\-group=Events
.RE



.SH "POSITIONAL ARGUMENTS"

.RS 2m
.TP 2m

Field resource \- Field to describe.

This can be omitted to describe the database\-wide default index settings. 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 \f5field\fR on the command line with a fully specified
name;
.IP "\(em" 2m
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


.RS 2m
.TP 2m
[\fIFIELD\fR]

ID of the field or fully qualified identifier for the field.

To set the \f5field\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5field\fR on the command line;
.IP "\(bu" 2m
.
.RE
.sp

.TP 2m
\fB\-\-collection\-group\fR=\fICOLLECTION_GROUP\fR

Collection group of the field.


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

.TP 2m
\fB\-\-database\fR=\fIDATABASE\fR

Database of the field.


To set the \f5database\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5field\fR on the command line with a fully specified
name;
.IP "\(bu" 2m
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 fields describe
.RE

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