REST Resource: projects.databases.collectionGroups.fields

{
  "name": string,
  "indexConfig": {
    object (IndexConfig)
  }
}

string

Um nome de campo no formato 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 do 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),[,]`, bem como caracteres ASCII.

Exemplos: (Observação: os comentários aqui estão escritos em sintaxe 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*`, não qualquer campo.

Uma 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 têm a própria configuração de índice Field.

object (IndexConfig)

A configuração de índice para este campo. Se não for definida, a indexação de campo vai 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.

{
  "indexes": [
    {
      object (Index)
    }
  ],
  "usesAncestorConfig": boolean,
  "ancestorField": string,
  "reverting": boolean
}

object (Index)

Os índices compatíveis com este campo.

boolean

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

string

Apenas saída. Especifica o nome do recurso da Field que define a configuração de índice desse campo (quando usesAncestorConfig for verdadeiro) ou em que ele seria definido se o campo não tivesse configuração de índice (quando usesAncestorConfig fosse falso).

boolean

Saída apenas quando verdadeiro, a configuração de índice de Field está em processo de reversão. Depois de concluída, a configuração do índice vai fazer a transição para o mesmo estado do campo especificado por ancestorField. Nesse momento, usesAncestorConfig será true e reverting será false.