REST Resource: projects.databases.collectionGroups.fields

Recurso: Campo

Representa um único campo no banco de dados.

Os campos são agrupados pelo seu “Grupo de Coleções”, que representa todas as coleções do 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 dentro de mapValue, por exemplo, address.city , ou um caminho de campo especial. O único campo especial válido é * , que representa qualquer campo.

Os caminhos dos campos 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), [ , ]`, bem como quaisquer caracteres simbólicos ascii.

Exemplos: (Observação: os comentários aqui são escritos em sintaxe de marcação, portanto, há uma camada adicional de crases para representar um bloco de código) \ address.city` represents a field named address.city , not the map key city in the field address . `*` represents a field named *`, não qualquer 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 possuem sua própria configuração de índice Field .

indexConfig

object ( IndexConfig )

A configuração do índice para este campo. Se não for definido, a indexação do campo reverterá para a configuração definida pelo 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 do índice para este campo.

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

object ( Index )

Os índices suportados para este campo.

usesAncestorConfig

boolean

Somente saída. Quando verdadeiro, a configuração do índice do Field é definida a partir da configuração especificada pelo ancestorField . Quando falso, a configuração do índice do Field é definida explicitamente.

ancestorField

string

Somente saída. Especifica o nome do recurso do Field a partir do qual a configuração de índice deste campo é definida (quando usesAncestorConfig for verdadeiro) ou a partir do qual seria definido se este campo não tivesse configuração de índice (quando usesAncestorConfig for falso).

reverting

boolean

Somente saída Quando verdadeiro, a configuração do índice do Field está em processo de reversão. Depois de concluído, a configuração do índice fará a transição para o mesmo estado do campo especificado por ancestorField , ponto em que usesAncestorConfig será true e reverting será false .

Métodos

get

 Obtém os metadados e a configuração de um campo.

list

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

patch

 Atualiza uma configuração de campo.