Se usó la API de Cloud Translation para traducir esta página.

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)

FirestoreAdmin

La API de Cloud Firestore Admin.

Esta API proporciona varios servicios administrativos para Cloud Firestore.

Conceptos

El proyecto, la base de datos, el espacio de nombres, la colección y el documento se usan según se define en la API de Google Cloud Firestore.

Operación: representa el trabajo que se está realizando en segundo plano.

Servicios

Índice

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

La creación de índices se realiza de forma asíncrona. Se crea un recurso de operación para cada operación asíncrona. El estado de la operación (incluidos los errores encontrados) se puede consultar a través del recurso de operación.

Metadatos

Proporciona metadatos y, además, información estadística sobre los datos en Cloud Firestore. Es posible que los datos proporcionados como parte de esta API estén inactivos.

Operación

La colección 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.

Es posible que se cancele una operación que aún no se haya realizado. La solicitud de cancelación es asíncrona y la operación puede continuar ejecutándose durante un tiempo después de que se realiza la solicitud de cancelación.

Es posible que una operación finalizada se borre para que deje de aparecer como parte de la colección de operaciones.

El servicio FirestoreAdmin crea las operaciones, pero se puede acceder a ellas a través del servicio google.longrunning.Operations.

CreateIndex

CreateIndex
`rpc CreateIndex(CreateIndexRequest) returns (Operation)` Crea el índice especificado. El estado inicial de un índice recién creado es `CREATING`. Cuando se complete el objeto `google.longrunning.Operation` que se muestra, el estado será `READY`. Si el índice ya existe, la llamada mostrará un estado `ALREADY_EXISTS`. Durante la creación, el proceso podría generar un error, en cuyo caso el índice pasará al estado `ERROR`. Para recuperar el proceso, puedes corregir los datos que causaron el error, quitar el índice con `delete` y volver a crearlo con `create`. No se pueden crear índices con un solo campo. Permisos de autorización Se necesita uno de los siguientes alcances de OAuth: `https://www.googleapis.com/auth/datastore` `https://www.googleapis.com/auth/cloud-platform` Para obtener más información, consulta 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. Cuando se complete el objeto google.longrunning.Operation que se muestra, el estado será READY. Si el índice ya existe, la llamada mostrará un estado ALREADY_EXISTS.

Durante la creación, el proceso podría generar un error, en cuyo caso el índice pasará al estado ERROR. Para recuperar el proceso, puedes corregir los datos que causaron el error, quitar el índice con delete y volver a crearlo con create.

No se pueden crear índices con un solo campo.

Permisos de autorización

Se necesita uno de los siguientes alcances de OAuth:

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

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

DeleteIndex

DeleteIndex
`rpc DeleteIndex(DeleteIndexRequest) returns (Empty)` Borra un índice. Permisos de autorización Se necesita uno de los siguientes alcances de OAuth: `https://www.googleapis.com/auth/datastore` `https://www.googleapis.com/auth/cloud-platform` Para obtener más información, consulta Descripción general de la autenticación.

rpc DeleteIndex(DeleteIndexRequest) returns (Empty)

Borra un índice.

Permisos de autorización

Se necesita uno de los siguientes alcances de OAuth:

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

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

ExportDocuments

ExportDocuments
`rpc ExportDocuments(ExportDocumentsRequest) returns (Operation)` Exporta una copia de todos los documentos o de un subconjunto de ellos 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 realiza en segundo plano y su progreso se puede supervisar y administrar a través del recurso de operación que se crea. El resultado de una exportación solo se puede usar después de que se complete la operación asociada. Si se cancela una operación de exportación antes de completarse, es posible que se conserven datos parciales en Google Cloud Storage. Permisos de autorización Se necesita uno de los siguientes alcances de OAuth: `https://www.googleapis.com/auth/datastore` `https://www.googleapis.com/auth/cloud-platform` Para obtener más información, consulta Descripción general de la autenticación.

rpc ExportDocuments(ExportDocumentsRequest) returns (Operation)

