gcloud_alpha_firestore_indexes_composite_describe (1)
NAME
- gcloud alpha firestore indexes composite describe - describe the given composite index
SYNOPSIS
-
gcloud alpha firestore indexes composite describe INDEX [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Describe the given composite index.
POSITIONAL ARGUMENTS
-
-
- Composite index resource - Index to describe. This represents a Cloud resource. (NOTE) Some attributes are not given arguments in this group but can be set in other ways. To set the [project] attribute: provide the argument [index] on the command line with a fully specified name; set the property [core/project]; provide the argument [--project] on the command line. To set the [database] attribute: provide the argument [index] on the command line with a fully specified name; provide the argument [--database] on the command line (currently '(default)' is the only supported value). To set the [collection-group] attribute: provide the argument [index] on the command line with a fully specified name; provide the argument [--collection-group] on the command line. This must be specified.
-
- INDEX
-
ID of the composite index or fully qualified identifier for the composite index.
- Composite index resource - Index to describe. This represents a Cloud resource. (NOTE) Some attributes are not given arguments in this group but can be set in other ways. To set the [project] attribute: provide the argument [index] on the command line with a fully specified name; set the property [core/project]; provide the argument [--project] on the command line. To set the [database] attribute: provide the argument [index] on the command line with a fully specified name; provide the argument [--database] on the command line (currently '(default)' is the only supported value). To set the [collection-group] attribute: provide the argument [index] on the command line with a fully specified name; provide the argument [--collection-group] on the command line. This must be specified.
-
GCLOUD WIDE FLAGS
These flags are available to all commands: --account, --configuration, --flags-file, --flatten, --format, --help, --log-http, --project, --quiet, --trace-token, --user-output-enabled, --verbosity. Run $ gcloud help for details.
API REFERENCE
This command uses the firestore/v1beta2 API. The full documentation for this API can be found at: cloud.google.com/firestore
EXAMPLES
The following command describes the composite index with ID 3421ef:
- $ gcloud alpha firestore indexes composite describe 3421ef
NOTES
This command is currently in ALPHA and may change without notice. If this command fails with API permission errors despite specifying the right project, you will have to apply for early access and have your projects registered on the API whitelist to use it. To do so, contact Support at cloud.google.com/support This variant is also available:
- $ gcloud beta firestore indexes composite describe