Se usó la API de Cloud Translation para traducir esta página.
Switch to English

Recurso REST: projects.databases.collectionGroups.fields

Recurso: campo

Representa un solo campo en la base de datos.

Los campos se agrupan por su "Grupo de colecciones", que representan todas las colecciones en la base de datos con la misma identificación.

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

string

Un nombre de campo del formulario projects/{project_id}/databases/{database_id}/collectionGroups/{collectionId}/fields/{fieldPath}

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

Las rutas de campo se pueden citar utilizando (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í se escriben en sintaxis de reducción, por lo que hay una capa adicional de backticks para representar un bloque de código) \ address.city` represents a field named address.city , not the map key ciudad , not the map key in the field dirección del in the field . `*` represents a field named * `, no cualquier 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/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/* índices definidos en este Field se aplicarán a todos los campos que no tienen su propia configuración de índice de Field .

indexConfig

object ( IndexConfig )

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

IndexConfig

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 soportados para este campo.

usesAncestorConfig

boolean

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

ancestorField

string

Solo salida. Especifica el nombre del recurso del Field desde el cual se establece la configuración de índices de este campo (cuando usesAncestorConfig es cierto), o de la que sería establecer si este campo no tenía ninguna configuración del índice (cuando usesAncestorConfig es falsa).

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 la reverting será false .

Métodos

get

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

list

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

patch

Actualiza una configuración de campo.