Exporta una copia de todos los documentos o de un subconjunto de ellos 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 realiza en segundo plano y su progreso se puede supervisar y administrar a través del recurso de operación que se crea. El resultado de una exportación solo se puede usar después de que se complete la operación asociada. Si se cancela una operación de exportación antes de completarse, es posible que se conserven datos parciales en Google Cloud Storage.

Permisos de autorización

Se necesita uno de los siguientes alcances de OAuth:

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

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

GetIndex

GetIndex
`rpc GetIndex(GetIndexRequest) returns (Index)` Obtiene un índice. Permisos de autorización Se necesita uno de los siguientes alcances de OAuth: `https://www.googleapis.com/auth/datastore` `https://www.googleapis.com/auth/cloud-platform` Para obtener más información, consulta Descripción general de la autenticación.

rpc GetIndex(GetIndexRequest) returns (Index)

Obtiene un índice.

Permisos de autorización

Se necesita uno de los siguientes alcances de OAuth:

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

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

ImportDocuments

ImportDocuments
`rpc ImportDocuments(ImportDocumentsRequest) returns (Operation)` Importa documentos a Google Cloud Firestore. Se reemplazarán los documentos existentes con el mismo nombre. La importación se realiza en segundo plano, y su progreso se puede supervisar y administrar mediante el recurso de operación que se crea. Si se cancela una operación ImportDocuments, es posible que un subconjunto de los datos ya se haya importado a Cloud Firestore. Permisos de autorización Se necesita uno de los siguientes alcances de OAuth: `https://www.googleapis.com/auth/datastore` `https://www.googleapis.com/auth/cloud-platform` Para obtener más información, consulta Descripción general de la autenticación.

rpc ImportDocuments(ImportDocumentsRequest) returns (Operation)

Importa documentos a Google Cloud Firestore. Se reemplazarán los documentos existentes con el mismo nombre. La importación se realiza en segundo plano, y su progreso se puede supervisar y administrar mediante el recurso de operación que se crea. Si se cancela una operación ImportDocuments, es posible que un subconjunto de los datos ya se haya importado a Cloud Firestore.

Permisos de autorización

Se necesita uno de los siguientes alcances de OAuth:

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

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

ListIndexes

ListIndexes
`rpc ListIndexes(ListIndexesRequest) returns (ListIndexesResponse)` Enumera los índices que coinciden con los filtros especificados. Permisos de autorización Se necesita uno de los siguientes alcances de OAuth: `https://www.googleapis.com/auth/datastore` `https://www.googleapis.com/auth/cloud-platform` Para obtener más información, consulta Descripción general de la autenticación.

rpc ListIndexes(ListIndexesRequest) returns (ListIndexesResponse)

Enumera los índices que coinciden con los filtros especificados.

Permisos de autorización

Se necesita uno de los siguientes alcances de OAuth:

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

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

CreateIndexRequest

La solicitud para 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 que se creará. Los campos de nombre y estado son solo de salida y se ignorarán. Algunos índices de campo único no se pueden crear ni borrar.

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 que se creará. Los campos de nombre y estado son solo de salida y se ignorarán. Algunos índices de campo único no se pueden crear ni borrar.

DeleteIndexRequest

La solicitud para 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}

ExportDocumentsMetadata

Metadatos de las operaciones de ExportDocuments.

Campos
`start_time`	`Timestamp` Es la hora a la que comenzó el trabajo en la operación.
`end_time`	`Timestamp` La hora en la que finalizó la operación, ya sea de forma correcta o de otra manera. Anula la configuración 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 de la cantidad de documentos procesados.
`progress_bytes`	`Progress` Una estimación de la cantidad de bytes procesados.
`collection_ids[]`	`string` Los IDs de colección que se exportan.
`output_uri_prefix`	`string` El lugar al que se exportan las entidades.

ExportDocumentsRequest

La solicitud para FirestoreAdmin.ExportDocuments.

Campos

