FieldOperationMetadata

Metadados para resultados de google.longrunning.Operation de FirestoreAdmin.UpdateField .

Representação JSON
{
  "startTime": string,
  "endTime": string,
  "field": string,
  "indexConfigDeltas": [
    {
      object (IndexConfigDelta)
    }
  ],
  "state": enum (OperationState),
  "progressDocuments": {
    object (Progress)
  },
  "progressBytes": {
    object (Progress)
  },
  "ttlConfigDelta": {
    object (TtlConfigDelta)
  }
}
Campos
startTime

string ( Timestamp format)

A hora em que esta operação foi iniciada.

Um carimbo de data/hora no formato RFC3339 UTC "Zulu", com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z" .

endTime

string ( Timestamp format)

A hora em que esta operação foi concluída. Será desativado se a operação ainda estiver em andamento.

Um carimbo de data/hora no formato RFC3339 UTC "Zulu", com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z" .

field

string

O recurso de campo no qual esta operação está atuando. Por exemplo: projects/{projectId}/databases/{databaseId}/collectionGroups/{collectionId}/fields/{fieldPath}

indexConfigDeltas[]

object ( IndexConfigDelta )

Uma lista de IndexConfigDelta , que descreve a intenção desta operação.

state

enum ( OperationState )

O estado da operação.

progressDocuments

object ( Progress )

O andamento, em documentos, desta operação.

progressBytes

object ( Progress )

O progresso, em bytes, desta operação.

ttlConfigDelta

object ( TtlConfigDelta )

Descreve os deltas da configuração TTL.

IndexConfigDelta

Informações sobre uma alteração na configuração do índice.

Representação JSON
{
  "changeType": enum (ChangeType),
  "index": {
    object (Index)
  }
}
Campos
changeType

enum ( ChangeType )

Especifica como o índice está mudando.

index

object ( Index )

O índice sendo alterado.

Índice

Os índices do Cloud Firestore permitem consultas simples e complexas em documentos em um banco de dados.

Representação JSON
{
  "name": string,
  "queryScope": enum (QueryScope),
  "apiScope": enum (ApiScope),
  "fields": [
    {
      object (IndexField)
    }
  ],
  "state": enum (State)
}
Campos
name

string

Somente saída. Um nome definido pelo servidor para este índice. A forma deste nome para índices compostos será: projects/{projectId}/databases/{databaseId}/collectionGroups/{collectionId}/indexes/{composite_index_id} Para índices de campo único, este campo estará vazio.

queryScope

enum ( QueryScope )

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

Os índices com um escopo de consulta de grupo de coleções especificado permitem consultas em todas as coleções descendentes de um documento específico, especificado no momento da consulta, e que possuem o mesmo ID de coleção que esse índice.

apiScope

enum ( ApiScope )

O escopo da API compatível com este índice.

fields[]

object ( IndexField )

Os campos suportados por este índice.

Para índices compostos, isso requer um mínimo de 2 e um máximo de 100 campos. A última entrada do campo é sempre para o caminho do campo __name__ . Se, na criação, __name__ não foi especificado como ú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 ASCENDENTE (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.

state

enum ( State )

Somente saída. O estado de veiculação do índice.

CampoIndex

Um campo em um índice. O fieldPath descreve qual campo é indexado, o value_mode descreve como o valor do campo é indexado.

Representação JSON
{
  "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.
}
Campos
fieldPath

string

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

Campo de união value_mode . Como o valor do campo é indexado. value_mode pode ser apenas um dos seguintes:
order

enum ( Order )

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

arrayConfig

enum ( ArrayConfig )

Indica que este campo oferece suporte a operações em arrayValue s.

vectorConfig

object ( VectorConfig )

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

VectorConfig

A configuração do índice para suportar operações de pesquisa vetorial

Representação JSON
{
  "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.
}
Campos
dimension

integer

Obrigatório. A dimensão vetorial à qual esta configuração se aplica.

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

type de campo de união. O tipo de índice usado. type pode ser apenas um dos seguintes:
flat

object ( FlatIndex )

Indica que o índice vetorial é um índice plano.

FlatIndex

Este tipo não possui campos.

Um índice que armazena vetores em uma estrutura de dados simples e oferece suporte a pesquisas exaustivas.

TtlConfigDelta

Informações sobre uma alteração na configuração do TTL.

Representação JSON
{
  "changeType": enum (ChangeType)
}
Campos
changeType

enum ( ChangeType )

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