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

google.firestore.admin.v1 paquete

Índice

FirestoreAdmin

La API de la nube Firestore de administración.

Esta API proporciona varios servicios administrativos para la nube Firestore.

Conceptos

Proyecto, base de datos, espacio de nombres, Colección, Grupo Collection, y el documento se utilizan como se define en la API de Google Cloud Firestore.

Operación: Una operación representa ser el trabajo realizado en el fondo.

Servicios

Índice

El servicio gestiona índice de índices Nube FireStore.

la creación del índice se realiza de forma asíncrona. Un recurso operación se crea para cada operación de este tipo asíncrono. El estado de la operación (incluyendo los errores encontrados) puede ser consultado a través de los recursos de funcionamiento.

Operación

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

Una operación que se realiza puede ser eliminado de manera que ya no se muestra como parte de la colección de operación. Las operaciones son basura recogida después de 30 días. Por defecto, ListOperations solo devolverán en curso y operaciones fallidas. A la lista de completado la operación, emitir una ListOperations solicitan con el filtro done: true .

Las operaciones son creados por el servicio FirestoreAdmin , pero se accede a través de servicios google.longrunning.Operations .

CreateIndex

rpc CreateIndex( CreateIndexRequest ) returns ( Operation )

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

autorización Scopes

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 Introducción a la autenticación .

deleteIndex

rpc DeleteIndex( DeleteIndexRequest ) returns ( Empty )

Elimina un índice compuesto.

autorización Scopes

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 Introducción a la autenticación .

ExportDocuments

rpc ExportDocuments( ExportDocumentsRequest ) returns ( Operation )

Exporta una copia de todos o un subconjunto de documentos de Google Cloud Firestore a otro sistema de almacenamiento, tales como Google Cloud Storage. Cambios recientes en los documentos no se pueden reflejar en la exportación. La exportación se produzca en el fondo y su progreso se puede supervisar y gestionar a través de los recursos de operación que se crea. La salida de una exportación sólo puede ser utilizado una vez que se realiza la operación asociada. Si una operación de exportación se cancela antes de la terminación que puede dejar los datos parciales atrás en Google Cloud Storage.

autorización Scopes

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 Introducción a la autenticación .

GetField

rpc GetField( GetFieldRequest ) returns ( Field )

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

autorización Scopes

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 Introducción a la autenticación .

GetIndex

rpc GetIndex( GetIndexRequest ) returns ( Index )

Obtiene un índice compuesto.

autorización Scopes

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 Introducción a la autenticación .

ImportDocuments

rpc ImportDocuments( ImportDocumentsRequest ) returns ( Operation )

Importa documentos en la nube de Google Firestore. Los documentos existentes con el mismo nombre se sobrescriben. La importación se produce en el fondo y su progreso se puede supervisar y gestionar a través de los recursos de operación que se crea. Si se cancela una operación ImportDocuments, es posible que un subconjunto de los datos ya se ha importado a la nube Firestore.

autorización Scopes

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 Introducción a la autenticación .

ListFields

rpc ListFields( ListFieldsRequest ) returns ( ListFieldsResponse )

Lista la configuración de campo y de metadatos para esta base de datos.

Actualmente, FirestoreAdmin.ListFields solamente soporta el listado de campos que han sido explícitamente ignorado. Para emitir esta consulta, llamada FirestoreAdmin.ListFields con el conjunto de filtro para indexConfig.usesAncestorConfig:false .

autorización Scopes

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 Introducción a la autenticación .

ListIndexes

rpc ListIndexes( ListIndexesRequest ) returns ( ListIndexesResponse )

Listas de índices compuestos.

autorización Scopes

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 Introducción a la autenticación .

ACTUALIZACAMPO

rpc UpdateField( UpdateFieldRequest ) returns ( Operation )

Actualiza una configuración de campo. Actualmente, las actualizaciones de campo sólo se aplican 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 el llamante no es consciente. La máscara de campo debe ser especificado como: { paths: "index_config" } .

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

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

autorización Scopes

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 Introducción a la autenticación .

CreateIndexRequest

La solicitud de FirestoreAdmin.CreateIndex .

Campos
parent

string

Necesario. Un nombre de los padres de la forma de projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}

index

Index

Necesario. El índice compuesto a crear.

DeleteIndexRequest

La solicitud de FirestoreAdmin.DeleteIndex .

Campos
name

string

Necesario. Un nombre de la forma de projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}

ExportDocumentsMetadata