Campos
`name`	`string` Base de datos para exportar. Debe tener el formato `projects/{project_id}/databases/{database_id}`.
`collection_ids[]`	`string` Los IDs de colección que se exportarán. Si no se especifica, se incluirán todas las colecciones.
`output_uri_prefix`	`string` El URI de salida. Actualmente, solo admite URI de Google Cloud Storage con el formato `gs://BUCKET_NAME[/NAMESPACE_PATH]`, en el que `BUCKET_NAME` es el nombre del bucket de Google Cloud Storage y `NAMESPACE_PATH` es una ruta de espacio de nombres opcional de Google Cloud Storage. Cuando elijas un nombre, asegúrate de tener en cuenta los lineamientos para asignar nombres de Google Cloud Storage: https://cloud.google.com/storage/docs/naming. Si el URI es un bucket (sin una ruta de espacio de nombres), se generará un prefijo en función de la hora de inicio.

name

string

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

collection_ids[]

string

Los IDs de colección que se exportarán. Si no se especifica, se incluirán todas las colecciones.

output_uri_prefix

string

El URI de salida. Actualmente, solo admite URI de Google Cloud Storage con el formato gs://BUCKET_NAME[/NAMESPACE_PATH], en el que BUCKET_NAME es el nombre del bucket de Google Cloud Storage y NAMESPACE_PATH es una ruta de espacio de nombres opcional de Google Cloud Storage. Cuando elijas un nombre, asegúrate de tener en cuenta los lineamientos para asignar nombres de Google Cloud Storage: https://cloud.google.com/storage/docs/naming. Si el URI es un bucket (sin una ruta de espacio de nombres), se generará un prefijo en función de la hora de inicio.

ExportDocumentsResponse

Se muestra en el campo de respuesta google.longrunning.Operation.

Campos

Campos
`output_uri_prefix`	`string` Ubicación de los archivos de salida. Se puede usar para comenzar una importación en Cloud Firestore (este proyecto o algún otro) después de que la operación se complete correctamente.

output_uri_prefix

string

Ubicación de los archivos de salida. Se puede usar para comenzar una importación en Cloud Firestore (este proyecto o algún otro) después de que la operación se complete correctamente.

GetIndexRequest

La solicitud para FirestoreAdmin.GetIndex.

Campos

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

name

string

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

ImportDocumentsMetadata

Metadatos para operaciones de ImportDocuments.

Campos
`start_time`	`Timestamp` Es la hora a la que comenzó el trabajo en la operación.
`end_time`	`Timestamp` La hora en la que finalizó la operación, ya sea de forma correcta o de otra manera. Anula la configuración 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 de la cantidad de documentos procesados.
`progress_bytes`	`Progress` Una estimación de la cantidad de bytes procesados.
`collection_ids[]`	`string` Los IDs de colección que se importan.
`input_uri_prefix`	`string` La ubicación de los documentos que se importan.

ImportDocumentsRequest

La solicitud para FirestoreAdmin.ImportDocuments.

Campos

Campos
`name`	`string` Base de datos a la que se importará. Debe tener el formato `projects/{project_id}/databases/{database_id}`.
`collection_ids[]`	`string` Los IDs de colecciones que se deben importar. Si no se especifica, se refiere a todas las colecciones incluidas en la importación.
`input_uri_prefix`	`string` Ubicación de los archivos exportados Este debe coincidir con el output_uri_prefix de ExportDocumentsResponse de una exportación que se completó correctamente. Consulta: `google.firestore.admin.v1beta1.ExportDocumentsResponse.output_uri_prefix`.

name

string

Base de datos a la que se importará. Debe tener el formato projects/{project_id}/databases/{database_id}.

collection_ids[]

string

Los IDs de colecciones que se deben importar. Si no se especifica, se refiere a todas las colecciones incluidas en la importación.

input_uri_prefix

string

Ubicación de los archivos exportados Este debe coincidir con el output_uri_prefix de ExportDocumentsResponse de una exportación que se completó correctamente. Consulta: google.firestore.admin.v1beta1.ExportDocumentsResponse.output_uri_prefix.

Índice

Una definición de índice.

Campos
`name`	`string` El nombre del recurso del índice. Solo salida.
`collection_id`	`string` El ID de colección al que se aplica este índice. Obligatorio.
`fields[]`	`IndexField` Los campos que se indexarán.
`state`	`State` Es el estado del índice. Solo salida.

Estado

