Esta página se ha traducido con Cloud Translation API.

Package google.firestore.admin.v1beta2

Índice

FirestoreAdmin (interfaz)
CreateIndexRequest (mensaje)
DeleteIndexRequest (mensaje)
ExportDocumentsMetadata (mensaje)
ExportDocumentsRequest (mensaje)
ExportDocumentsResponse (mensaje)
Field (mensaje)
Field.IndexConfig (mensaje)
FieldOperationMetadata (mensaje)
FieldOperationMetadata.IndexConfigDelta (mensaje)
FieldOperationMetadata.IndexConfigDelta.ChangeType (enumeración)
GetFieldRequest (mensaje)
GetIndexRequest (mensaje)
ImportDocumentsMetadata (mensaje)
ImportDocumentsRequest (mensaje)
Index (mensaje)
Index.IndexField (mensaje)
Index.IndexField.ArrayConfig (enumeración)
Index.IndexField.Order (enumeración)
Index.QueryScope (enumeración)
Index.State (enumeración)
IndexOperationMetadata (mensaje)
ListFieldsRequest (mensaje)
ListFieldsResponse (mensaje)
ListIndexesRequest (mensaje)
ListIndexesResponse (mensaje)
OperationState (enumeración)
Progress (mensaje)
UpdateFieldRequest (mensaje)

Administrador de Firestore

Las operaciones las crea el servicio FirestoreAdmin , pero se accede a ellas a través del servicio google.longrunning.Operations .

Crear índice

Crear índice
`rpc CreateIndex( CreateIndexRequest ) returns ( Operation )` Crea un índice compuesto. Esto devuelve una `google.longrunning.Operation` que puede usarse para rastrear el estado de la creación. Los metadatos de la operación serán del tipo `IndexOperationMetadata` . Ámbitos de autorización Requiere uno de los siguientes ámbitos de OAuth: `https://www.googleapis.com/auth/datastore` `https://www.googleapis.com/auth/cloud-platform` Para obtener más información, consulte Descripción general de la autenticación .

rpc CreateIndex( CreateIndexRequest ) returns ( Operation )

Crea un índice compuesto. Esto devuelve una google.longrunning.Operation que puede usarse para rastrear el estado de la creación. Los metadatos de la operación serán del tipo IndexOperationMetadata .

Ámbitos de autorización

Requiere uno de los siguientes ámbitos de OAuth:

https://www.googleapis.com/auth/datastore
https://www.googleapis.com/auth/cloud-platform

Para obtener más información, consulte Descripción general de la autenticación .

Eliminar índice

Eliminar índice
`rpc DeleteIndex( DeleteIndexRequest ) returns ( Empty )` Elimina un índice compuesto. Ámbitos de autorización Requiere uno de los siguientes ámbitos de OAuth: `https://www.googleapis.com/auth/datastore` `https://www.googleapis.com/auth/cloud-platform` Para obtener más información, consulte Descripción general de la autenticación .

rpc DeleteIndex( DeleteIndexRequest ) returns ( Empty )

Elimina un índice compuesto.

Ámbitos de autorización

Requiere uno de los siguientes ámbitos de OAuth:

https://www.googleapis.com/auth/datastore
https://www.googleapis.com/auth/cloud-platform

Para obtener más información, consulte Descripción general de la autenticación .

Exportar documentos

Exportar documentos
`rpc ExportDocuments( ExportDocumentsRequest ) returns ( Operation )` Exporta una copia de todos o un subconjunto de documentos de Google Cloud Firestore a otro sistema de almacenamiento, como Google Cloud Storage. Es posible que las actualizaciones recientes de los documentos no se reflejen en la exportación. La exportación se produce en segundo plano y su progreso se puede monitorear y administrar a través del recurso Operación que se crea. El resultado de una exportación sólo podrá utilizarse una vez realizada la operación asociada. Si una operación de exportación se cancela antes de completarse, es posible que queden datos parciales en Google Cloud Storage. Ámbitos de autorización Requiere uno de los siguientes ámbitos de OAuth: `https://www.googleapis.com/auth/datastore` `https://www.googleapis.com/auth/cloud-platform` Para obtener más información, consulte Descripción general de la autenticación .

