FieldOperationMetadata

Metadados de google.longrunning.Operation resultados 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)

Hora em que a 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 essa operação foi concluída. Não será definido 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 em que esta operação está agindo. Por exemplo: projects/{projectId}/databases/{databaseId}/collectionGroups/{collectionId}/fields/{fieldPath}
indexConfigDeltas[]

object (IndexConfigDelta)

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

enum (OperationState)

O estado da operação.
progressDocuments

object (Progress)

O progresso, em documentos, dessa operação.
progressBytes

object (Progress)

O progresso, em bytes, dessa operação.
ttlConfigDelta

object (TtlConfigDelta)

Descreve os deltas da configuração de TTL.

IndexConfigDelta

Informações sobre uma mudança 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 que está 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

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

enum (QueryScope)

Os índices com um escopo de consulta de coleção especificado permitem fazer 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 todas as coleções descendentes de um documento específico, especificado no momento da consulta e que têm o mesmo ID de coleção que o índice.
apiScope

enum (ApiScope)

O escopo da API suportado por este índice.
fields[]

object (IndexField)

Os campos suportados por este índice.

Para índices compostos, isso requer no mínimo 2 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.
state

enum (State)

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

Campo de índice

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 name. Para índices de campo único, ele precisa 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 de um dos tipos a seguir:
order

enum (Order)

Indica que este campo é compatível com a ordenação pela ordem especificada ou comparação usando =, !=, <, <=, >, >=.
arrayConfig

enum (ArrayConfig)

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

object (VectorConfig)

Indica que este campo aceita operações de vizinho e distância mais próximas no vetor.

VectorConfig

A configuração de índice para dar suporte a 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 essa configuração se aplica.

O índice resultante incluirá apenas vetores dessa dimensão e poderá ser usado para pesquisa de vetor com a mesma dimensão.
Campo de união type. O tipo de índice usado. type pode ser apenas de um dos tipos a seguir:
flat

object (FlatIndex)

Indica que o índice vetorial é plano.

Índice fixo

Esse tipo não tem 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 de TTL.

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

enum (ChangeType)

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