REST Resource: projects.databases.collectionGroups.indexes

Recurso: Index

Los índices de Cloud Firestore permiten realizar consultas simples y complejas en documentos de una base de datos.

Representación JSON 
{
  "name": string,
  "queryScope": enum (QueryScope),
  "apiScope": enum (ApiScope),
  "fields": [
    {
      object (IndexField)
    }
  ],
  "state": enum (State)
}
Campos
name

string

Solo salida. Es un nombre definido por el servidor para este índice. La forma de este nombre para los índices compuestos será la siguiente: projects/{projectId}/databases/{databaseId}/collectionGroups/{collectionId}/indexes/{composite_index_id} En el caso de los índices de campo único, este campo estará vacío.
queryScope

enum (QueryScope)

Los índices con un alcance de consulta de colección especificado permiten realizar consultas en una colección que es el elemento secundario de un documento específico, se especifica en el momento de la consulta y tiene el mismo ID de colección.

Los índices con un alcance de consulta de grupo de colecciones especificado permiten realizar consultas en todas las colecciones que descienden de un documento específico, que se especifican en el momento de la consulta y que tienen el mismo ID de colección que este índice.
apiScope

enum (ApiScope)

El alcance de la API que admite este índice.
fields[]

object (IndexField)

Los campos que admite este índice.

En el caso de los índices compuestos, esta opción requiere un mínimo de 2 y un máximo de 100 campos. La última entrada de campo siempre es para la ruta del campo __name__. Si, durante la creación, no se especificó __name__ como el último campo, se agregará automáticamente con la misma dirección que la del último campo definido. Si el campo final de un índice compuesto no es direccional, el elemento __name__ se ordenará ASCENDING (a menos que se especifique explícitamente).

En el caso de los índices de campo único, esto siempre será exactamente una entrada con una ruta de campo igual a la del campo asociado.
state

enum (State)

Solo salida. El estado de entrega del índice.

Métodos

create

 Crea un índice compuesto.

delete

 Borra un índice compuesto.

get

 Obtiene un índice compuesto.

list

 Muestra una lista de los índices compuestos.