Metadatos para google.longrunning.Operation resulta de FirestoreAdmin.ExportDocuments .

Campos
start_time

Timestamp

El tiempo de esta operación comenzó.

end_time

Timestamp

El tiempo de esta operación se ha completado. Será desactivada si la operación aún en curso.

operation_state

OperationState

El estado de la operación de exportación.

progress_documents

Progress

El progreso, en los documentos, de esta operación.

progress_bytes

Progress

El progreso, en bytes, de esta operación.

collection_ids[]

string

Qué ID de recolección están siendo exportados.

output_uri_prefix

string

Cuando las entidades están siendo exportados a.

ExportDocumentsRequest

La solicitud de FirestoreAdmin.ExportDocuments .

Campos
name

string

Necesario. Base de datos para la exportación. Debe ser de la forma: projects/{project_id}/databases/{database_id} .

collection_ids[]

string

Qué ID de cobro para la exportación. medios no especificados todas las colecciones.

output_uri_prefix

string

La salida URI. Actualmente sólo es compatible con Google Cloud Storage URI de la forma: gs://BUCKET_NAME[/NAMESPACE_PATH] , donde BUCKET_NAME es el nombre del segmento de Google Cloud Storage y NAMESPACE_PATH es una ruta opcional espacio de nombres de Google Cloud Storage. Al elegir un nombre, asegúrese de considerar Google Cloud Storage directrices de nomenclatura: https://cloud.google.com/storage/docs/naming . Si el URI es un cubo (sin una ruta espacio de nombres), se generará un prefijo basado en la hora de inicio.

ExportDocumentsResponse

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

Campos
output_uri_prefix

string

Ubicación de los archivos de salida. Esto se puede utilizar para iniciar una importación en la nube Firestore (este proyecto u otro del proyecto) después de la operación se realiza completamente.

Campo

Representa un único campo en la base de datos.

Los campos se agrupan por su "Grupo Collection", que representan todas las colecciones en la base de datos con el mismo id.

Campos
name

string

Un nombre de campo de la forma de projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}

Un camino de campo puede ser un simple nombre de campo, por ejemplo, address o una ruta de acceso a campos dentro de map_value, por ejemplo address.city , o una ruta campo especial. El campo especial es válida solamente * , que representa cualquier campo.

Caminos de tierra pueden ser citados 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 los caracteres simbólicos ASCII.

Ejemplos: (Nota: Los comentarios aquí están escritos en la sintaxis de reducción del precio, por lo que hay una capa adicional de acentos abiertos para representar un bloque de código) \ address.city` represents a field named address.city , not the map key de la ciudad in the field de direcciones . * `` represents a field named * `, no cualquier campo.

