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

Package google.firestore.admin.v1beta1

Índice

FirestoreAdmin (interfaz)
CreateIndexRequest (mensaje)
DeleteIndexRequest (mensaje)
ExportDocumentsMetadata (mensaje)
ExportDocumentsRequest (mensaje)
ExportDocumentsResponse (mensaje)
GetIndexRequest (mensaje)
ImportDocumentsMetadata (mensaje)
ImportDocumentsRequest (mensaje)
Index (mensaje)
Index.State (enumeración)
IndexField (mensaje)
IndexField.Mode (enumeración)
IndexOperationMetadata (mensaje)
IndexOperationMetadata.OperationType (enumeración)
ListIndexesRequest (mensaje)
ListIndexesResponse (mensaje)
LocationMetadata (mensaje)
OperationState (enumeración)
Progress (mensaje)

Administrador de Firestore

La API de administración de Cloud Firestore.

Esta API proporciona varios servicios administrativos para Cloud Firestore.

Conceptos

Proyecto, Base de datos, Espacio de nombres, Colección y Documento se utilizan según se define en la API de Google Cloud Firestore.

Operación: Una operación representa el trabajo que se realiza en segundo plano.

Servicios

Índice

El servicio de índice administra los índices de Cloud Firestore.

La creación del índice se realiza de forma asincrónica. Se crea un recurso de operación para cada operación asincrónica. El estado de la operación (incluido cualquier error encontrado) se puede consultar a través del recurso Operación.

Metadatos

Proporciona metadatos e información estadística sobre los datos en Cloud Firestore. Los datos proporcionados como parte de esta API pueden estar obsoletos.

Operación

La colección de Operaciones proporciona un registro de las acciones realizadas para el Proyecto especificado (incluidas las Operaciones en curso). Las operaciones no se crean directamente sino a través de llamadas a otras colecciones o recursos.

Una Operación que aún no se haya realizado podrá cancelarse. La solicitud de cancelación es asincrónica y la Operación puede continuar ejecutándose durante algún tiempo después de que se realiza la solicitud de cancelación.

Una operación realizada se puede eliminar para que ya no aparezca como parte de la colección de operaciones.

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 el índice especificado. El estado inicial de un índice recién creado es `CREATING` . Al finalizar la `google.longrunning.Operation` devuelta, el estado será `READY` . Si el índice ya existe, la llamada devolverá un estado `ALREADY_EXISTS` . Durante la creación, el proceso podría generar un error, en cuyo caso el índice pasará al estado `ERROR` . El proceso se puede recuperar arreglando los datos que causaron el error, eliminando el índice con `delete` y luego volviendo a crear el índice con `create` . No se pueden crear índices con un solo 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 CreateIndex( CreateIndexRequest ) returns ( Operation )

Crea el índice especificado. El estado inicial de un índice recién creado es CREATING . Al finalizar la google.longrunning.Operation devuelta, el estado será READY . Si el índice ya existe, la llamada devolverá un estado ALREADY_EXISTS .

Durante la creación, el proceso podría generar un error, en cuyo caso el índice pasará al estado ERROR . El proceso se puede recuperar arreglando los datos que causaron el error, eliminando el índice con delete y luego volviendo a crear el índice con create .

No se pueden crear índices con un solo 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 .

Eliminar índice

Eliminar índice
`rpc DeleteIndex( DeleteIndexRequest ) returns ( Empty )` Elimina un índice. Á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.

Á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 índice

Obtener índice
`rpc GetIndex( GetIndexRequest ) returns ( Index )` Obtiene un índice. Á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.

Á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 índices

Lista de índices
`rpc ListIndexes( ListIndexesRequest ) returns ( ListIndexesResponse )` Enumera los índices que coinciden con los filtros especificados. Á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 los índices que coinciden con los filtros especificados.

Á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

Campos
`parent`	`string` El nombre de la base de datos a la que se aplicará este índice. Por ejemplo: `projects/{project_id}/databases/{database_id}`
`index`	`Index` El índice a crear. Los campos de nombre y estado solo se muestran y se ignorarán. Ciertos índices de campos únicos no se pueden crear ni eliminar.

parent

string

El nombre de la base de datos a la que se aplicará este índice. Por ejemplo: projects/{project_id}/databases/{database_id}

index

Index

El índice a crear. Los campos de nombre y estado solo se muestran y se ignorarán. Ciertos índices de campos únicos no se pueden crear ni eliminar.

Eliminar solicitud de índice

La solicitud de FirestoreAdmin.DeleteIndex .

Campos

Campos
`name`	`string` El nombre del índice. Por ejemplo: `projects/{project_id}/databases/{database_id}/indexes/{index_id}`

name

string

El nombre del índice. Por ejemplo: projects/{project_id}/databases/{database_id}/indexes/{index_id}

ExportarDocumentosMetadatos

Metadatos para operaciones ExportDocuments.

