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

Paquete google.firestore.admin.v1beta1

Índice

FirestoreAdmin

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 lo definido 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 asíncrona. Se crea un recurso Operación para cada operación asíncrona. El estado de la operación (incluidos los errores encontrados) puede consultarse a través del recurso Operación.

Metadatos

Proporciona metadatos e información estadística sobre datos en Cloud Firestore. Los datos proporcionados como parte de esta API pueden ser 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 puede cancelarse. 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.

Una operación que se realiza puede eliminarse para que ya no aparezca como parte de la colección Operación.

Las operaciones son creadas por el servicio FirestoreAdmin , pero se accede a través del servicio google.longrunning.Operations .

CreateIndex

rpc CreateIndex( CreateIndexRequest ) returns ( Operation )

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

Durante la creación, el proceso podría provocar un error, en cuyo caso el índice se moverá 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 la Descripción general de la autenticación .

DeleteIndex

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 la Descripción general de la autenticación .

Documentos de exportació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. Las actualizaciones recientes de documentos pueden no reflejarse en la exportación. La exportación se realiza en segundo plano y su progreso se puede monitorear y administrar a través del recurso Operación que se crea. La salida de una exportación solo se puede usar una vez que se realiza la operación asociada. Si se cancela una operación de exportación antes de completarse, puede dejar 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 la Descripción general de la autenticación .

GetIndex

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 la Descripción general de la autenticación .

Importar documentos

rpc ImportDocuments( ImportDocumentsRequest ) returns ( Operation )

Importa documentos en Google Cloud Firestore. Los documentos existentes con el mismo nombre se sobrescriben. La importación se realiza 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 un subconjunto de datos ya se haya importado 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 la Descripción general de la autenticación .

ListIndexes

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 la Descripción general de la autenticación .

CreateIndexRequest

La solicitud de FirestoreAdmin.CreateIndex .

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 son solo de salida y serán ignorados. Ciertos índices de campo único no se pueden crear o eliminar.

DeleteIndexRequest

La solicitud de FirestoreAdmin.DeleteIndex .

Campos
name

string

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

ExportDocumentsMetadata

Metadatos para operaciones de ExportDocuments.

Campos
start_time

Timestamp

El momento en que comenzó el trabajo en la operación.

end_time

Timestamp

La hora a la que finalizó la operación, ya sea con éxito o no. Desarmar 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.

ExportDocumentsRequest

La solicitud de FirestoreAdmin.ExportDocuments .

Campos
name

string

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

collection_ids[]

string

Qué ID de colección exportar. No especificado significa todas las colecciones.

output_uri_prefix

string

El URI de salida. Actualmente solo admite URI de Google Cloud Storage de la forma: 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 tener en cuenta 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 basado en la hora de inicio.

ExportaciónDocumentosRespuesta

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

Campos
output_uri_prefix

string

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

GetIndexRequest

La solicitud de FirestoreAdmin.GetIndex .

Campos
name

string

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

El momento en que comenzó el trabajo en la operación.

end_time

Timestamp

La hora a la que finalizó la operación, ya sea con éxito o no Desarmar 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.

ImportDocumentsRequest

La solicitud de FirestoreAdmin.ImportDocuments .

Campos
name

string

Base de datos para importar. Debe tener la forma: 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 output_uri_prefix de un ExportDocumentsResponse de una exportación que se ha completado con éxito. Ver: 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. Necesario.

fields[]

IndexField

Los campos a indexar.

state

State

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

Enumeraciones
STATE_UNSPECIFIED El estado no está especificado.
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. Algunos datos de índice pueden existir.
READY El índice está listo para ser utilizado. El índice se actualiza al escribir un documento. El índice está completamente poblado de todos los documentos almacenados a los que se aplica.
ERROR El índice se estaba creando, pero algo salió mal. No hay ninguna operación activa de larga duración para el índice, y la última operación de larga duración finalizada falló. El índice no se actualiza al escribir un documento. Algunos datos de índice pueden existir.

IndexField

Un campo de un índice.

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 de campo especial __name__ se puede usar sola o al final de una ruta. __type__ se puede usar al final del camino.

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 secuencia en orden ascendente y también consultar por <,>, <=,> = y =.
DESCENDING Los valores del campo están indexados para admitir la secuencia en orden descendente y también consultar por <,>, <=,> = y =.
ARRAY_CONTAINS Los valores de la matriz del campo se indexan para admitir la membresía mediante consultas ARRAY_CONTAINS.

IndexOperationMetadata

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

Campos
start_time

Timestamp

El momento en que comenzó el trabajo en la operación.

end_time

Timestamp

La hora a la que finalizó la operación, ya sea con éxito o de otra manera. Desarmar 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 google.longrunning.Operation fue cancelado. 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 número de documentos.

Tipo de operación

El tipo de operación de índice.

Enumeraciones
OPERATION_TYPE_UNSPECIFIED No especificado Nunca establecido por el servidor.
CREATING_INDEX La operación está creando el índice. Iniciado por una llamada CreateIndex .

ListIndexesRequest

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 estándar de la lista.

page_token

string

El token de página de Lista estándar.

ListIndexesResponse

La respuesta para FirestoreAdmin.ListIndexes .

Campos
indexes[]

Index

Los índices

next_page_token

string

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

LocationMetadata

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

OperationState

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

Enumeraciones
STATE_UNSPECIFIED No especificado
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 haya llamado 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 ha terminado de procesarse, pero encontró un error.
CANCELLED La solicitud ha terminado de cancelarse después de que el usuario haya llamado google.longrunning.Operations.CancelOperation.

Progreso

Mide el progreso de una métrica particular.

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 debe realizarse. Cero si la estimación del trabajo no está disponible. Puede cambiar a medida que avanza el trabajo.