Package google.firestore.admin.v1

string

Sólo salida. El nombre de recurso único de la copia de seguridad.

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

string

Sólo salida. Nombre de la base de datos de Firestore de donde proviene la copia de seguridad.

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

string

Sólo salida. El UUID4 generado por el sistema para la base de datos de Firestore de donde proviene la copia de seguridad.

Timestamp

Sólo salida. La copia de seguridad contiene una copia externa consistente de la base de datos en este momento.

Timestamp

Sólo salida. La marca de tiempo en la que caduca esta copia de seguridad.

State

Sólo salida. El estado actual de la copia de seguridad.

string

Sólo salida. El identificador único de programación de copias de seguridad en todas las ubicaciones y bases de datos del proyecto determinado.

Esto se asignará automáticamente.

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

Timestamp

Sólo salida. La marca de tiempo en la que se creó este programa de copia de seguridad y entró en vigor desde entonces.

No se crearán copias de seguridad para este programa antes de esta hora.

Timestamp

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

Duration

¿En qué momento relativo en el futuro, en comparación con el momento de su creación, se debe eliminar la copia de seguridad, por ejemplo, conservar las copias de seguridad durante 7 días?

DailyRecurrence

Para una programación que se ejecuta diariamente a una hora específica.

WeeklyRecurrence

Para una programación que se ejecuta semanalmente en un día y hora específicos.

string

Requerido. La base de datos principal.

Dar formato projects/{project}/databases/{database}

BackupSchedule

Requerido. El cronograma de respaldo a crear.

string

Requerido. Un nombre principal del formulario projects/{project_id}

Database

Requerido. La base de datos a crear.

string

Requerido. El ID que se utilizará 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 /[az][0-9]-/ siendo el primer carácter 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}/.

La identificación de la base de datos "(predeterminada)" también es válida.

string

Requerido. Un nombre principal del formulario projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}

Index

Requerido. El índice compuesto que se va a crear.

string

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

string

Sólo salida. El UUID4 generado por el sistema para esta base de datos.

Timestamp

Sólo salida. La marca de tiempo en la que se creó esta base de datos. Las bases de datos creadas antes de 2016 no completan create_time.

Timestamp

Sólo salida. La marca de tiempo en la que se actualizó esta base de datos por última vez. Tenga en cuenta que esto solo incluye actualizaciones del recurso de la base de datos y no los datos contenidos en la base de datos.

string

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

DatabaseType

El tipo de base de datos. Consulte https://cloud.google.com/datastore/docs/firestore-or-datastore para obtener información sobre cómo elegir.

ConcurrencyMode

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

Duration

Sólo salida. El período durante el cual se conservan en la base de datos las versiones anteriores de los 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 PITR está habilitada, el período de retención es de 7 días. En caso contrario, el periodo de retención es de 1 hora.

Timestamp

Sólo salida. La marca de tiempo más temprana en la que se pueden leer versiones anteriores de los datos de la base de datos. Consulte [version_retention_period] arriba; este campo se completa con now - version_retention_period .

Este valor se actualiza continuamente y queda obsoleto en el momento en que se consulta. Si está utilizando este valor para recuperar datos, asegúrese de tener en cuenta el tiempo desde el momento en que se consulta el valor hasta el momento en que inicia la recuperación.

PointInTimeRecoveryEnablement

Si se debe habilitar la función PITR en esta base de datos.

AppEngineIntegrationMode

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

string

Sólo salida. El prefijo_clave para esta base de datos. Este prefijo_clave se utiliza en combinación con la identificación del proyecto (" ~ ") para construir la identificación de la aplicación que se devuelve desde las API de Cloud Datastore en los tiempos de ejecución de primera generación de Google App Engine.

Este valor puede estar vacío, en cuyo caso el appid que se utilizará para las claves codificadas en URL es project_id (por ejemplo: foo en lugar de v~foo).

DeleteProtectionState

Estado de protección contra eliminación de la base de datos.

string

El servidor calcula esta suma de verificación en función del valor de otros campos y puede enviarse en solicitudes de actualización y eliminación para garantizar que el cliente tenga un valor actualizado antes de continuar.

string

Requerido. Nombre de la copia de seguridad a eliminar.

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

string

Requerido. El nombre del programa de copia de seguridad.

Dar formato projects/{project}/databases/{database}/backupSchedules/{backup_schedule}

string

Requerido. Un nombre del formulario projects/{project_id}/databases/{database_id}

string

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

string

Requerido. Un nombre del formulario projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}

Timestamp

La hora en que comenzó esta operación.

Timestamp

La hora a la que se completó esta operación. Se desarmará si la operación aún está en progreso.

OperationState

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

Progress

Los avances, en documentos, de esta operación.

Progress

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

string

Qué identificadores de colección se están exportando.

string

Dónde se exportan los documentos.

string

