Package google.firestore.admin.v1

Índice

Administrador de Firestore

La API de Cloud Firestore Admin.

Esta API proporciona varios servicios administrativos para Cloud Firestore.

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

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

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.

La colección Operations 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 finalizada puede borrarse para que ya no aparezca como parte de la colección Operación. Las operaciones son recolección de elementos no usados luego de 30 días. De forma predeterminada, ListOperations solo mostrará operaciones en curso y con errores. Para mostrar una lista de las operaciones completadas, envía una solicitud ListOperations con el filtro done: true.

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

CreateBackupSchedule

rpc CreateBackupSchedule(CreateBackupScheduleRequest) returns (BackupSchedule)

Crea una programación de copias de seguridad en una base de datos. Se pueden configurar como máximo dos programas de copias de seguridad en una base de datos, uno diario y otro semanal.

Alcances de autorización

Se necesita uno de los siguientes permisos 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.
CreateDatabase

rpc CreateDatabase(CreateDatabaseRequest) returns (Operation)

Crea una base de datos.

Alcances de autorización

Se necesita uno de los siguientes permisos 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.
CreateIndex

rpc CreateIndex(CreateIndexRequest) returns (Operation)

Crea un índice compuesto. Se muestra un 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.

Alcances de autorización

Se necesita uno de los siguientes permisos 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.
DeleteBackup

rpc DeleteBackup(DeleteBackupRequest) returns (Empty)

Borra una copia de seguridad.

Alcances de autorización

Se necesita uno de los siguientes permisos 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.
DeleteBackupSchedule

rpc DeleteBackupSchedule(DeleteBackupScheduleRequest) returns (Empty)

Borra una programación de copia de seguridad.

Alcances de autorización

Se necesita uno de los siguientes permisos 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.
DeleteDatabase

rpc DeleteDatabase(DeleteDatabaseRequest) returns (Operation)

Borra una base de datos.

Alcances de autorización

Se necesita uno de los siguientes permisos 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.

Alcances de autorización

Se necesita uno de los siguientes permisos 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 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 una vez que se complete la operación asociada. Si se cancela una operación de exportación antes de que se complete, es posible que deje datos parciales en Google Cloud Storage.

Para obtener más detalles sobre el comportamiento y el formato de las exportaciones, consulta https://cloud.google.com/firestore/docs/manage-data/export-import.

Alcances de autorización

Se necesita uno de los siguientes permisos 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.
GetBackup

rpc GetBackup(GetBackupRequest) returns (Backup)

Obtiene información sobre una copia de seguridad.

Alcances de autorización

Se necesita uno de los siguientes permisos 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.
GetBackupSchedule

rpc GetBackupSchedule(GetBackupScheduleRequest) returns (BackupSchedule)

Obtiene información sobre un programa de copia de seguridad.

Alcances de autorización

Se necesita uno de los siguientes permisos 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.
GetDatabase

rpc GetDatabase(GetDatabaseRequest) returns (Database)

Obtiene información sobre una base de datos.

Alcances de autorización

Se necesita uno de los siguientes permisos 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.

Alcances de autorización

Se necesita uno de los siguientes permisos 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.

Alcances de autorización

Se necesita uno de los siguientes permisos 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 Operation que se crea. Si se cancela una operación ImportDocuments, es posible que ya se haya importado un subconjunto de datos a Cloud Firestore.

Alcances de autorización

Se necesita uno de los siguientes permisos 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.
ListBackupSchedules

rpc ListBackupSchedules(ListBackupSchedulesRequest) returns (ListBackupSchedulesResponse)

Enumera programas de copias de seguridad.

Alcances de autorización

Se necesita uno de los siguientes permisos 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.
ListBackups

rpc ListBackups(ListBackupsRequest) returns (ListBackupsResponse)

Enumera todas las copias de seguridad.

Alcances de autorización

Se necesita uno de los siguientes permisos 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.
ListDatabases

rpc ListDatabases(ListDatabasesRequest) returns (ListDatabasesResponse)

Haz una lista de todas las bases de datos del proyecto.

Alcances de autorización

Se necesita uno de los siguientes permisos 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 configurado como indexConfig.usesAncestorConfig:false o ttlConfig:*.

Alcances de autorización

Se necesita uno de los siguientes permisos 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)

Enumera los índices compuestos.

Alcances de autorización

Se necesita uno de los siguientes permisos 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.
RestoreDatabase

rpc RestoreDatabase(RestoreDatabaseRequest) returns (Operation)

Crea una base de datos nueva mediante el restablecimiento desde una copia de seguridad existente.