rpc ExportDocuments( ExportDocumentsRequest ) returns ( Operation )

Exporta una copia de todos o un subconjunto de documentos de Google Cloud Firestore a otro sistema de almacenamiento, como Google Cloud Storage. Es posible que las actualizaciones recientes de los documentos no se reflejen en la exportación. La exportación se produce en segundo plano y su progreso se puede monitorear y administrar a través del recurso Operación que se crea. El resultado de una exportación sólo podrá utilizarse una vez realizada la operación asociada. Si una operación de exportación se cancela antes de completarse, es posible que queden datos parciales en Google Cloud Storage.

Ámbitos de autorización

Requiere uno de los siguientes ámbitos de OAuth:

https://www.googleapis.com/auth/datastore
https://www.googleapis.com/auth/cloud-platform

Para obtener más información, consulte Descripción general de la autenticación .

Obtener campo

Obtener campo
`rpc GetField( GetFieldRequest ) returns ( Field )` Obtiene los metadatos y la configuración de un campo. Ámbitos de autorización Requiere uno de los siguientes ámbitos de OAuth: `https://www.googleapis.com/auth/datastore` `https://www.googleapis.com/auth/cloud-platform` Para obtener más información, consulte Descripción general de la autenticación .

rpc GetField( GetFieldRequest ) returns ( Field )

Obtiene los metadatos y la configuración de un campo.

Ámbitos de autorización

Requiere uno de los siguientes ámbitos de OAuth:

https://www.googleapis.com/auth/datastore
https://www.googleapis.com/auth/cloud-platform

Para obtener más información, consulte Descripción general de la autenticación .

Obtener índice

Obtener índice
`rpc GetIndex( GetIndexRequest ) returns ( Index )` Obtiene un índice compuesto. Ámbitos de autorización Requiere uno de los siguientes ámbitos de OAuth: `https://www.googleapis.com/auth/datastore` `https://www.googleapis.com/auth/cloud-platform` Para obtener más información, consulte Descripción general de la autenticación .

rpc GetIndex( GetIndexRequest ) returns ( Index )

Obtiene un índice compuesto.

Ámbitos de autorización

Requiere uno de los siguientes ámbitos de OAuth:

https://www.googleapis.com/auth/datastore
https://www.googleapis.com/auth/cloud-platform

Para obtener más información, consulte Descripción general de la autenticación .

Importar documentos

Importar documentos
`rpc ImportDocuments( ImportDocumentsRequest ) returns ( Operation )` Importa documentos a Google Cloud Firestore. Se sobrescriben los documentos existentes con el mismo nombre. La importación se produce en segundo plano y su progreso se puede monitorear y administrar a través del recurso Operación que se crea. Si se cancela una operación ImportDocuments, es posible que ya se haya importado un subconjunto de datos a Cloud Firestore. Ámbitos de autorización Requiere uno de los siguientes ámbitos de OAuth: `https://www.googleapis.com/auth/datastore` `https://www.googleapis.com/auth/cloud-platform` Para obtener más información, consulte Descripción general de la autenticación .

rpc ImportDocuments( ImportDocumentsRequest ) returns ( Operation )

Importa documentos a Google Cloud Firestore. Se sobrescriben los documentos existentes con el mismo nombre. La importación se produce en segundo plano y su progreso se puede monitorear y administrar a través del recurso Operación que se crea. Si se cancela una operación ImportDocuments, es posible que ya se haya importado un subconjunto de datos a Cloud Firestore.

Ámbitos de autorización

Requiere uno de los siguientes ámbitos de OAuth:

https://www.googleapis.com/auth/datastore
https://www.googleapis.com/auth/cloud-platform

Para obtener más información, consulte Descripción general de la autenticación .

