REST Resource: projects.databases.collectionGroups.fields

Recurso: campo

Representa um único campo no banco de dados.

Os campos são agrupados por "Grupo de coleções", que representa todas as coleções no banco de dados com o mesmo ID.

Representação JSON 
{
  "name": string,
  "indexConfig": {
    object (IndexConfig)
  }
}
Campos
name

string

Um nome de campo do formulário projects/{projectId}/databases/{databaseId}/collectionGroups/{collectionId}/fields/{fieldPath}

Um caminho de campo pode ser um nome de campo simples, por exemplo, address ou um caminho para campos em mapValue, por exemplo, address.city ou um caminho de campo especial. O único campo especial válido é *, que representa qualquer campo.

Os caminhos de campo podem ser citados 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),[,]`, além de caracteres simbólicos ASCII.

Exemplos: os comentários aqui são escritos na sintaxe de markdown, portanto há uma camada adicional de crases para representar um bloco de código. \address.city`represents a field namedaddress.city, not the map key cityin the fieldaddress. `*`represents a field named*`, nenhum campo.

Um Field especial contém as configurações de indexação padrão para todos os campos. O nome do recurso deste campo é: projects/{projectId}/databases/{databaseId}/collectionGroups/__default__/fields/* Os índices definidos neste Field serão aplicados a todos os campos que não tiverem sua própria configuração de índice Field.
indexConfig

object (IndexConfig)

A configuração de índice deste campo. Se não for definida, a indexação de campo será revertida para a configuração definida por ancestorField. Para remover explicitamente todos os índices deste campo, especifique uma configuração de índice com uma lista vazia de índices.

IndexConfig

A configuração de índice deste campo.

Representação JSON 
{
  "indexes": [
    {
      object (Index)
    }
  ],
  "usesAncestorConfig": boolean,
  "ancestorField": string,
  "reverting": boolean
}
Campos
indexes[]

object (Index)

Os índices compatíveis com este campo.
usesAncestorConfig

boolean

Apenas saída. Quando verdadeiro, a configuração de índice de Field é definida com base na configuração especificada por ancestorField. Quando falso, a configuração de índice de Field é definida explicitamente.
ancestorField

string

Apenas saída. Especifica o nome do recurso do Field em que a configuração de índice desse campo é definida (quando usesAncestorConfig é verdadeiro) ou do qual seria definida se o campo não tivesse configuração de índice (quando usesAncestorConfig é falso).
reverting

boolean

Somente saída. Quando verdadeiro, a configuração do índice de Field está em processo de reversão. Após a conclusão, a configuração do índice vai passar para o mesmo estado do campo especificado por ancestorField. A partir de então, usesAncestorConfig será true, e reverting será false.

Métodos

get

 Recebe os metadados e a configuração de um campo.

list

 Lista a configuração de campo e os metadados para este banco de dados.

patch

 Atualiza uma configuração de campo.