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)
  },
  "ttlConfig": {
    object (TtlConfig)
  }
}
Campos
name

string

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

ttlConfig

object ( TtlConfig )

A configuração TTL para este Field . Definir ou desmarcar isso ativará ou desativará o TTL para documentos que possuem este Field .

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 .

TtlConfig

A configuração TTL (time-to-live) para documentos que possuem esse Field definido.

Armazenar um valor de carimbo de data/hora em um campo habilitado para TTL será tratado como o tempo de expiração absoluto do documento. Os valores de carimbo de data/hora no passado indicam que o documento é elegível para expiração imediata. Usar qualquer outro tipo de dados ou deixar o campo ausente desabilitará a expiração do documento individual.

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

enum ( State )

Somente saída. O estado da configuração TTL.

Estado

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

Enums
STATE_UNSPECIFIED O estado não é especificado ou é desconhecido.
CREATING O TTL está sendo aplicado. Há uma operação ativa de longa duração para rastrear a alteração. Documentos recém-escritos terão TTLs aplicados conforme solicitado. Os TTLs solicitados em documentos existentes ainda estão sendo processados. Quando os TTLs de todos os documentos existentes forem processados, o estado passará para 'ATIVO'.
ACTIVE O TTL está ativo para todos os documentos.
NEEDS_REPAIR A configuração TTL não pôde ser habilitada para todos os documentos existentes. Documentos recém-escritos continuarão a ter seu TTL aplicado. A LRO retornada na última tentativa de habilitar o TTL para este Field falhou e pode ter mais detalhes.

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.