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)

FirestoreAdmin

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

CreateIndex

rpc CreateIndex(CreateIndexRequest) returns (Operation) Crea un índice compuesto. Esto muestra una google.longrunning.Operation que se puede usar para hacer un seguimiento del estado de la creación. Los metadatos de la operación serán del tipo IndexOperationMetadata. 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
rpc DeleteIndex(DeleteIndexRequest) returns (Empty) Borra un índice compuesto. 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

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.

GetField
rpc GetField(GetFieldRequest) returns (Field) Obtiene los metadatos y la configuración de un 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.

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

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.

ListFields

rpc ListFields(ListFieldsRequest) returns (ListFieldsResponse) Enumera la configuración del campo y los metadatos para esta base de datos. Actualmente, FirestoreAdmin.ListFields solo admite campos de lista que se anularon de forma explícita. Para emitir esta consulta, llama a FirestoreAdmin.ListFields con el filtro establecido en indexConfig.usesAncestorConfig:false. 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
rpc ListIndexes(ListIndexesRequest) returns (ListIndexesResponse) Muestra una lista de los índices compuestos. 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.

UpdateField

rpc UpdateField(UpdateFieldRequest) returns (Operation) Actualiza la configuración de un campo. Actualmente, las actualizaciones de campos se aplican solo a la configuración de índices 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 llamador no conozca. La máscara de campo debe especificarse de la siguiente manera: { paths: "index_config" }. Esta llamada muestra un google.longrunning.Operation que se puede usar para realizar un seguimiento del estado de la actualización del campo. Los metadatos de la operación serán del tipo FieldOperationMetadata. Para establecer la configuración de campo predeterminada para la base de datos, usa el Field especial con el nombre del recurso: projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/*. 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
parent	string Un nombre superior con el formato projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}
index	Index El índice compuesto que se creará.

DeleteIndexRequest

La solicitud para FirestoreAdmin.DeleteIndex.

Campos
name	string Un nombre con el formato projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}

ExportDocumentsMetadata

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

Campos
start_time	Timestamp La hora en que comenzó esta operación.
end_time	Timestamp La hora en que se completó esta operación. No se establecerá si la operación aún está en curso.
operation_state	OperationState El estado de la operación de exportación.
progress_documents	Progress El progreso, en documentos, de esta operación.
progress_bytes	Progress El progreso, en bytes, de esta operación.
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
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
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.

Técnica

Representa un campo único en la base de datos.

Los campos se agrupan por su "Grupo de colecciones", que representa todas las colecciones de la base de datos con el mismo ID.

Campos
name	string Un nombre de campo con el formato projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path} La ruta de un campo puede ser un nombre simple de campo, p.ej., address, o una ruta de acceso a campos dentro de map_value , p.ej., address.city, o una ruta de acceso de campo especial. El único campo especial válido es *, que representa cualquier campo. Las rutas de los campos se pueden usar con (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:\represents a field namedrepresents a field named, not the map key in the field. Una 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 índices de Field.
index_config	IndexConfig La configuración de índices para este campo. Si no la estableces, la indexación de campos volverá a la configuración definida por ancestor_field. Para quitar de forma explícita todos los índices de este campo, especifica una configuración de índices con una lista vacía de índices.

IndexConfig

La configuración de índices para este campo.

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

FieldOperationMetadata

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

Campos
start_time	Timestamp La hora en que comenzó esta operación.
end_time	Timestamp La hora en que se completó esta operación. No se establecerá si la operación aún está en curso.
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 el intent de esta operación.
state	OperationState El estado de la operación.
document_progress	Progress El progreso, en documentos, de esta operación.
bytes_progress	Progress El progreso, en bytes, de esta operación.

IndexConfigDelta

Información sobre un cambio en la configuración de índices.

Campos
change_type	ChangeType Especifica cómo cambia el índice.
index	Index El índice que se cambia.

ChangeType

Especifica cómo cambia el índice.

Enumeradores
CHANGE_TYPE_UNSPECIFIED	El tipo de cambio no se especifica o no se conoce.
ADD	Se está agregando el índice de campo único.
REMOVE	Se quitará el índice de campo único.

GetFieldRequest

La solicitud para FirestoreAdmin.GetField.

Campos
name	string Un nombre con el formato projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_id}

GetIndexRequest

La solicitud para FirestoreAdmin.GetIndex.

Campos
name	string Un nombre con el formato projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}

ImportDocumentsMetadata

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

Campos
start_time	Timestamp La hora en que comenzó esta operación.
end_time	Timestamp La hora en que se completó esta operación. No se establecerá si la operación aún está en curso.
operation_state	OperationState El estado de la operación de importación.
progress_documents	Progress El progreso, en documentos, de esta operación.
progress_bytes	Progress El progreso, en bytes, de esta operación.
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
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.v1beta2.ExportDocumentsResponse.output_uri_prefix.

Índice

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

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

IndexField

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

Campos
field_path	string Puede ser name. En el caso de los índices de campo único, debe coincidir con el nombre del campo o puede omitirse.
Campo de unión value_mode. Cómo se indexa el valor del campo. Las direcciones (value_mode) solo pueden ser una de las siguientes opciones:
order	Order Indica que este campo admite ordenar según el orden especificado o comparar con =, <, <=, >, >=.
array_config	ArrayConfig Indica que este campo admite operaciones en array_value.

ArrayConfig

Son las configuraciones compatibles de valores de array.

Enumeradores
ARRAY_CONFIG_UNSPECIFIED	El índice no admite consultas de array adicionales.
CONTAINS	El índice admite consultas de contención de arrays.

Pedidos

Los pedidos admitidos.

Enumeradores
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.

QueryScope

El permiso de la consulta define el alcance en el que se ejecuta una consulta. Esto se especifica en un campo from de StructuredQuery.

Enumeradores
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 colecciones especificado permiten realizar consultas en una colección que es el elemento secundario de un documento específico, especificado en el momento de la consulta y que tiene el ID de colección especificado por el índice.
COLLECTION_GROUP	Los índices con un alcance de consulta de grupo de colecciones especificado permiten realizar consultas en todas las colecciones que tienen el ID de colección especificado en el índice.

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 la creación del índice tiene un problema, el índice pasará al estado NEEDS_REPAIR.

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.
NEEDS_REPAIR	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. Usa la API de google.longrunning.Operations para determinar por qué falló la operación que intentó crear el índice por última vez y, luego, vuelve a crearlo.

IndexOperationMetadata

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

Campos
start_time	Timestamp La hora en que comenzó esta operación.
end_time	Timestamp La hora en que se completó esta operación. No se establecerá si la operación aún está en curso.
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 El progreso, en documentos, de esta operación.
progress_bytes	Progress El progreso, en bytes, de esta operación.

ListFieldsRequest

La solicitud para FirestoreAdmin.ListFields.

Campos
parent	string Un nombre superior con el formato projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}
filter	string El filtro que se aplica a los resultados de la lista. Actualmente, FirestoreAdmin.ListFields solo admite campos de lista que se anularon de forma explícita. Para emitir esta consulta, llama a FirestoreAdmin.ListFields con el filtro establecido en indexConfig.usesAncestorConfig:false.
page_size	int32 La cantidad de resultados que se mostrarán.
page_token	string Un token de página, que se muestra desde una llamada anterior a FirestoreAdmin.ListFields, que se puede usar para obtener la siguiente página de resultados.

ListFieldsResponse

La respuesta para FirestoreAdmin.ListFields.

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

ListIndexesRequest

La solicitud para FirestoreAdmin.ListIndexes.

Campos
parent	string Un nombre superior con el formato projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}
filter	string El filtro que se aplica a los resultados de la lista.
page_size	int32 La cantidad de resultados que se mostrarán.
page_token	string Un token de página, que se muestra desde una llamada anterior a FirestoreAdmin.ListIndexes, que se puede usar para obtener la siguiente página de resultados.

ListIndexesResponse

La respuesta para FirestoreAdmin.ListIndexes.

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

OperationState

Describe el estado de la operación.

Enumeradores
OPERATION_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

Describe el progreso de la operación. La unidad de trabajo es genérica y se debe interpretar en función del lugar en el que se usa Progress.

Campos
estimated_work	int64 La cantidad de trabajo estimada.
completed_work	int64 Es la cantidad de trabajo completado.

UpdateFieldRequest

La solicitud para FirestoreAdmin.UpdateField.

Campos
field	Field El campo que se actualizará.
update_mask	FieldMask Una máscara, en relación con el campo. Si se especifica, solo se actualizará la configuración especificada por esta field_mask en el campo.