REST Resource: projects.databases.collectionGroups.fields

Recurso: campo

Representa um único campo no banco de dados.

Os campos são agrupados pelo "Grupo de coleções", que representa todos os conjuntos no banco de dados com o mesmo ID.

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

string

Obrigatório. 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.
indexConfig

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

object (TtlConfig)

A configuração de TTL deste Field. Se você definir ou desmarcar essa opção, o TTL dos documentos que têm esse Field será ativado ou desativado.

IndexConfig

A configuração de índice para este 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 a partir da 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 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).
reverting

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.

TtlConfig

A configuração de TTL (vida útil) para documentos que tenham esse Field definido.

O armazenamento de um valor de carimbo de data/hora em um campo ativado para TTL será tratado como o prazo de validade absoluto do documento. Os valores de carimbo de data/hora no passado indicam que o documento está qualificado para expiração imediata. Usar qualquer outro tipo de dados ou deixar o campo ausente desativa a expiração do documento individual.

Representação JSON 
{
  "state": enum (State)
}
Campos
state

enum (State)

Apenas saída. O estado da configuração do TTL.

Estado

O estado de aplicação da configuração de TTL a todos os documentos.

Enums
STATE_UNSPECIFIED O estado não foi especificado ou é desconhecido.
CREATING O TTL está sendo aplicado. Há uma operação ativa de longa duração para rastrear a alteração. Os documentos recém-gravados terão a TTL aplicada conforme solicitado. Os TTLs solicitados nos documentos existentes ainda estão sendo processados. Quando os TTLs em todos os documentos existentes forem processados, o estado passará para "ACTIVE".
ACTIVE O TTL está ativo para todos os documentos.
NEEDS_REPAIR Não foi possível ativar a configuração de TTL para todos os documentos existentes. O TTL dos documentos recém-gravados continuará sendo aplicado. A LRO retornada na última tentativa de ativar o TTL para este Field falhou e pode ter mais detalhes.

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.