Campos
`start_time`	`Timestamp` La hora en que comenzaron los trabajos de la operación.
`end_time`	`Timestamp` La hora a la que finalizó la operación, ya sea con éxito o no. Desarmado si la operación aún está activa.
`operation_state`	`OperationState` El estado de la operación de exportación.
`progress_documents`	`Progress` Una estimación del número de documentos procesados.
`progress_bytes`	`Progress` Una estimación del número de bytes procesados.
`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.

Obtener solicitud de índice

La solicitud de FirestoreAdmin.GetIndex .

Campos

Campos
`name`	`string` El nombre del índice. Por ejemplo: `projects/{project_id}/databases/{database_id}/indexes/{index_id}`

name

string

El nombre del índice. Por ejemplo: projects/{project_id}/databases/{database_id}/indexes/{index_id}

ImportarDocumentosMetadatos

Metadatos para operaciones de ImportDocuments.

Campos
`start_time`	`Timestamp` La hora en que comenzaron los trabajos de la operación.
`end_time`	`Timestamp` La hora a la que finalizó la operación, ya sea con éxito o no. Desarmado si la operación aún está activa.
`operation_state`	`OperationState` El estado de la operación de importación.
`progress_documents`	`Progress` Una estimación del número de documentos procesados.
`progress_bytes`	`Progress` Una estimación del número de bytes procesados.
`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.v1beta1.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.v1beta1.ExportDocumentsResponse.output_uri_prefix .

Índice

Una definición de índice.

Campos
`name`	`string` El nombre del recurso del índice. Sólo salida.
`collection_id`	`string` El ID de colección al que se aplica este índice. Requerido.
`fields[]`	`IndexField` Los campos a indexar.
`state`	`State` El estado del índice. Sólo salida.

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 no se puede crear el índice, pasará al estado ERROR .

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.
`ERROR`	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.

Campo de índice

Un campo de un índice.

Campos

Campos
`field_path`	`string` El camino del campo. Debe coincidir con la especificación de ruta de campo descrita por [google.firestore.v1beta1.Document.fields][fields]. La ruta del campo especial `__name__` se puede usar sola o al final de una ruta. `__type__` solo se puede utilizar al final de la ruta.
`mode`	`Mode` El modo del campo.

field_path

string

El camino del campo. Debe coincidir con la especificación de ruta de campo descrita por [google.firestore.v1beta1.Document.fields][fields]. La ruta del campo especial __name__ se puede usar sola o al final de una ruta. __type__ solo se puede utilizar al final de la ruta.

mode

Mode

El modo del campo.

Modo

El modo determina cómo se indexa un campo.

Enumeraciones
`MODE_UNSPECIFIED`	El modo no está especificado.
`ASCENDING`	Los valores del campo están indexados para admitir la secuenciación en orden ascendente y también la consulta por <, >, <=, >= y =.
`DESCENDING`	Los valores del campo están indexados para admitir la secuenciación en orden descendente y también la consulta por <, >, <=, >= y =.
`ARRAY_CONTAINS`	Los valores de la matriz del campo están indexados para admitir la membresía mediante consultas ARRAY_CONTAINS.

OperaciónÍndiceMetadatos

Metadatos para operaciones de índice. Estos metadatos completan el campo de metadatos de google.longrunning.Operation .

Campos
`start_time`	`Timestamp` La hora en que comenzaron los trabajos de la operación.
`end_time`	`Timestamp` La hora a la que finalizó la operación, ya sea con éxito o no. Desarmado si la operación aún está activa.
`index`	`string` El recurso de índice sobre el que actúa esta operación. Por ejemplo: `projects/{project_id}/databases/{database_id}/indexes/{index_id}`
`operation_type`	`OperationType` El tipo de operación de índice.
`cancelled`	`bool` Verdadero si se canceló la `google.longrunning.Operation` . Si la cancelación está en curso, cancelada será verdadera pero `google.longrunning.Operation.done` será falsa.
`document_progress`	`Progress` Avance de la operación existente, medido en número de documentos.

Tipo de operación

El tipo de operación de índice.

Enumeraciones
`OPERATION_TYPE_UNSPECIFIED`	Sin especificar. Nunca configurado por el servidor.
`CREATING_INDEX`	La operación es crear el índice. Iniciado por una llamada `CreateIndex` .

Solicitud de índices de lista

La solicitud de FirestoreAdmin.ListIndexes .

Campos
`parent`	`string` El nombre de la base de datos. Por ejemplo: `projects/{project_id}/databases/{database_id}`
`filter`	`string`
`page_size`	`int32` El tamaño de página de lista estándar.
`page_token`	`string` El token de página de lista estándar.

ListaÍndicesRespuesta

La respuesta para FirestoreAdmin.ListIndexes .

Campos

Campos
`indexes[]`	`Index` Los índices.
`next_page_token`	`string` El token estándar de la página siguiente de la lista.

indexes[]

Index

Los índices.

next_page_token

string

El token estándar de la página siguiente de la lista.

UbicaciónMetadatos

Este tipo no tiene campos.

El mensaje de metadatos para google.cloud.location.Location.metadata .

EstadoOperación

Los distintos estados posibles para una Operación en curso.

Enumeraciones
`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

Mide el progreso de una métrica particular.

Campos

Campos
`work_completed`	`int64` Una estimación de cuánto trabajo se ha completado. Tenga en cuenta que esto puede ser mayor que `work_estimated` .
`work_estimated`	`int64` Una estimación de cuánto trabajo se debe realizar. Cero si la estimación del trabajo no está disponible. Puede cambiar a medida que avanza el trabajo.

work_completed

int64

Una estimación de cuánto trabajo se ha completado. Tenga en cuenta que esto puede ser mayor que work_estimated .

work_estimated

int64

Una estimación de cuánto trabajo se debe realizar. Cero si la estimación del trabajo no está disponible. Puede cambiar a medida que avanza el trabajo.