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 que tienen 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}

Una ruta de campo puede ser un nombre de campo simple, p.ej., address o una ruta de acceso a campos dentro de mapValue, 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/{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 se revertirá 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 de índices vacía.

ttlConfig

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

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

ancestorField

string

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

reverting

boolean

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

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

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

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.