FieldOperationMetadata

{
  "changeType": enum (ChangeType),
  "index": {
    object (Index)
  }
}

enum (ChangeType)

Especifica como o índice está sendo alterado.

object (Index)

O índice que está sendo alterado.

{
  "name": string,
  "queryScope": enum (QueryScope),
  "apiScope": enum (ApiScope),
  "fields": [
    {
      object (IndexField)
    }
  ],
  "state": enum (State)
}

string

Apenas saída. Um nome definido pelo servidor para esse índice. O formato desse nome para índices compostos será: projects/{projectId}/databases/{databaseId}/collectionGroups/{collectionId}/indexes/{composite_index_id}. No caso de índices de campo único, esse campo estará vazio.

enum (QueryScope)

Os índices com um escopo de consulta de coleção especificado permitem consultas em uma coleção que é filha de um documento específico, especificada no momento da consulta e que tem o mesmo ID de coleção.

Os índices com um escopo de consulta de grupo de coleções especificado permitem consultas em todos os conjuntos descendentes de um documento específico, especificado no momento da consulta e que têm o mesmo ID de coleção que este índice.

enum (ApiScope)

O escopo da API com suporte nesse índice.

object (IndexField)

Os campos aceitos por esse índice.

Para índices compostos, isso requer no mínimo dois e no máximo 100 campos. A última entrada de campo é sempre para o caminho do campo __name__. Se, na criação, __name__ não tiver sido especificado como o último campo, ele será adicionado automaticamente com a mesma direção do último campo definido. Se o campo final em um índice composto não for direcional, o __name__ será ordenado ASCENDING (a menos que especificado explicitamente).

Para índices de campo único, será sempre exatamente uma entrada com um caminho de campo igual ao caminho do campo associado.

enum (State)

Apenas saída. O estado de exibição do índice.

{
  "fieldPath": string,

  // Union field value_mode can be only one of the following:
  "order": enum (Order),
  "arrayConfig": enum (ArrayConfig),
  "vectorConfig": {
    object (VectorConfig)
  }
  // End of list of possible types for union field value_mode.
}

string

Pode ser name. Para índices de campo único, ele precisa corresponder ao nome do campo ou pode ser omitido.

enum (Order)

Indica que este campo oferece suporte para ordenação pela ordem especificada ou comparação usando =, !=, <, <=, >, >=.

enum (ArrayConfig)

Indica que este campo é compatível com operações em arrayValues.

object (VectorConfig)

Indica que este campo oferece suporte para vizinhos mais próximos e operações de distância no vetor.

{
  "dimension": integer,

  // Union field type can be only one of the following:
  "flat": {
    object (FlatIndex)
  }
  // End of list of possible types for union field type.
}

integer

Obrigatório. A dimensão vetorial a que essa configuração se aplica.

O índice resultante incluirá somente vetores dessa dimensão e poderá ser usado para pesquisa de vetor com a mesma dimensão.

object (FlatIndex)

Indica que o índice de vetor é plano.

{
  "changeType": enum (ChangeType)
}

enum (ChangeType)

Especifica como a configuração do TTL está mudando.