Qué identificadores de espacios de nombres se están exportando.

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.

string

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

string

Qué ID de colección exportar. Sin especificar significa todas las colecciones.

string

El URI de salida. Actualmente solo admite URI de Google Cloud Storage del formato: gs://BUCKET_NAME[/NAMESPACE_PATH] , donde BUCKET_NAME es el nombre del depósito de Google Cloud Storage y NAMESPACE_PATH es una ruta de espacio de nombres opcional de Google Cloud Storage. Al elegir un nombre, asegúrese de considerar las pautas de nomenclatura de Google Cloud Storage: https://cloud.google.com/storage/docs/naming . Si el URI es un depósito (sin una ruta de espacio de nombres), se generará un prefijo según la hora de inicio.

string

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

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

Timestamp

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

string

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

string

Requerido. Un nombre de campo del formulario projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}

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

Las rutas de campo se pueden citar 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 cualquier carácter simbólico ascii.

Ejemplos: (Nota: los comentarios aquí están escritos en sintaxis de rebajas, por lo que hay una capa adicional de comillas invertidas para representar un bloque de código) \ dirección.ciudad` represents a field named dirección.ciudad , not the map key in the field dirección . `*` represents a field named *`, no cualquier campo.

Un 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 índice de Field .

IndexConfig

La configuración del índice para este campo. Si no se establece, la indexación de campos volverá a la configuración definida por el ancestor_field . Para eliminar explícitamente todos los índices de este campo, especifique una configuración de índice con una lista vacía de índices.

TtlConfig

La configuración TTL para este Field . Configurar o desarmar esto habilitará o deshabilitará el TTL para los documentos que tengan este Field .

Index

Los índices admitidos para este campo.

bool

Sólo salida. Cuando es verdadero, la configuración del índice del Field se establece a partir de la configuración especificada por el ancestor_field . Cuando es falso, la configuración del índice del Field se define explícitamente.

string

Sólo salida. Especifica el nombre del recurso del Field desde el cual se establece la configuración de índice de este campo (cuando uses_ancestor_config es verdadero), o desde el cual se establecería si este campo no tuviera configuración de índice (cuando uses_ancestor_config es falso).

bool

Solo salida Cuando es verdadero, la configuración del índice del Field está en proceso de revertirse. Una vez completada, la configuración del í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 .

State

Sólo salida. El estado de la configuración TTL.

Timestamp

La hora en que comenzó esta operación.

Timestamp

La hora a la que se completó esta operación. Se desarmará si la operación aún está en progreso.

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}

IndexConfigDelta

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

OperationState

El estado de la operación.

Progress

Los avances, en documentos, de esta operación.

Progress

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

TtlConfigDelta

Describe los deltas de la configuración TTL.

ChangeType

Especifica cómo está cambiando el índice.

Index

El índice está siendo cambiado.

ChangeType

Especifica cómo está cambiando la configuración TTL.

string

Requerido. Nombre de la copia de seguridad a recuperar.

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

string

Requerido. El nombre del programa de copia de seguridad.

Dar formato projects/{project}/databases/{database}/backupSchedules/{backup_schedule}

string

Requerido. Un nombre del formulario projects/{project_id}/databases/{database_id}

string

Requerido. Un nombre del formulario projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_id}

string

Requerido. Un nombre del formulario projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}

Timestamp

La hora en que comenzó esta operación.

Timestamp

La hora a la que se completó esta operación. Se desarmará si la operación aún está en progreso.

OperationState

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

Progress

Los avances, en documentos, de esta operación.

Progress

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

string

Qué identificadores de colección se están importando.

string

La ubicación de los documentos que se importan.

string

Qué identificadores de espacios de nombres se están importando.

string

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

string

Qué ID de colección importar. Sin especificar significa todas las colecciones incluidas en la importación.

string

Ubicación de los archivos exportados. Esto debe coincidir con el prefijo_uri_salida de una ExportDocumentsResponse de una exportación que se haya completado correctamente. Consulte: google.firestore.admin.v1.ExportDocumentsResponse.output_uri_prefix .

string

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

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

string

Sólo salida. Un nombre definido por el servidor para este índice. La forma de este nombre para índices compuestos será: projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{composite_index_id} Para índices de campo único, este campo estará vacío.

QueryScope

Los índices con un alcance de consulta de colección especificado permiten consultas en una colección que es hija de un documento específico, especificada 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 colección especificado permiten consultas en todas las colecciones que descienden de un documento específico, especificadas en el momento de la consulta y que tienen la misma identificación de colección que este índice.

ApiScope

El alcance de la API admitido por este índice.

IndexField

Los campos soportados por este índice.

Para índices compuestos, esto requiere un mínimo de 2 y un máximo de 100 campos. La última entrada de campo es siempre para la ruta del campo __name__ . Si en el momento de la creación no se especificó __name__ como último campo, se agregará 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 (a menos que se especifique explícitamente).

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

