Recurso: 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 con el mismo ID.
Representación JSON |
---|
{ "name": string, "indexConfig": { object ( |
Campos | |
---|---|
name |
Obligatorio. Un nombre de campo con el formato La ruta de un campo puede ser un nombre simple de campo, p.ej., Las rutas de los campos se pueden usar con Ejemplos: Una |
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 |
ttlConfig |
La configuración de TTL para este |
IndexConfig
La configuración de índices para este campo.
Representación JSON |
---|
{
"indexes": [
{
object ( |
Campos | |
---|---|
indexes[] |
Los índices admitidos para este campo. |
usesAncestorConfig |
Solo salida. Cuando es verdadero, la configuración del índice de |
ancestorField |
Solo salida. Especifica el nombre de recurso del |
reverting |
Salida solo cuando es verdadera, la configuración del índice de |
TtlConfig
La configuración de TTL (tiempo de actividad) para los documentos que tienen establecido este Field
.
Si se almacena un valor de marca de tiempo en un campo habilitado para el TTL, se tratará como la hora de vencimiento absoluta del documento. Los valores de marca de tiempo en el pasado indican que el documento es apto para el vencimiento inmediato. Si usas cualquier otro tipo de datos o no dejas el campo ausente, se inhabilitará el vencimiento de un documento individual.
Representación JSON |
---|
{
"state": enum ( |
Campos | |
---|---|
state |
Solo salida. El estado de la configuración del TTL. |
Estado
El estado en el que se aplica la configuración de TTL a todos los documentos.
Enumeradores | |
---|---|
STATE_UNSPECIFIED |
El estado no está especificado o es desconocido. |
CREATING |
Se está aplicando el TTL. Hay una operación activa de larga duración para hacer un seguimiento del cambio. A los documentos recién escritos se les aplicarán los TTL según se solicite. Los TTL solicitados en los documentos existentes aún se están procesando. Cuando se hayan procesado los TTL de todos los documentos existentes, el estado cambiará a “ACTIVE”. |
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. Se seguirá aplicando el TTL de los documentos recién escritos. No se pudo mostrar la LRO cuando se intentó habilitar el TTL por última vez para este Field y es posible que tenga más detalles. |
Métodos |
|
---|---|
|
Obtiene los metadatos y la configuración de un campo. |
|
Enumera la configuración del campo y los metadatos para esta base de datos. |
|
Actualiza la configuración de un campo. |