Lista de campos

Lista de campos
`rpc ListFields( ListFieldsRequest ) returns ( ListFieldsResponse )` Enumera la configuración de campo y los metadatos de esta base de datos. Actualmente, `FirestoreAdmin.ListFields` solo admite campos de listado que se han anulado explícitamente. Para emitir esta consulta, llame a `FirestoreAdmin.ListFields` con el filtro configurado en `indexConfig.usesAncestorConfig:false` . Ámbitos de autorización Requiere uno de los siguientes ámbitos de OAuth: `https://www.googleapis.com/auth/datastore` `https://www.googleapis.com/auth/cloud-platform` Para obtener más información, consulte Descripción general de la autenticación .

rpc ListFields( ListFieldsRequest ) returns ( ListFieldsResponse )

Enumera la configuración de campo y los metadatos de esta base de datos.

Actualmente, FirestoreAdmin.ListFields solo admite campos de listado que se han anulado explícitamente. Para emitir esta consulta, llame a FirestoreAdmin.ListFields con el filtro configurado en indexConfig.usesAncestorConfig:false .

Ámbitos de autorización

Requiere uno de los siguientes ámbitos de OAuth:

https://www.googleapis.com/auth/datastore
https://www.googleapis.com/auth/cloud-platform

Para obtener más información, consulte Descripción general de la autenticación .

Lista de índices

Lista de índices
`rpc ListIndexes( ListIndexesRequest ) returns ( ListIndexesResponse )` Enumera índices compuestos. Ámbitos de autorización Requiere uno de los siguientes ámbitos de OAuth: `https://www.googleapis.com/auth/datastore` `https://www.googleapis.com/auth/cloud-platform` Para obtener más información, consulte Descripción general de la autenticación .

rpc ListIndexes( ListIndexesRequest ) returns ( ListIndexesResponse )

Enumera índices compuestos.

Ámbitos de autorización

Requiere uno de los siguientes ámbitos de OAuth:

https://www.googleapis.com/auth/datastore
https://www.googleapis.com/auth/cloud-platform

Para obtener más información, consulte Descripción general de la autenticación .

Campo de actualización

Campo de actualización
`rpc UpdateField( UpdateFieldRequest ) returns ( Operation )` Actualiza una configuración de campo. Actualmente, las actualizaciones de campos se aplican solo a la configuración de índice de campo único. Sin embargo, las llamadas a `FirestoreAdmin.UpdateField` deben proporcionar una máscara de campo para evitar cambiar cualquier configuración que la persona que llama no conozca. La máscara de campo debe especificarse como: `{ paths: "index_config" }` . Esta llamada devuelve una `google.longrunning.Operation` que puede usarse para rastrear el estado de la actualización del campo. Los metadatos de la operación serán del tipo `FieldOperationMetadata` . Para configurar los ajustes de campo predeterminados para la base de datos, utilice el `Field` especial con nombre de recurso: `projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/*` . Ámbitos de autorización Requiere uno de los siguientes ámbitos de OAuth: `https://www.googleapis.com/auth/datastore` `https://www.googleapis.com/auth/cloud-platform` Para obtener más información, consulte Descripción general de la autenticación .

rpc UpdateField( UpdateFieldRequest ) returns ( Operation )

Actualiza una configuración de campo. Actualmente, las actualizaciones de campos se aplican solo a la configuración de índice de campo único. Sin embargo, las llamadas a FirestoreAdmin.UpdateField deben proporcionar una máscara de campo para evitar cambiar cualquier configuración que la persona que llama no conozca. La máscara de campo debe especificarse como: { paths: "index_config" } .

Esta llamada devuelve una google.longrunning.Operation que puede usarse para rastrear el estado de la actualización del campo. Los metadatos de la operación serán del tipo FieldOperationMetadata .

