
.TH "GCLOUD_AI_INDEXES_DESCRIBE" 1



.SH "NAME"
.HP
gcloud ai indexes describe \- gets detailed index information about the given index id



.SH "SYNOPSIS"
.HP
\f5gcloud ai indexes describe\fR (\fIINDEX\fR\ :\ \fB\-\-region\fR=\fIREGION\fR) [\fIGCLOUD_WIDE_FLAG\ ...\fR]



.SH "EXAMPLES"

Describe an index \f5123\fR of project \f5example\fR in region
\f5us\-central1\fR, run:

.RS 2m
$ gcloud ai indexes describe 123 \-\-project=example \e
    \-\-region=us\-central1
.RE



.SH "POSITIONAL ARGUMENTS"

.RS 2m
.TP 2m

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

This must be specified.


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

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

To set the \f5name\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\-\-region\fR=\fIREGION\fR

Cloud region for the index.

To set the \f5region\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\-\-region\fR on the command line;
.IP "\(bu" 2m
set the property \f5ai/region\fR;
.IP "\(bu" 2m
choose one from the prompted list of available regions.
.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 "NOTES"

These variants are also available:

.RS 2m
$ gcloud alpha ai indexes describe
.RE

.RS 2m
$ gcloud beta ai indexes describe
.RE