State

Sólo salida. El estado de publicación del índice.

string

Puede ser nombre . Para índices de campo único, esto debe coincidir con el nombre del campo o puede omitirse.

Order

Indica que este campo admite ordenar según el orden especificado o comparar usando =, !=, <, <=, >, >=.

ArrayConfig

Indica que este campo admite operaciones en array_value s.

Timestamp

La hora en que comenzó esta operación.

Timestamp

La hora a la que se completó esta operación. Se desarmará si la operación aún está en progreso.

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}

OperationState

El estado de la operación.

Progress

Los avances, en documentos, de esta operación.

Progress

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

string

Requerido. La base de datos principal.

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

BackupSchedule

Lista de todos los programas de respaldo.

string

Requerido. La ubicación desde la que enumerar las copias de seguridad.

El formato es projects/{project}/locations/{location} . Utilice {location} = '-' para enumerar las copias de seguridad de todas las ubicaciones para el proyecto determinado. Esto permite enumerar copias de seguridad desde una única ubicación o desde todas las ubicaciones.

Backup

Lista de todas las copias de seguridad del proyecto.

string

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

En lugar de fallar en todas las solicitudes cuando no se puede acceder a una única ubicación, esta respuesta devuelve un conjunto de resultados parcial y una lista de ubicaciones a las que no se puede acceder aquí. La solicitud se puede volver a intentar en una única ubicación para obtener un error concreto.

string

Requerido. Un nombre principal del formulario projects/{project_id}

Database

Las bases de datos del proyecto.

string

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

Una entrada de ejemplo podría ser: proyectos/algún_proyecto/ubicaciones/alguna_ubicación. Esto puede suceder si la región de la nube en la que reside la base de datos no está disponible actualmente. En este caso no podemos recuperar todos los detalles sobre la base de datos. Es posible que pueda obtener un mensaje de error más detallado (o posiblemente recuperar el recurso) enviando una solicitud 'Obtener' para el recurso o una solicitud 'Lista' para la ubicación específica.

string

Requerido. Un nombre principal del formulario projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}

string

El filtro que se aplicará a los resultados de la lista. Actualmente, FirestoreAdmin.ListFields solo admite campos de listado que se han anulado explícitamente. Para emitir esta consulta, llame a FirestoreAdmin.ListFields con un filtro que incluya indexConfig.usesAncestorConfig:false .

int32

El número de resultados que se devolverán.

string

Un token de página, devuelto por una llamada anterior a FirestoreAdmin.ListFields , que puede usarse para obtener la siguiente página de resultados.

Field

Los campos solicitados.

string

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

string

Requerido. Un nombre principal de los projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}

string

El filtro se aplicará a los resultados de la lista.

int32

El número de resultados que se devolverán.

string

Un token de página, devuelto de una llamada anterior a FirestoreAdmin.ListIndexes , que puede usarse para obtener la página siguiente de resultados.

Index

Los índices solicitados.

string

Un token de página que puede usarse para solicitar otra página de resultados. Si está en blanco, esta es la última página.

int64

La cantidad de trabajo estimada.

int64

La cantidad de trabajo completada.

Timestamp

La hora en que se inició la restauración.

Timestamp

La hora en que terminó la restauración, no es establecida para las restauraciones continuas.

OperationState

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

string

El nombre de la base de datos que se restaura.

string

El nombre de la restauración de la copia de seguridad desde.

Progress

Qué tan avanzada a lo largo de la restauración es como un porcentaje estimado de tiempo restante.

string

Requerido. El proyecto para restaurar la base de datos en. Formato es projects/{project_id} .

string

Requerido. La ID para usar para la base de datos, que se convertirá en el componente final del nombre de recursos de la base de datos. Esta ID de base de datos no debe estar asociada con una base de datos existente.

Este valor debe ser de 4-63 caracteres. Los caracteres válidos son / [AZ] [0-9]- / Con el primer carácter una letra y la última letra o un número. No debe ser UUID-Like /[0-9a-f] {8} (-[0-9a-f] {4}) {3}-[0-9a-f] {12} /.

La identificación de la base de datos "(predeterminada)" también es válida.

string

Copia de seguridad para restaurar. Debe ser del mismo proyecto que el padre.

El formato es: projects/{project_id}/locations/{location}/backups/{backup}

BackupSchedule

Requerido. El horario de copia de seguridad para actualizar.

FieldMask

La lista de campos a actualizar.

Database

Requerido. La base de datos para actualizar.

FieldMask

La lista de campos a actualizar.

Field

Requerido. El campo a actualizar.

FieldMask

Una máscara, en relación con el campo. Si se especifica, solo la configuración especificada por este Field_MASK se actualizará en el campo.

DayOfWeek

El día de la semana para correr.

Day_of_week_unSpecified no está permitido.