Un especial Field contiene la configuración de indexación por defecto para todos los campos. Nombre de recurso de este campo es: projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/* índice definido en este Field se aplicarán a todos los campos que no tienen su propio Field de configuración del índice.

index_config

IndexConfig

La configuración de índice para este campo. Si no se configura, indexación campo volverá a la configuración definida por el ancestor_field . Para eliminar de forma explícita todos los índices para este campo, especificar una configuración de índice con una lista vacía de índices.

IndexConfig

La configuración de índice para este campo.

Campos
indexes[]

Index

Los índices compatibles con este campo.

uses_ancestor_config

bool

única salida. Cuando cierto, el Field de configuración de índice 's se establece a partir de la configuración especificada por el ancestor_field . Cuando falso, el Field de configuración de índice 's se define explícitamente.

ancestor_field

string

única salida. Especifica el nombre del recurso del Field desde el cual se establece la configuración de índices de este campo (cuando uses_ancestor_config es cierto), o de la que se establecería si este campo no tenía ninguna configuración del índice (cuando uses_ancestor_config es falso).

reverting

bool

Salida sólo cuando cierto, el Field de configuración de índice 's está en el proceso de ser revertido. Una vez completa, la config í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 .

FieldOperationMetadata

Metadatos para google.longrunning.Operation resulta de FirestoreAdmin.UpdateField .

Campos
start_time

Timestamp

El tiempo de esta operación comenzó.

end_time

Timestamp

El tiempo de esta operación se ha completado. Será desactivada si la operación aún en curso.

field

string

El recurso de campo que esta operación está actuando sobre. Por ejemplo: projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}

index_config_deltas[]

IndexConfigDelta

Una lista de IndexConfigDelta , que describen la intención de esta operación.

state

OperationState

El estado de la operación.

progress_documents

Progress

El progreso, en los documentos, de esta operación.

progress_bytes

Progress

El progreso, en bytes, de esta operación.

IndexConfigDelta

La información sobre un cambio de configuración de índice.

Campos
change_type

ChangeType

Especifica cómo el índice está cambiando.

index

Index

El índice está cambiando.

changetype

Especifica cómo el índice está cambiando.

enumeraciones
CHANGE_TYPE_UNSPECIFIED El tipo de cambio no se especifica o conocido.
ADD se añade el índice de campo único.
REMOVE se extrae el índice de campo único.

GetFieldRequest

La solicitud de FirestoreAdmin.GetField .

Campos
name

string

Necesario. Un nombre de la forma de projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_id}

GetIndexRequest

La solicitud de FirestoreAdmin.GetIndex .

Campos
name

string

Necesario. Un nombre de la forma de projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}

ImportDocumentsMetadata

Metadatos para google.longrunning.Operation resulta de FirestoreAdmin.ImportDocuments .

Campos
start_time

Timestamp

El tiempo de esta operación comenzó.

end_time

Timestamp

El tiempo de esta operación se ha completado. Será desactivada si la operación aún en curso.

operation_state

OperationState

El estado de la operación de importación.

progress_documents

Progress

El progreso, en los documentos, de esta operación.

progress_bytes

Progress

El progreso, en bytes, de esta operación.

collection_ids[]

string

Qué ID de recolección están siendo importados.

input_uri_prefix

string

La ubicación de los documentos que se importa.

ImportDocumentsRequest

La solicitud de FirestoreAdmin.ImportDocuments .

Campos
name

string

Necesario. Base de datos para en la importación. En caso de ser de la forma: projects/{project_id}/databases/{database_id} .

collection_ids[]

string

¿Qué id de colecciones de importación. medios no especificados 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 un ExportDocumentsResponse de una exportación que ha completado con éxito. Ver: google.firestore.admin.v1.ExportDocumentsResponse.output_uri_prefix .

Índice

índices nube FireStore permiten consultas simples y complejas en contra de los documentos en una base de datos.

Campos
name

string

única salida. Un servidor de nombre definido para este índice. La forma de este nombre para los índices compuestos será: projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{composite_index_id} para los índices de campo individuales, este campo estará vacío.

query_scope

QueryScope

Índices con un ámbito de recogida de consulta especificada permitir consultas en una colección que es el hijo de un documento específico, determinado en tiempo de consulta, y que tiene el mismo ID de colección.

Índices de alcance consulta grupo colección especificada permitir consultas en todas las colecciones que descienden de un documento específico, especificados en tiempo de consulta, y que tienen el mismo identificador de colección ya que este índice.

fields[]

IndexField

Los campos compatibles con este índice.

Para los índices compuestos, esto es siempre 2 o más campos. La última entrada de campo es siempre el camino del campo __name__ . Si, en la creación, __name__ no se especificó como el último campo, se añadirá 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 (menos que se especifique explícitamente).

Para los índices de campo individuales, esto siempre será exactamente una entrada con un camino de campo igual a la trayectoria de campo del campo asociado.

state

State

única salida. El estado de servir de índice.

IndexField

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

Campos
field_path

string

Puede ser el nombre. Para los índices de campo individuales, esta debe coincidir con el nombre del campo o puede ser omitido.

Unión de campo value_mode . ¿Cómo está indexado el valor del campo. value_mode puede ser sólo uno de los siguientes:
order

Order

Indica que este soportes de campo de ordenar por el orden especificado o la comparación usando =, <, <=,>,> =.

array_config

ArrayConfig

Indica que este campo de operaciones soportes en array_value s.

ArrayConfig

Las configuraciones valor de matriz compatibles.

enumeraciones
ARRAY_CONFIG_UNSPECIFIED El índice no admite consultas de matriz adicionales.
CONTAINS Los soportes de índice de matriz de contención consultas.

Orden

Los ordenamientos compatibles.

enumeraciones
ORDER_UNSPECIFIED El orden es no especificado. No es una opción válida.
ASCENDING El campo se ordena por el valor del campo ascendente.
DESCENDING El campo se ordena al descender el valor del campo.

QueryScope

Consulta Alcance define el alcance en el que se ejecuta una consulta. Esto se especifica en un StructuredQuery es from campo.

enumeraciones
QUERY_SCOPE_UNSPECIFIED El alcance de consulta no está especificado. No es una opción válida.
COLLECTION Índices con un ámbito de recogida de consulta especificada permitir consultas en una colección que es el hijo de un documento específico, determinado en tiempo de consulta, y que tiene el ID de colección especificado por el índice.
COLLECTION_GROUP Índices de alcance consulta grupo colección especificada permiten consultas en todas las colecciones que tiene el ID de colección especificado por el índice.

Estado

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

enumeraciones
STATE_UNSPECIFIED El estado está especificado.
CREATING se crea el índice. Hay una operación de larga duración activa para el índice. El índice se actualiza al escribir un documento. puede existir cierta datos de índice.
READY El índice está listo para ser utilizado. El índice se actualiza al escribir un documento. El índice está completamente poblada de todos los documentos almacenados que se aplica.
NEEDS_REPAIR Se crea el índice, pero algo salió mal. No hay ninguna operación de larga duración activa para el índice, y la operación de larga duración, más recientemente terminado falló. El índice no se actualiza cuando se escribe un documento. puede existir cierta datos de índice. Utilizar la API google.longrunning.Operations para determinar por qué la operación de ese último tratado de crear este índice ha fallado, vuelva a crear el índice.

IndexOperationMetadata

Metadatos para google.longrunning.Operation resulta de FirestoreAdmin.CreateIndex .

Campos
start_time

Timestamp

El tiempo de esta operación comenzó.

end_time

Timestamp

El tiempo de esta operación se ha completado. Será desactivada si la operación aún en curso.

index

string

El índice de recursos que esta operación está actuando sobre. 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

El progreso, en los documentos, de esta operación.

progress_bytes

Progress

El progreso, en bytes, de esta operación.

ListFieldsRequest

La solicitud de FirestoreAdmin.ListFields .

Campos
parent

string

Necesario. Un nombre de los padres de la forma de projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}

filter

string

El filtro a aplicar a la lista de resultados. Actualmente, FirestoreAdmin.ListFields solamente soporta el listado de campos que han sido explícitamente ignorado. Para emitir esta consulta, llamada FirestoreAdmin.ListFields con el conjunto de filtro para indexConfig.usesAncestorConfig:false .

page_size

int32

El número de resultados a devolver.

page_token

string

Una página de ficha, de regresar de una llamada previa a FirestoreAdmin.ListFields , que puede ser utilizado para obtener la página siguiente de resultados.

ListFieldsResponse

La respuesta de FirestoreAdmin.ListFields .

Campos
fields[]

Field

Los campos requeridos.

next_page_token

string

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

ListIndexesRequest

La solicitud de FirestoreAdmin.ListIndexes .

Campos
parent

string

Necesario. Un nombre de matriz de la forma de projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}

filter

string

El filtro a aplicar a la lista de resultados.

page_size

int32

El número de resultados a devolver.

page_token

string

Una página de ficha, de regresar de una llamada previa a FirestoreAdmin.ListIndexes , que puede ser utilizado para obtener la página siguiente de resultados.

ListIndexesResponse

La respuesta de FirestoreAdmin.ListIndexes .

Campos
indexes[]

Index

Los índices requeridos.

next_page_token

string

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

LocationMetadata

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

operationState

Describe el estado de la operación.

enumeraciones
OPERATION_STATE_UNSPECIFIED No especificado.
INITIALIZING Solicitud está siendo preparado para su procesamiento.
PROCESSING Solicitud activamente se está procesando.
CANCELLING Solicitud está en proceso de ser cancelado cuando el usuario llama google.longrunning.Operations.CancelOperation en la operación.
FINALIZING Solicitud ha sido procesado y se encuentra en su etapa de finalización.
SUCCESSFUL Solicitud ha completado con éxito.
FAILED Solicitud ha terminado de ser procesado, pero se encontró con un error.
CANCELLED Solicitud ha terminado ser cancelado cuando el usuario llama google.longrunning.Operations.CancelOperation.

Progreso

Describe el progreso de la operación. Unidad de trabajo es genérico y debe interpretarse según el lugar donde Progress se utiliza.

Campos
estimated_work

int64

La cantidad de trabajo estimado.

completed_work

int64

La cantidad de trabajo realizado.

UpdateFieldRequest

La solicitud de FirestoreAdmin.UpdateField .

Campos
field

Field

Necesario. El campo para ser actualizado.

update_mask

FieldMask

Una máscara, con relación al campo. Si se especifica, única configuración especificado por este field_mask será actualizado en el campo.