La base de datos nueva debe estar en la misma región de la nube o ubicación multirregional que la copia de seguridad existente. Este comportamiento es similar a [FirestoreAdmin.CreateDatabase][google.firestore.admin.v1.CreateDatabase], excepto que, en lugar de crear una nueva base de datos vacía, se crea una nueva con el tipo de base de datos, la configuración de índice y los documentos de una copia de seguridad existente.

long-running operation se puede usar para realizar un seguimiento del progreso del restablecimiento, y el tipo de campo metadata de la operación es RestoreDatabaseMetadata. El tipo response es Database si el restablecimiento se realizó correctamente. La nueva base de datos no se podrá leer ni escribir hasta que se complete la LRO.

Alcances de autorización

Se necesita uno de los siguientes permisos 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.
UpdateBackupSchedule

rpc UpdateBackupSchedule(UpdateBackupScheduleRequest) returns (BackupSchedule)

Actualiza un programa de copia de seguridad.

Alcances de autorización

Se necesita uno de los siguientes permisos 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.
UpdateDatabase

rpc UpdateDatabase(UpdateDatabaseRequest) returns (Operation)

Actualiza una base de datos.

Alcances de autorización

Se necesita uno de los siguientes permisos 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 campo se aplican solo 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 llamador no conoce. 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 hacer 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 predeterminada del campo de la base de datos, usa el Field especial con el nombre del recurso: projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/*.

Alcances de autorización

Se necesita uno de los siguientes permisos 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.

Copia de seguridad

Una copia de seguridad de una base de datos de Cloud Firestore

La copia de seguridad contiene todos los documentos y las configuraciones de índice para la base de datos determinada en un momento específico.

Campos
name

string

Solo salida. El nombre de recurso único de la copia de seguridad.

El formato es projects/{project}/locations/{location}/backups/{backup}.
database

string

Solo salida. Nombre de la base de datos de Firestore de la que proviene la copia de seguridad.

El formato es projects/{project}/databases/{database}.
database_uid

string

Solo salida. El UUID4 generado por el sistema para la base de datos de Firestore del que proviene la copia de seguridad.
snapshot_time

Timestamp

Solo salida. En este momento, la copia de seguridad contiene una copia coherente de forma externa de la base de datos.
expire_time

Timestamp

Solo salida. La marca de tiempo en la que vence esta copia de seguridad.
state

State

Solo salida. El estado actual de la copia de seguridad.

Estado

Indicar el estado actual de la copia de seguridad

Enums
STATE_UNSPECIFIED El estado no se especifica.
CREATING Aún se está creando la copia de seguridad pendiente. Las operaciones en la copia de seguridad se rechazarán en este estado.
READY La copia de seguridad está completa y lista para usar.
NOT_AVAILABLE La copia de seguridad no está disponible en este momento.

Programación de copia de seguridad

Un programa de copia de seguridad para una base de datos de Cloud Firestore.

Este recurso pertenece a la base de datos de la que se crea una copia de seguridad y se borra junto con la base de datos. Sin embargo, las copias de seguridad reales no lo son.

Campos
name

string

Solo salida. El identificador único de la programación de copias de seguridad en todas las ubicaciones y bases de datos para el proyecto determinado.

Se asignará automáticamente.

El formato es projects/{project}/databases/{database}/backupSchedules/{backup_schedule}
create_time

Timestamp

Solo salida. La marca de tiempo en la que se creó esta programación de copia de seguridad y entró en vigencia desde entonces.

No se crearán copias de seguridad para esta programación antes de esa fecha.
update_time

Timestamp

Solo salida. La marca de tiempo en la que se actualizó este programa de copias de seguridad por última vez. Cuando se crea una programación de copia de seguridad por primera vez, es lo mismo que create_time.
retention

Duration

En qué momento relativo en el futuro y en comparación con su hora de creación, se debe borrar la copia de seguridad, p.ej., conservar copias de seguridad durante 7 días.

El período de retención máximo admitido es de 14 semanas.
Campo de unión recurrence. Un campo único para representar cuándo se realizarán las copias de seguridad. recurrence puede ser solo uno de los siguientes:
daily_recurrence

DailyRecurrence

Para una programación que se ejecuta a diario.
weekly_recurrence

WeeklyRecurrence

Para un programa que se ejecuta todas las semanas en un día específico.

CreateBackupScheduleRequest

La solicitud para FirestoreAdmin.CreateBackupSchedule.

Campos
parent

string

Obligatorio. La base de datos superior.

Formato projects/{project}/databases/{database}
backup_schedule

BackupSchedule

Obligatorio. El programa de copia de seguridad que se creará.

CreateDatabaseMetadata

Este tipo no tiene campos.

Metadatos relacionados con la operación de creación de bases de datos.

CreateDatabaseRequest

La solicitud para FirestoreAdmin.CreateDatabase.

Campos
parent

string

Obligatorio. Un nombre superior con el formato projects/{project_id}
database

Database

Obligatorio. La base de datos que se creará.
database_id

string

Obligatorio. Es el ID que se usará para la base de datos, que se convertirá en el componente final del nombre del recurso de la base de datos.

Este valor debe tener entre 4 y 63 caracteres. Los caracteres válidos son /[a-z][0-9]-/, donde el primer carácter es una letra y, el último, una letra o un número. No debe ser similar a un UUID /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/.

“(predeterminado)” el ID de la base de datos también es válido.

CreateIndexRequest

La solicitud para FirestoreAdmin.CreateIndex.

Campos
parent

string

Obligatorio. Un nombre superior con el formato projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}
index

Index

Obligatorio. El índice compuesto que se creará.

DailyRecurrence

Este tipo no tiene campos.

Representa una programación recurrente que se ejecuta todos los días.

La zona horaria es UTC.

Base de datos

Una base de datos de Cloud Firestore

Campos
name

string

El nombre del recurso de la base de datos. Formato: projects/{project}/databases/{database}
uid

string

Solo salida. El UUID4 generado por el sistema para esta base de datos.
create_time

Timestamp

Solo salida. La marca de tiempo en la que se creó esta base de datos. Las bases de datos creadas antes de 2016 no propagan create_time.
update_time

Timestamp

Solo salida. La marca de tiempo en la que se actualizó esta base de datos por última vez. Ten en cuenta que esto solo incluye actualizaciones del recurso de la base de datos y no de los datos que contiene la base de datos.
delete_time

Timestamp

Solo salida. La marca de tiempo en la que se borró esta base de datos. Solo se configura si se borró la base de datos.
location_id

string

La ubicación de la base de datos. Las ubicaciones disponibles se detallan en https://cloud.google.com/firestore/docs/locations.
type

DatabaseType

Es el tipo de base de datos. Consulta https://cloud.google.com/datastore/docs/firestore-or-datastore para obtener más información sobre cómo elegir las opciones.
concurrency_mode

ConcurrencyMode

El modo de control de simultaneidad que se usará para esta base de datos.
version_retention_period

Duration

Solo salida. El período durante el cual se retienen las versiones anteriores de los datos en la base de datos.

Cualquier read o query puede especificar un read_time dentro de esta ventana y leerá el estado de la base de datos en ese momento.

Si la función de PITR está habilitada, el período de retención es de 7 días. De lo contrario, el período de retención es de 1 hora.
earliest_version_time

Timestamp

Solo salida. La marca de tiempo más antigua en la que se pueden leer versiones anteriores de los datos desde la base de datos. Consulta [version_retention_period] más arriba; este campo se propaga con now - version_retention_period.

Este valor se actualiza de forma continua y se vuelve obsoleto en el momento en que se consulta. Si usas este valor para recuperar datos, asegúrate de tener en cuenta el tiempo desde el momento en que se consulta el valor hasta el momento en que inicias la recuperación.
point_in_time_recovery_enablement

PointInTimeRecoveryEnablement

Establece si se habilita la función PITR en esta base de datos.
app_engine_integration_mode

AppEngineIntegrationMode

El modo de integración de App Engine que se usará para esta base de datos.
key_prefix

string

Solo salida. El key_prefix para esta base de datos. Este key_prefix se usa con el ID del proyecto (“~”) para crear el ID de aplicación que se muestra desde las APIs de Cloud Datastore en los entornos de ejecución de primera generación de Google App Engine.

Este valor puede estar vacío, en cuyo caso el ID de aplicación que se usará para las claves codificadas para URL es el project_id (p. ej., "foo" en lugar de "v~foo").
delete_protection_state

DeleteProtectionState

Estado de la protección contra eliminaciones de la base de datos.
cmek_config

CmekConfig

Opcional. La presencia indica que las CMEK están habilitadas para esta base de datos.
previous_id

string

Solo salida. El ID de la base de datos anterior del recurso de base de datos. Este campo solo se propaga para las bases de datos borradas.
etag

string

El servidor calcula esta suma de comprobación en función del valor de otros campos, y es posible que se envíe en solicitudes de actualización y eliminación para garantizar que el cliente tenga un valor actualizado antes de continuar.

Modo de integración de AppEngine

El tipo de modo de integración de App Engine.

Enums
APP_ENGINE_INTEGRATION_MODE_UNSPECIFIED No se usa.
ENABLED Si una aplicación de App Engine existe en la misma región que esta base de datos, la configuración de App Engine afectará esta base de datos. Esto incluye inhabilitar la aplicación y e inhabilitar operaciones de escritura en ella.
DISABLED

App Engine no tiene efecto en la capacidad de esta base de datos para entregar solicitudes.

Este es el parámetro de configuración predeterminado para las bases de datos creadas con la API de Firestore.

CmekConfig

La configuración de CMEK (clave de encriptación administrada por el cliente) para una base de datos de Firestore. Si no está presente, la base de datos se protege con la clave de encriptación predeterminada de Google.

Campos
kms_key_name

string

Obligatorio. Solo se permite usar para la encriptación las claves que se encuentren en la misma ubicación que esta base de datos.

Para la multirregión nam5 de Firestore, corresponde a la multirregión us de Cloud KMS. Para la multirregión eur3 de Firestore, esto corresponde a la europa multirregional de Cloud KMS. Consulta https://cloud.google.com/kms/docs/locations.

El formato esperado es projects/{project_id}/locations/{kms_location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}.
active_key_version[]

string

Solo salida. Versiones de claves de KMS en uso actualmente. Durante la rotación de claves, puede haber varias versiones de claves en uso.

El formato esperado es projects/{project_id}/locations/{kms_location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{key_version}.

ConcurrencyMode

Es el tipo de modo de control de simultaneidad para transacciones.

Enums
CONCURRENCY_MODE_UNSPECIFIED No se usa.
OPTIMISTIC Usa el control de simultaneidad optimista de forma predeterminada. Este modo está disponible para las bases de datos de Cloud Firestore.
PESSIMISTIC

Usa el control de simultaneidad pesimista de forma predeterminada. Este modo está disponible para las bases de datos de Cloud Firestore.

Esta es la configuración predeterminada de Cloud Firestore.
OPTIMISTIC_WITH_ENTITY_GROUPS

Usar control de simultaneidad optimista con grupos de entidades de forma predeterminada

Este es el único modo disponible para Cloud Datastore.

Este modo también está disponible para Cloud Firestore con modo Datastore, pero no se recomienda.

DatabaseType

Es el tipo de base de datos. Consulta https://cloud.google.com/datastore/docs/firestore-or-datastore para obtener más información sobre cómo elegir las opciones.

Los cambios de modo solo se permiten si la base de datos está vacía.

Enums
DATABASE_TYPE_UNSPECIFIED Es el valor predeterminado. Este valor se usa si se omite el tipo de base de datos.
FIRESTORE_NATIVE Modo nativo de Firestore
DATASTORE_MODE Firestore en modo Datastore.

DeleteProtectionState

El estado de protección contra eliminaciones de la base de datos.

Enums
DELETE_PROTECTION_STATE_UNSPECIFIED Es el valor predeterminado. No se especificó el tipo de protección de borrado
DELETE_PROTECTION_DISABLED La protección contra el borrado está inhabilitada
DELETE_PROTECTION_ENABLED La protección contra el borrado está habilitada

Habilitación de la recuperación de un momento determinado

Habilitación de la función Recuperación de un momento determinado.

Enums
POINT_IN_TIME_RECOVERY_ENABLEMENT_UNSPECIFIED No se usa.
POINT_IN_TIME_RECOVERY_ENABLED

Las lecturas son compatibles con las versiones seleccionadas de los datos de los últimos 7 días:

  • Lee comparadas con cualquier marca de tiempo en la última hora
  • Realiza lecturas en instantáneas de 1 minuto luego de una hora y en un plazo de 7 días

Se pueden usar version_retention_period y earliest_version_time para determinar las versiones compatibles.
POINT_IN_TIME_RECOVERY_DISABLED Las lecturas son compatibles con cualquier versión de los datos de la última hora.

DeleteBackupRequest

La solicitud para FirestoreAdmin.DeleteBackup.

Campos
name

string

Obligatorio. Nombre de la copia de seguridad que se borrará.

formato es projects/{project}/locations/{location}/backups/{backup}.

DeleteBackupScheduleRequest

La solicitud para [FirestoreAdmin.DeleteBackupSchedules][].

Campos
name

string

Obligatorio. El nombre de la programación de la copia de seguridad.

Formato projects/{project}/databases/{database}/backupSchedules/{backup_schedule}

DeleteDatabaseMetadata

Este tipo no tiene campos.

Metadatos relacionados con la operación de borrar base de datos.

DeleteDatabaseRequest

La solicitud para FirestoreAdmin.DeleteDatabase.

Campos
name

string

Obligatorio. Un nombre con el formato projects/{project_id}/databases/{database_id}
etag

string

La ETag actual de la base de datos. Si se proporciona una ETag y no coincide con la ETag actual de la base de datos, se bloqueará la eliminación y se mostrará un error FAILED_PRECONDITION.

DeleteIndexRequest

La solicitud para FirestoreAdmin.DeleteIndex.

Campos
name

string

Obligatorio. 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 a la que comenzó esta operación.
end_time

Timestamp

La hora a la que se completó esta operación. Se desactivará 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 de esta operación en documentos.
progress_bytes

Progress

El progreso, en bytes, de esta operación.
collection_ids[]

string

Los IDs de colección que se exportarán
output_uri_prefix

string

El lugar al que se exportan los documentos.
namespace_ids[]

string

Los IDs de espacios de nombres que se exportan.
snapshot_time

Timestamp

La marca de tiempo que corresponde a la versión de la base de datos que se está exportando. Si no se especifica, no hay garantías sobre la coherencia de los documentos que se exportan.

ExportDocumentsRequest

La solicitud para FirestoreAdmin.ExportDocuments.

Campos
name

string

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

string

Qué IDs de colección se deben exportar. Sin especificar se refiere a todas las colecciones. Cada ID de colección de esta lista debe ser único.
output_uri_prefix

string

El URI de salida. Actualmente, solo se admiten URI de Google Cloud Storage con el siguiente 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 opcional del espacio de nombres de Google Cloud Storage. Cuando elijas un nombre, asegúrate de considerar los lineamientos de 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 basado en la hora de inicio.
namespace_ids[]

string

Una lista vacía representa todos los espacios de nombres. Este es el uso preferido para las bases de datos que no usan espacios de nombres.

Un elemento de cadena vacía representa el espacio de nombres predeterminado. Se debe usar si la base de datos tiene datos en espacios de nombres no predeterminados, pero no desea incluirlos. Cada espacio de nombres de esta lista debe ser único.
snapshot_time

Timestamp

La marca de tiempo que corresponde a la versión de la base de datos que se exportará. La marca de tiempo debe ser una fecha pasada, redondeada al minuto y no anterior a earliestVersionTime. Si se especifica, los documentos exportados representarán una vista coherente de la base de datos en el momento indicado. De lo contrario, no hay garantías sobre la coherencia de los documentos exportados.

ExportDocumentsResponse

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

Campos
output_uri_prefix

string

Ubicación de los archivos de salida. Puedes usarlo para comenzar una importación a Cloud Firestore (este proyecto o cualquier otro) después de que la operación se complete correctamente.

Campo

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 que tienen el mismo ID.

Campos
name

string

Obligatorio. Un nombre de campo con el formato projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}

Una ruta de campo puede ser un nombre de campo simple, p.ej., address o una ruta de acceso a campos dentro de map_value, p.ej., address.city o una ruta de campo especial. El único campo especial válido es *, que representa cualquier campo.

Las rutas de los campos se pueden comillas 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: (Nota: En este caso, los comentarios están escritos en sintaxis de Markdown, por lo que hay una capa adicional de acentos graves para representar un bloque de código). \address.city`represents a field namedaddress.city, not the map key cityin the fieldaddress. `*`represents a field named*`, no a ningún campo.

Un Field especial contiene la configuración de indexación predeterminada para todos los campos. El nombre de 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 se revertirá 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 de índices vacía.
ttl_config

TtlConfig

La configuración del TTL para este Field. Si estableces o anulas la configuración, se habilitará o inhabilitará el TTL para los documentos que tengan este Field.

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 que especifica ancestor_field. Cuando es falso, la configuración de índices de Field se define de forma explícita.
ancestor_field

string

Solo salida. Especifica el nombre del recurso de la Field desde la que se establece la configuración de índices de este campo (cuando uses_ancestor_config es verdadero) o desde la cual se debería configurar si este campo no tiene una configuración de índice (cuando uses_ancestor_config es falso).
reverting

bool

Solo se muestra cuando el valor es verdadero, 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.

TtlConfig

La configuración de TTL (tiempo de actividad) para los documentos que tienen configurado este Field.

El almacenamiento de un valor de marca de tiempo en un campo habilitado para el TTL se tratará como el tiempo de vencimiento absoluto del documento. Los valores de marca de tiempo del pasado indican que el documento es apto para un vencimiento inmediato. Si se usa cualquier otro tipo de datos o no se especifica un campo, se inhabilitará el vencimiento del documento individual.

Campos
state

State

Solo salida. El estado de la configuración de TTL.

Estado

El estado de aplicación de la configuración de TTL a todos los documentos.

Enums
STATE_UNSPECIFIED El estado no se especifica o es desconocido.
CREATING Se está aplicando el TTL. Hay una operación activa de larga duración para hacer un seguimiento del cambio. Los documentos recién escritos tendrán TTL aplicados como se solicita. Los TTL solicitados en documentos existentes aún se están procesando. Cuando se hayan procesado los TTL de todos los documentos existentes, el estado cambiará a “ACTIVO”.
ACTIVE El TTL está activo para todos los documentos.
NEEDS_REPAIR No se pudo habilitar la configuración de TTL para todos los documentos existentes. A los documentos recién escritos se les seguirá aplicando su TTL. Falló la LRO que se mostró la última vez que se intentó habilitar el TTL para este Field. Es posible que tenga más detalles.

FieldOperationMetadata

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

Campos
start_time

Timestamp

La hora a la que comenzó esta operación.
end_time

Timestamp

La hora a la que se completó esta operación. Se desactivará 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.
progress_documents

Progress

El progreso de esta operación en documentos.
progress_bytes

Progress

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

TtlConfigDelta

Describe los deltas de la configuración del TTL.

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 modificará.

ChangeType

Especifica cómo cambia el índice.

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

TtlConfigDelta

Información sobre un cambio en la configuración de TTL.

Campos
change_type

ChangeType

Especifica cómo cambia la configuración de TTL.

ChangeType

Especifica cómo cambia la configuración del TTL.

Enums
CHANGE_TYPE_UNSPECIFIED El tipo de cambio no se especifica o no se conoce.
ADD Se está agregando la configuración del TTL.
REMOVE Se está quitando la configuración del TTL.

GetBackupRequest

La solicitud para FirestoreAdmin.GetBackup.

Campos
name

string

Obligatorio. Nombre de la copia de seguridad que se recuperará.

El formato es projects/{project}/locations/{location}/backups/{backup}.

GetBackupScheduleRequest

La solicitud para FirestoreAdmin.GetBackupSchedule.

Campos
name

string

Obligatorio. El nombre de la programación de la copia de seguridad.

Formato projects/{project}/databases/{database}/backupSchedules/{backup_schedule}

GetDatabaseRequest

La solicitud para FirestoreAdmin.GetDatabase.

Campos
name

string

Obligatorio. Un nombre con el formato projects/{project_id}/databases/{database_id}

GetFieldRequest

La solicitud para FirestoreAdmin.GetField.

Campos
name

string

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

Obligatorio. 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 a la que comenzó esta operación.
end_time

Timestamp

La hora a la que se completó esta operación. Se desactivará 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 de esta operación en documentos.
progress_bytes

Progress

El progreso, en bytes, de esta operación.
collection_ids[]

string

Los IDs de colección que se importarán.
input_uri_prefix

string

La ubicación de los documentos que se importan.
namespace_ids[]

string

Los IDs de espacios de nombres que se importarán.

ImportDocumentsRequest

La solicitud para FirestoreAdmin.ImportDocuments.

Campos
name

string

Obligatorio. Base de datos a la cual importar. Debe tener el formato projects/{project_id}/databases/{database_id}.
collection_ids[]

string

Qué IDs de colección se importarán. Sin especificar se refiere a todas las colecciones incluidas en la importación.
input_uri_prefix

string

Ubicación de los archivos exportados. Debe coincidir con el output_uri_prefix de una ExportDocumentsResponse de una exportación que se completó correctamente. Consulta: google.firestore.admin.v1.ExportDocumentsResponse.output_uri_prefix.
namespace_ids[]

string

Una lista vacía representa todos los espacios de nombres. Este es el uso preferido para las bases de datos que no usan espacios de nombres.

Un elemento de cadena vacía representa el espacio de nombres predeterminado. Se debe usar si la base de datos tiene datos en espacios de nombres no predeterminados, pero no desea incluirlos. Cada espacio de nombres de esta lista debe ser único.

Índice

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

Campos
name

string

Solo salida. Un nombre definido por el servidor para este índice. El formato de este nombre para los índices compuestos será el 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 la secundaria de un documento específico, que se especificó en el momento de la consulta y que 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 especifica en el momento de la consulta y que tienen el mismo ID de colección que este índice.
api_scope

ApiScope

El alcance de la API que admite este índice.
fields[]

IndexField

Los campos que admite este índice.

En el caso de los índices compuestos, se requiere un mínimo de 2 y un máximo de 100 campos. La última entrada de campo siempre es para la ruta de 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 último campo de un índice compuesto no es direccional, __name__ se ordenará ASCENDING (a menos que se especifique de forma explícita).

Para los índices de campo único, siempre será exactamente una entrada con una ruta de campo igual a la ruta de campo del campo asociado.
state

State

Solo salida. El estado de entrega del índice.

ApiScope

El permiso de la API define las APIs (nativas de Firestore o Firestore en modo Datastore) que se admiten para las consultas.

Enums
ANY_API Solo la API de consulta nativa de Firestore puede usar el índice. Esta es la opción predeterminada.
DATASTORE_MODE_API Solo la API de consulta de Firestore en modo Datastore puede usar el índice.

CampoÍndice

Es 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. Para los índices de campo único, debe coincidir con el nombre del campo o se puede omitir.
Campo de unión value_mode. Cómo se indexa el valor del campo. value_mode puede ser solo uno de los siguientes:
order

Order

Indica que este campo admite el ordenamiento según el orden especificado o la comparación con =, !=, <, <=, > y >=.
array_config

ArrayConfig

Indica que este campo admite operaciones en array_value.
vector_config

VectorConfig

Indica que este campo admite operaciones de vecino más cercano y distancia en el vector.

ArrayConfig

Son las configuraciones compatibles de los valores de array.

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

Pedido

Son los órdenes compatibles.

Enums
ORDER_UNSPECIFIED El orden no está especificado. No es una opción válida.
ASCENDING El campo se ordena por valor de campo ascendente.
DESCENDING El campo se ordena de forma descendente según el valor del campo.

VectorConfig

La configuración de índices para admitir operaciones de búsqueda de vectores

Campos
dimension

int32

Obligatorio. Es la dimensión vectorial a la que se aplica esta configuración.

El índice resultante solo incluirá vectores de esta dimensión y se podrá usar para la búsqueda de vectores con la misma dimensión.
Campo de unión type. El tipo de índice usado. type puede ser solo uno de los siguientes:
flat

FlatIndex

Indica que el índice vectorial es plano.

FlatIndex

Este tipo no tiene campos.

Es un índice que almacena vectores en una estructura de datos plana y admite búsquedas exhaustivas.

QueryScope

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

Enums
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 colección especificado permiten realizar consultas en una colección que es la secundaria de un documento específico, especificada 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 tengan el ID de colección especificado por el índice.
COLLECTION_RECURSIVE Incluir todas las colecciones principales en el índice Solo está disponible para las bases de datos en modo Datastore.

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

Enums
STATE_UNSPECIFIED El estado no se especifica.
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 completa 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 falló la operación de larga duración que finalizó más recientemente. 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 última operación que intentó crear este índice y, luego, vuelve a crearlo.

IndexOperationMetadata

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

Campos
start_time

Timestamp

La hora a la que comenzó esta operación.
end_time

Timestamp

La hora a la que se completó esta operación. Se desactivará 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 de esta operación en documentos.
progress_bytes

Progress

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

Solicitud de ListBackupSchedules

La solicitud para FirestoreAdmin.ListBackupSchedules.

Campos
parent

string

Obligatorio. La base de datos superior.

El formato es projects/{project}/databases/{database}.

ListBackupSchedulesResponse

La respuesta para FirestoreAdmin.ListBackupSchedules.

Campos
backup_schedules[]

BackupSchedule

Lista de todas las programaciones de copias de seguridad.

ListBackupsRequest

La solicitud para FirestoreAdmin.ListBackups.

Campos
parent

string

Obligatorio. La ubicación desde la que se enumeran las copias de seguridad.

El formato es projects/{project}/locations/{location}. Usa {location} = '-' para enumerar las copias de seguridad de todas las ubicaciones de un proyecto determinado. Esto permite enumerar las copias de seguridad de una sola ubicación o de todas las ubicaciones.

ListBackupsResponse

La respuesta para FirestoreAdmin.ListBackups.

Campos
backups[]

Backup

Lista de todas las copias de seguridad del proyecto.
unreachable[]

string

Lista de ubicaciones desde las que no se pudieron recuperar las copias de seguridad existentes.

En lugar de fallar todas las solicitudes cuando no se puede acceder a una sola ubicación, esta respuesta muestra un conjunto de resultados parciales y una lista de ubicaciones a las que no se puede acceder aquí. Se puede reintentar la solicitud en una sola ubicación para obtener un error concreto.

ListDatabasesRequest

Una solicitud para enumerar las bases de datos de Firestore en todas las ubicaciones de un proyecto.

Campos
parent

string

Obligatorio. Un nombre superior con el formato projects/{project_id}
show_deleted

bool

Si es verdadero, también muestra los recursos borrados.

ListDatabasesResponse

Es la lista de bases de datos para un proyecto.

Campos
databases[]

Database

Las bases de datos del proyecto.
unreachable[]

string

En caso de que no se puedan enumerar datos sobre bases de datos individuales, se registrarán aquí.

Una entrada de ejemplo podría ser: projects/some_project/locations/some_location. Esto puede suceder si la región de Cloud en la que se encuentra la base de datos no está disponible en este momento. En este caso, no podemos recuperar todos los detalles de la base de datos. Podrás recibir un mensaje de error más detallado (o recuperar el recurso) si envías el error “Get” del recurso o una “Lista” para la ubicación específica.

Solicitud ListFields

La solicitud para FirestoreAdmin.ListFields.

Campos
parent

string

Obligatorio. 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 un filtro que incluya indexConfig.usesAncestorConfig:false o ttlConfig:*.
page_size

int32

La cantidad de resultados que se mostrarán.
page_token

string

Un token de página, que se muestra de 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 se deja en blanco, se trata de la última página.

ListIndexesRequest

La solicitud para FirestoreAdmin.ListIndexes.

Campos
parent

string

Obligatorio. 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 de 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 se deja en blanco, se trata de la última página.

LocationMetadata

Este tipo no tiene campos.

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

OperationState

Describe el estado de la operación.

Enums
OPERATION_STATE_UNSPECIFIED Sin especificar.
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 su etapa de finalización.
SUCCESSFUL La solicitud se completó correctamente.
FAILED Se terminó de procesar la solicitud, 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 debe interpretarse según el lugar donde se usa Progress.

Campos
estimated_work

int64

La cantidad de trabajo estimada.
completed_work

int64

La cantidad de trabajo completado.

RestoreDatabaseMetadata

Metadatos de long-running operation de la solicitud [RestoreDatabase][google.firestore.admin.v1.RestoreDatabase].

Campos
start_time

Timestamp

La hora a la que se inició el restablecimiento.
end_time

Timestamp

Es la hora en la que finalizó el restablecimiento, sin establecer para los restablecimientos en curso.
operation_state

OperationState

El estado de operación del restablecimiento.
database

string

El nombre de la base de datos en la que se restablecerá.
backup

string

El nombre de la copia de seguridad desde la que se restablece.
progress_percentage

Progress

La duración del restablecimiento como un porcentaje estimado del tiempo restante.

RestoreDatabaseRequest

El mensaje de solicitud para [FirestoreAdmin.RestoreDatabase][google.firestore.admin.v1.RestoreDatabase].

Campos
parent

string

Obligatorio. El proyecto en el que se restablecerá la base de datos. El formato es projects/{project_id}.
database_id

string

Obligatorio. Es el ID que se usará para la base de datos, que se convertirá en el componente final del nombre del recurso de la base de datos. Este ID de la base de datos no debe estar asociado a una base de datos existente.

Este valor debe tener entre 4 y 63 caracteres. Los caracteres válidos son /[a-z][0-9]-/, donde el primer carácter es una letra y, el último, una letra o un número. No debe ser similar a un UUID /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/.

“(predeterminado)” el ID de la base de datos también es válido.

Campo de unión source.

source puede ser una de las siguientes opciones:
backup

string

Copia de seguridad desde la que se realizará restablecimiento. Debe ser del mismo proyecto que el elemento superior.

Formato: projects/{project_id}/locations/{location}/backups/{backup}

UpdateBackupScheduleRequest

La solicitud para FirestoreAdmin.UpdateBackupSchedule.

Campos
backup_schedule

BackupSchedule

Obligatorio. El programa de copia de seguridad que se actualizará.
update_mask

FieldMask

La lista de campos que se actualizarán.

UpdateDatabaseMetadata

Este tipo no tiene campos.

Metadatos relacionados con la operación de actualización de bases de datos.

UpdateDatabaseRequest

La solicitud para FirestoreAdmin.UpdateDatabase.

Campos
database

Database

Obligatorio. La base de datos que se actualizará.
update_mask

FieldMask

La lista de campos que se actualizarán.

Solicitudes de Actualización Campo

La solicitud para FirestoreAdmin.UpdateField.

Campos
field

Field

Obligatorio. El campo que se actualizará.
update_mask

FieldMask

Una máscara, relativa al campo. Si se especifica, solo se actualizará en el campo la configuración que especifique este field_mask.

Recurrencia semanal

Representa una programación recurrente que se ejecuta en un día específico de la semana.

La zona horaria es UTC.

Campos
day

DayOfWeek

Es el día de la semana que se ejecutará.

No se permite el evento DAY_OF_WEEK_UNSPECIFIED.