REST Resource: projects.databases.collectionGroups.fields

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 (IndexConfig)
  },
  "ttlConfig": {
    object (TtlConfig)
  }
}
Campos
name

string

Obligatorio. Un nombre de campo con el formato projects/{projectId}/databases/{databaseId}/collectionGroups/{collectionId}/fields/{fieldPath}

La ruta de un campo puede ser un nombre simple de campo, p.ej., address, o una ruta de acceso a campos dentro de mapValue, p.ej., address.city, o una ruta de acceso de un 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/{projectId}/databases/{databaseId}/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.
indexConfig

object (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 ancestorField. 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.
ttlConfig

object (TtlConfig)

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

IndexConfig

La configuración de índices para este campo.

Representación JSON 
{
  "indexes": [
    {
      object (Index)
    }
  ],
  "usesAncestorConfig": boolean,
  "ancestorField": string,
  "reverting": boolean
}
Campos
indexes[]

object (Index)

Los índices admitidos para este campo.
usesAncestorConfig

boolean

Solo salida. Cuando es verdadero, la configuración del índice de Field se establece a partir de la configuración especificada por ancestorField. Cuando es falsa, la configuración de índices de Field se define de forma explícita.
ancestorField

string

Solo salida. Especifica el nombre de recurso del Field desde el que se establece la configuración de índices de este campo (cuando usesAncestorConfig es verdadero), o desde el cual se sería establecer si este campo no tuviera configuración de índices (cuando usesAncestorConfig es falso).
reverting

boolean

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 ancestorField, momento en el cual usesAncestorConfig será true y reverting será false.

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 (State)
}
Campos
state

enum (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

get

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

list

 Enumera la configuración del campo y los metadatos para esta base de datos.

patch

 Actualiza la configuración de un campo.