Para configurar los ajustes de campo predeterminados para la base de datos, utilice el Field especial con nombre de recurso: projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/* .

Ámbitos de autorización

Requiere uno de los siguientes ámbitos de OAuth:

https://www.googleapis.com/auth/datastore
https://www.googleapis.com/auth/cloud-platform

Para obtener más información, consulte Descripción general de la autenticación .

Crear solicitud de índice

La solicitud de FirestoreAdmin.CreateIndex .

Campos

parent

string

Un nombre principal del formulario projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}

index

Index

El índice compuesto que se va a crear.

Eliminar solicitud de índice

La solicitud de FirestoreAdmin.DeleteIndex .

Campos

Campos
`name`	`string` Un nombre del formulario `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}`

name

string

Un nombre del formulario projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}

ExportarDocumentosMetadatos

Metadatos de los resultados de google.longrunning.Operation de FirestoreAdmin.ExportDocuments .

Campos
`start_time`	`Timestamp` La hora en que comenzó esta operación.
`end_time`	`Timestamp` La hora a la que se completó esta operación. Se desarmará si la operación aún está en progreso.
`operation_state`	`OperationState` El estado de la operación de exportación.
`progress_documents`	`Progress` Los avances, en documentos, de esta operación.
`progress_bytes`	`Progress` El progreso, en bytes, de esta operación.
`collection_ids[]`	`string` Qué identificadores de colección se están exportando.
`output_uri_prefix`	`string` A dónde se exportan las entidades.

Solicitud de Exportación de Documentos

La solicitud de FirestoreAdmin.ExportDocuments .

Campos

Campos
`name`	`string` Base de datos para exportar. Debe tener el formato: `projects/{project_id}/databases/{database_id}` .
`collection_ids[]`	`string` Qué ID de colección exportar. Sin especificar significa todas las colecciones.
`output_uri_prefix`	`string` El URI de salida. Actualmente solo admite URI de Google Cloud Storage del formato: `gs://BUCKET_NAME[/NAMESPACE_PATH]` , donde `BUCKET_NAME` es el nombre del depósito de Google Cloud Storage y `NAMESPACE_PATH` es una ruta de espacio de nombres opcional de Google Cloud Storage. Al elegir un nombre, asegúrese de considerar las pautas de nomenclatura de Google Cloud Storage: https://cloud.google.com/storage/docs/naming . Si el URI es un depósito (sin una ruta de espacio de nombres), se generará un prefijo según la hora de inicio.

name

string

Base de datos para exportar. Debe tener el formato: projects/{project_id}/databases/{database_id} .

collection_ids[]

string

Qué ID de colección exportar. Sin especificar significa todas las colecciones.

output_uri_prefix

string

El URI de salida. Actualmente solo admite URI de Google Cloud Storage del formato: gs://BUCKET_NAME[/NAMESPACE_PATH] , donde BUCKET_NAME es el nombre del depósito de Google Cloud Storage y NAMESPACE_PATH es una ruta de espacio de nombres opcional de Google Cloud Storage. Al elegir un nombre, asegúrese de considerar las pautas de nomenclatura de Google Cloud Storage: https://cloud.google.com/storage/docs/naming . Si el URI es un depósito (sin una ruta de espacio de nombres), se generará un prefijo según la hora de inicio.

ExportarDocumentosRespuesta

Devuelto en el campo de respuesta google.longrunning.Operation .

Campos

Campos
`output_uri_prefix`	`string` Ubicación de los archivos de salida. Esto se puede usar para comenzar una importación a Cloud Firestore (este proyecto u otro proyecto) después de que la operación se complete exitosamente.

output_uri_prefix

string

Ubicación de los archivos de salida. Esto se puede usar para comenzar una importación a Cloud Firestore (este proyecto u otro proyecto) después de que la operación se complete exitosamente.

Campo

Representa un único campo en la base de datos.

Los campos están agrupados por su "Grupo de colecciones", que representa todas las colecciones de la base de datos con la misma identificación.

Campos

Campos
`name`	`string` Un nombre de campo del formulario `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}` Una ruta de campo puede ser un nombre de campo simple, por ejemplo, `address` o una ruta a campos dentro de map_value, por ejemplo, `address.city` , o una ruta de campo especial. El único campo especial válido es `` , que representa cualquier campo. Las rutas de campo se pueden citar usando `(backtick). The only character that needs to be escaped within a quoted field path is the backtick character itself, escaped using a backslash. Special characters in field paths that must be quoted include:` `,` . , ``` (backtick), [ `,` ]`, así como cualquier carácter simbólico ascii. Ejemplos: (Nota: los comentarios aquí están escritos en sintaxis de rebajas, por lo que hay una capa adicional de comillas invertidas para representar un bloque de código) `\` dirección.ciudad` `represents a field named` dirección.ciudad `, not the map key` `in the field` dirección `.` `` `represents a field named` `, no cualquier campo. Un `Field` especial contiene la configuración de indexación predeterminada para todos los campos. El nombre del recurso de este campo es: `projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/*` Los índices definidos en este `Field` se aplicarán a todos los campos que no tengan su propia configuración de índice `Field` .
`index_config`	`IndexConfig` La configuración del índice para este campo. Si no se establece, la indexación de campos volverá a la configuración definida por el `ancestor_field` . Para eliminar explícitamente todos los índices de este campo, especifique una configuración de índice con una lista vacía de índices.

name

string

Un nombre de campo del formulario projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}

Una ruta de campo puede ser un nombre de campo simple, por ejemplo, address o una ruta a campos dentro de map_value, por ejemplo, address.city , o una ruta de campo especial. El único campo especial válido es * , que representa cualquier campo.

Las rutas de campo se pueden citar usando (backtick). The only character that needs to be escaped within a quoted field path is the backtick character itself, escaped using a backslash. Special characters in field paths that must be quoted include: * , . , ``` (backtick), [ , ]`, así como cualquier carácter simbólico ascii.

Ejemplos: (Nota: los comentarios aquí están escritos en sintaxis de rebajas, por lo que hay una capa adicional de comillas invertidas para representar un bloque de código) \ dirección.ciudad` represents a field named dirección.ciudad , not the map key in the field dirección . `*` represents a field named *`, no cualquier campo.

Un Field especial contiene la configuración de indexación predeterminada para todos los campos. El nombre del recurso de este campo es: projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/* Los índices definidos en este Field se aplicarán a todos los campos que no tengan su propia configuración de índice Field .

index_config

IndexConfig

La configuración del índice para este campo. Si no se establece, la indexación de campos volverá a la configuración definida por el ancestor_field . Para eliminar explícitamente todos los índices de este campo, especifique una configuración de índice con una lista vacía de índices.

Configuración de índice

La configuración del índice para este campo.

Campos
`indexes[]`	`Index` Los índices admitidos para este campo.
`uses_ancestor_config`	`bool` Sólo salida. Cuando es verdadero, la configuración del índice del `Field` se establece a partir de la configuración especificada por el `ancestor_field` . Cuando es falso, la configuración del índice del `Field` se define explícitamente.
`ancestor_field`	`string` Sólo salida. Especifica el nombre del recurso del `Field` desde el cual se establece la configuración del índice de este campo (cuando `uses_ancestor_config` es verdadero), o desde el cual se establecería si este campo no tuviera una configuración de índice (cuando `uses_ancestor_config` es falso).
`reverting`	`bool` Solo salida Cuando es verdadero, la configuración del índice del `Field` está en proceso de revertirse. Una vez completada, la configuración del índice pasará al mismo estado que el campo especificado por `ancestor_field` , momento en el que `uses_ancestor_config` será `true` y `reverting` será `false` .

CampoOperaciónMetadatos

Metadatos de los resultados de google.longrunning.Operation de FirestoreAdmin.UpdateField .

Campos
`start_time`	`Timestamp` La hora en que comenzó esta operación.
`end_time`	`Timestamp` La hora a la que se completó esta operación. Se desarmará si la operación aún está en progreso.
`field`	`string` El recurso de campo sobre el que actúa esta operación. Por ejemplo: `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}`
`index_config_deltas[]`	`IndexConfigDelta` Una lista de `IndexConfigDelta` , que describe la intención de esta operación.
`state`	`OperationState` El estado de la operación.
`document_progress`	`Progress` Los avances, en documentos, de esta operación.
`bytes_progress`	`Progress` El progreso, en bytes, de esta operación.

ÍndiceConfigDelta

Información sobre un cambio de configuración de índice.

Campos

change_type

ChangeType

Especifica cómo está cambiando el índice.

index

Index

El índice está siendo cambiado.

Tipo de cambio

Especifica cómo está cambiando el índice.

Enumeraciones
`CHANGE_TYPE_UNSPECIFIED`	El tipo de cambio no está especificado ni conocido.
`ADD`	Se está agregando el índice de campo único.
`REMOVE`	Se está eliminando el índice de campo único.

Obtener solicitud de campo

La solicitud de FirestoreAdmin.GetField .

Campos

Campos
`name`	`string` Un nombre del formulario `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_id}`

name

string

Un nombre del formulario projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_id}

Obtener solicitud de índice

La solicitud de FirestoreAdmin.GetIndex .

Campos

Campos
`name`	`string` Un nombre del formulario `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}`

name

string

Un nombre del formulario projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}

ImportarDocumentosMetadatos

Metadatos de los resultados de google.longrunning.Operation de FirestoreAdmin.ImportDocuments .

Campos
`start_time`	`Timestamp` La hora en que comenzó esta operación.
`end_time`	`Timestamp` La hora a la que se completó esta operación. Se desarmará si la operación aún está en progreso.
`operation_state`	`OperationState` El estado de la operación de importación.
`progress_documents`	`Progress` Los avances, en documentos, de esta operación.
`progress_bytes`	`Progress` El progreso, en bytes, de esta operación.
`collection_ids[]`	`string` Qué identificadores de colección se están importando.
`input_uri_prefix`	`string` La ubicación de los documentos que se importan.

Solicitud de Importación de Documentos

La solicitud de FirestoreAdmin.ImportDocuments .

Campos

Campos
`name`	`string` Base de datos para importar. Debe tener el formato: `projects/{project_id}/databases/{database_id}` .
`collection_ids[]`	`string` Qué ID de colección importar. Sin especificar significa todas las colecciones incluidas en la importación.
`input_uri_prefix`	`string` Ubicación de los archivos exportados. Esto debe coincidir con el prefijo_uri_salida de una ExportDocumentsResponse de una exportación que se haya completado correctamente. Consulte: `google.firestore.admin.v1beta2.ExportDocumentsResponse.output_uri_prefix` .

name

string

Base de datos para importar. Debe tener el formato: projects/{project_id}/databases/{database_id} .

collection_ids[]

string

Qué ID de colección importar. Sin especificar significa todas las colecciones incluidas en la importación.

input_uri_prefix

string

Ubicación de los archivos exportados. Esto debe coincidir con el prefijo_uri_salida de una ExportDocumentsResponse de una exportación que se haya completado correctamente. Consulte: google.firestore.admin.v1beta2.ExportDocumentsResponse.output_uri_prefix .

Índice

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

Campos
`name`	`string` Sólo salida. Un nombre definido por el servidor para este índice. La forma de este nombre para índices compuestos será: `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{composite_index_id}` Para índices de campo único, este campo estará vacío.
`query_scope`	`QueryScope` Los índices con un alcance de consulta de colección especificado permiten consultas en una colección que es hija de un documento específico, especificada en el momento de la consulta y que tiene el mismo ID de colección. Los índices con un alcance de consulta de grupo de colección especificado permiten consultas en todas las colecciones que descienden de un documento específico, especificadas en el momento de la consulta y que tienen la misma identificación de colección que este índice.
`fields[]`	`IndexField` Los campos soportados por este índice. Para índices compuestos, siempre son 2 o más campos. La última entrada de campo es siempre para la ruta del campo `__name__` . Si en el momento de la creación no se especificó `__name__` como último campo, se agregará automáticamente con la misma dirección que la del último campo definido. Si el campo final en un índice compuesto no es direccional, el `__name__` se ordenará ASCENDENTE (a menos que se especifique explícitamente). Para índices de campo único, siempre será exactamente una entrada con una ruta de campo igual a la ruta del campo asociado.
`state`	`State` Sólo salida. El estado de publicación del índice.

Campo de índice

Un campo en un índice. field_path describe qué campo está indexado, value_mode describe cómo se indexa el valor del campo.

Campos
`field_path`	`string` Puede ser nombre . Para índices de campo único, esto debe coincidir con el nombre del campo o puede omitirse.
Campo de unión `value_mode` . Cómo se indexa el valor del campo. `value_mode` puede ser solo uno de los siguientes:
`order`	`Order` Indica que este campo admite ordenar según el orden especificado o comparar usando =, <, <=, >, >=.
`array_config`	`ArrayConfig` Indica que este campo admite operaciones en `array_value` s.

configuración de matriz

Las configuraciones de valores de matriz admitidas.

Enumeraciones
`ARRAY_CONFIG_UNSPECIFIED`	El índice no admite consultas de matriz adicionales.
`CONTAINS`	El índice admite consultas de contención de matrices.

Orden

Los pedidos admitidos.

Enumeraciones
`ORDER_UNSPECIFIED`	El orden no está especificado. No es una opción válida.
`ASCENDING`	El campo está ordenado por valor de campo ascendente.
`DESCENDING`	El campo está ordenado por valor de campo descendente.

Alcance de consulta

Query Scope define el alcance en el que se ejecuta una consulta. Esto se especifica en el campo from de StructuredQuery.

Enumeraciones
`QUERY_SCOPE_UNSPECIFIED`	El alcance de la consulta no está especificado. No es una opción válida.
`COLLECTION`	Los índices con un alcance de consulta de colección especificado permiten consultas en una colección que es hija de un documento específico, especificada en el momento de la consulta y que tiene la identificación de colección especificada por el índice.
`COLLECTION_GROUP`	Los índices con un alcance de consulta de grupo de colección especificado permiten consultas en todas las colecciones que tienen la identificación de colección especificada por el índice.

Estado

El estado de un índice. Durante la creación del índice, un índice estará en el estado CREATING . Si el índice se crea correctamente, pasará al estado READY . Si la creación del índice encuentra un problema, el índice pasará al estado NEEDS_REPAIR .

Enumeraciones
`STATE_UNSPECIFIED`	El estado no se especifica.
`CREATING`	El índice se está creando. Hay una operación activa de larga duración para el índice. El índice se actualiza al escribir un documento. Es posible que existan algunos datos de índice.
`READY`	El índice está listo para ser utilizado. El índice se actualiza al escribir un documento. El índice se completa completamente con todos los documentos almacenados a los que se aplica.
`NEEDS_REPAIR`	Se estaba creando el índice, pero algo salió mal. No hay ninguna operación activa de larga duración para el índice y la operación de larga duración finalizada más recientemente falló. El índice no se actualiza al escribir un documento. Es posible que existan algunos datos de índice. Utilice la API google.longrunning.Operations para determinar por qué falló la última operación que intentó crear este índice y luego vuelva a crear el índice.

OperaciónÍndiceMetadatos

Metadatos de los resultados de google.longrunning.Operation de FirestoreAdmin.CreateIndex .

Campos
`start_time`	`Timestamp` La hora en que comenzó esta operación.
`end_time`	`Timestamp` La hora a la que se completó esta operación. Se desarmará si la operación aún está en progreso.
`index`	`string` El recurso de índice sobre el que actúa esta operación. Por ejemplo: `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}`
`state`	`OperationState` El estado de la operación.
`progress_documents`	`Progress` Los avances, en documentos, de esta operación.
`progress_bytes`	`Progress` El progreso, en bytes, de esta operación.

Solicitud de campos de lista

La solicitud de FirestoreAdmin.ListFields .

Campos
`parent`	`string` Un nombre principal del formulario `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}`
`filter`	`string` El filtro que se aplicará a los resultados de la lista. Actualmente, `FirestoreAdmin.ListFields` solo admite campos de listado que se han anulado explícitamente. Para emitir esta consulta, llame a `FirestoreAdmin.ListFields` con el filtro configurado en `indexConfig.usesAncestorConfig:false` .
`page_size`	`int32` El número de resultados que se devolverán.
`page_token`	`string` Un token de página, devuelto por una llamada anterior a `FirestoreAdmin.ListFields` , que puede usarse para obtener la siguiente página de resultados.

ListaCamposRespuesta

La respuesta para FirestoreAdmin.ListFields .

Campos

Campos
`fields[]`	`Field` Los campos solicitados.
`next_page_token`	`string` Un token de página que se puede utilizar para solicitar otra página de resultados. Si está en blanco, esta es la última página.

fields[]

Field

Los campos solicitados.

next_page_token

string

Un token de página que se puede utilizar para solicitar otra página de resultados. Si está en blanco, esta es la última página.

Solicitud de índices de lista

La solicitud de FirestoreAdmin.ListIndexes .

Campos
`parent`	`string` Un nombre principal del formulario `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}`
`filter`	`string` El filtro que se aplicará a los resultados de la lista.
`page_size`	`int32` El número de resultados que se devolverán.
`page_token`	`string` Un token de página, devuelto por una llamada anterior a `FirestoreAdmin.ListIndexes` , que puede usarse para obtener la siguiente página de resultados.

ListaÍndicesRespuesta

La respuesta para FirestoreAdmin.ListIndexes .

Campos

Campos
`indexes[]`	`Index` Los índices solicitados.
`next_page_token`	`string` Un token de página que se puede utilizar para solicitar otra página de resultados. Si está en blanco, esta es la última página.

indexes[]

Index

Los índices solicitados.

next_page_token

string

Un token de página que se puede utilizar para solicitar otra página de resultados. Si está en blanco, esta es la última página.

EstadoOperación

Describe el estado de la operación.

Enumeraciones
`OPERATION_STATE_UNSPECIFIED`	Sin especificar.
`INITIALIZING`	La solicitud se está preparando para su procesamiento.
`PROCESSING`	La solicitud se está procesando activamente.
`CANCELLING`	La solicitud está en proceso de cancelación después de que el usuario llamó a google.longrunning.Operations.CancelOperation en la operación.
`FINALIZING`	La solicitud ha sido procesada y se encuentra en su etapa de finalización.
`SUCCESSFUL`	La solicitud se ha completado con éxito.
`FAILED`	La solicitud terminó de procesarse, pero se produjo un error.
`CANCELLED`	La solicitud terminó de cancelarse después de que el usuario llamara a google.longrunning.Operations.CancelOperation.

Progreso

Describe el progreso de la operación. La unidad de trabajo es genérica y debe interpretarse en función de dónde se utiliza Progress .

Campos

Campos
`estimated_work`	`int64` La cantidad de trabajo estimada.
`completed_work`	`int64` La cantidad de trabajo completado.

estimated_work

int64

La cantidad de trabajo estimada.

completed_work

int64

La cantidad de trabajo completado.

Solicitud de campo de actualización

La solicitud de FirestoreAdmin.UpdateField .

Campos

Campos
`field`	`Field` El campo a actualizar.
`update_mask`	`FieldMask` Una máscara, relativa al campo. Si se especifica, solo se actualizará en el campo la configuración especificada por esta máscara de campo.

field

Field

El campo a actualizar.

update_mask

FieldMask

Una máscara, relativa al campo. Si se especifica, solo se actualizará en el campo la configuración especificada por esta máscara de campo.