Es el estado de un índice. Durante la creación del índice, este tendrá el estado CREATING. Si el índice se creó correctamente, pasará al estado READY. Si no se puede crear el índice, pasará al estado ERROR.

Enumeradores
`STATE_UNSPECIFIED`	El estado no está especificado.
`CREATING`	Se está creando el índice. Hay una operación activa de larga duración para el índice. El índice se actualiza cuando se escribe un documento. Es posible que existan algunos datos de índice.
`READY`	El índice está listo para usarse. El índice se actualiza cuando se escribe un documento. El índice se propaga por completo con todos los documentos almacenados a los que se aplica.
`ERROR`	Se estaba creando el índice, pero se produjo un error. No hay una operación de larga duración activa para el índice, y la última operación de larga duración finalizada falló. El índice no se actualiza cuando se escribe un documento. Es posible que existan algunos datos de índice.

IndexField

Es un campo de un índice.

Campos

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

field_path

string

La ruta del campo. Debe coincidir con la especificación de la ruta del campo que se describe en [google.firestore.v1beta1.Document.fields][fields]. La ruta de campo especial __name__ la puede usar sola o al final de una ruta de acceso. __type__ solo se puede usar al final de la ruta de acceso

mode

Mode

El modo del campo.

Moda

El modo determina cómo se indexa un campo.

Enumeradores
`MODE_UNSPECIFIED`	El modo no está especificado.
`ASCENDING`	Los valores del campo se indexan para admitir la secuencia en orden ascendente y también consultar por <, >, <=, >= y =.
`DESCENDING`	Los valores del campo se indexan de manera que se admitan la secuencia en orden descendente y también se consultan por <, >, <=, >= y =.
`ARRAY_CONTAINS`	Los valores del array del campo se indexan para admitir la membresía mediante consultas ARRAY_CONTAINS.

IndexOperationMetadata

Metadatos de las operaciones de índice. Estos metadatos propagan el campo de metadatos de google.longrunning.Operation.

Campos
`start_time`	`Timestamp` Es la hora a la que comenzó el trabajo en la operación.
`end_time`	`Timestamp` La hora en la que finalizó la operación, ya sea de forma correcta o de otra manera. Anula la configuración 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` Es verdadero si se canceló `google.longrunning.Operation`. Si la cancelación está en curso, la cancelación será verdadera, pero `google.longrunning.Operation.done` será falsa.
`document_progress`	`Progress` Progreso de la operación existente, medido en la cantidad de documentos.

OperationType

El tipo de operación de índice.

Enumeradores
`OPERATION_TYPE_UNSPECIFIED`	No se especifica. Nunca establecido por el servidor.
`CREATING_INDEX`	La operación crea el índice. Se inició con una llamada al `CreateIndex`.

ListIndexesRequest

La solicitud para FirestoreAdmin.ListIndexes.

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

ListIndexesResponse

La respuesta para FirestoreAdmin.ListIndexes.

Campos

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

indexes[]

Index

Los índices.

next_page_token

string

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

LocationMetadata

Este tipo no tiene campos.

Mensaje de metadatos para google.cloud.location.Location.metadata.

OperationState

Los distintos estados posibles de una operación en curso.

Enumeradores
`STATE_UNSPECIFIED`	No se especifica.
`INITIALIZING`	Se está preparando la solicitud para su procesamiento.
`PROCESSING`	La solicitud se está procesando de forma activa.
`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 se procesó y está en la etapa de finalización.
`SUCCESSFUL`	La solicitud se completó correctamente.
`FAILED`	La solicitud se terminó de procesar, pero se produjo un error.
`CANCELLED`	La solicitud terminó de cancelarse después de que el usuario llamó a google.longrunning.Operations.CancelOperation.

Progreso

Mide el progreso de una métrica en particular.

Campos

Campos
`work_completed`	`int64` Una estimación de la cantidad de trabajo completado. Ten en cuenta que este valor puede ser mayor que `work_estimated`.
`work_estimated`	`int64` Una estimación de la cantidad de trabajo que 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 la cantidad de trabajo completado. Ten en cuenta que este valor puede ser mayor que work_estimated.

work_estimated

int64

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