REST Resource: projects.databases.collectionGroups.fields

Recurso: Campo

Representa un único campo en la base de datos.

Los campos están agrupados por su "Grupo de colecciones", que representa todas las colecciones de la base de datos con la misma identificación.

Representación JSON
{
  "name": string,
  "indexConfig": {
    object (IndexConfig)
  },
  "ttlConfig": {
    object (TtlConfig)
  }
}
Campos
name

string

Requerido. Un nombre de campo del formulario projects/{projectId}/databases/{databaseId}/collectionGroups/{collectionId}/fields/{fieldPath}

Una ruta de campo puede ser un nombre de campo simple, por ejemplo, address o una ruta a campos dentro de mapValue, 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/{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 índice Field .

indexConfig

object ( 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 ancestorField . Para eliminar explícitamente todos los índices de este campo, especifique una configuración de índice con una lista vacía de índices.

ttlConfig

object ( TtlConfig )

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

Configuración de índice

La configuración del índice 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

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

ancestorField

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 usesAncestorConfig es verdadero), o desde el cual se establecería si este campo no tuviera configuración de índice (cuando usesAncestorConfig es falso).

reverting

boolean

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

TtlConfig

La configuración TTL (tiempo de vida) para documentos que tienen este Field establecido.

El almacenamiento de un valor de marca de tiempo en un campo habilitado para TTL se tratará como el tiempo de vencimiento absoluto del documento. Los valores de marca de tiempo en el pasado indican que el documento es elegible para vencimiento inmediato. Usar cualquier otro tipo de datos o dejar el campo ausente deshabilitará la caducidad del documento individual.

Representación JSON
{
  "state": enum (State)
}
Campos
state

enum ( State )

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

Estado

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

Enumeraciones
STATE_UNSPECIFIED El estado no se especifica o se desconoce.
CREATING Se está aplicando el TTL. Hay una operación activa de larga duración para rastrear el cambio. A los documentos recién escritos se les aplicarán TTL según lo solicitado. Los TTL solicitados sobre documentos existentes aún se están procesando. Cuando se hayan procesado los TTL de todos los documentos existentes, el estado pasará a 'ACTIVO'.
ACTIVE El TTL está activo para todos los documentos.
NEEDS_REPAIR La configuración TTL no se pudo habilitar para todos los documentos existentes. A los documentos recién escritos se les seguirá aplicando su TTL. El LRO devuelto la última vez que se intentó habilitar TTL para este Field falló 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 de campo y los metadatos de esta base de datos.

patch

 Actualiza una configuración de campo.