FieldOperationMetadata

Метаданные для google.longrunning.Operation — результаты FirestoreAdmin.UpdateField .

JSON-представление
{
  "startTime": string,
  "endTime": string,
  "field": string,
  "indexConfigDeltas": [
    {
      object (IndexConfigDelta)
    }
  ],
  "state": enum (OperationState),
  "progressDocuments": {
    object (Progress)
  },
  "progressBytes": {
    object (Progress)
  },
  "ttlConfigDelta": {
    object (TtlConfigDelta)
  }
}
Поля
startTime

string ( Timestamp format)

Время начала этой операции.

Временная метка в формате RFC3339 UTC «Зулу» с наносекундным разрешением и до девяти дробных цифр. Примеры: "2014-10-02T15:01:23Z" и "2014-10-02T15:01:23.045123456Z" .

endTime

string ( Timestamp format)

Время завершения этой операции. Будет отключено, если операция еще продолжается.

Временная метка в формате RFC3339 UTC «Зулу» с наносекундным разрешением и до девяти дробных цифр. Примеры: "2014-10-02T15:01:23Z" и "2014-10-02T15:01:23.045123456Z" .

field

string

Ресурс поля, над которым действует эта операция. Например: projects/{projectId}/databases/{databaseId}/collectionGroups/{collectionId}/fields/{fieldPath}

indexConfigDeltas[]

object ( IndexConfigDelta )

Список IndexConfigDelta , описывающий цель этой операции.

state

enum ( OperationState )

Состояние операции.

progressDocuments

object ( Progress )

Ход этой операции в документах.

progressBytes

object ( Progress )

Ход выполнения этой операции в байтах.

ttlConfigDelta

object ( TtlConfigDelta )

Описывает различия в конфигурации TTL.

ИндексКонфигДельта

Информация об изменении конфигурации индекса.

JSON-представление
{
  "changeType": enum (ChangeType),
  "index": {
    object (Index)
  }
}
Поля
changeType

enum ( ChangeType )

Указывает, как изменяется индекс.

index

object ( Index )

Индекс изменяется.

Индекс

Индексы Cloud Firestore позволяют выполнять простые и сложные запросы к документам в базе данных.

JSON-представление
{
  "name": string,
  "queryScope": enum (QueryScope),
  "apiScope": enum (ApiScope),
  "fields": [
    {
      object (IndexField)
    }
  ],
  "state": enum (State)
}
Поля
name

string

Только вывод. Определенное сервером имя для этого индекса. Форма этого имени для составных индексов будет следующей: projects/{projectId}/databases/{databaseId}/collectionGroups/{collectionId}/indexes/{composite_index_id} Для индексов с одним полем это поле будет пустым.

queryScope

enum ( QueryScope )

Индексы с указанной областью запроса коллекции позволяют выполнять запросы к коллекции, которая является дочерней для определенного документа, указанного во время запроса, и имеет тот же идентификатор коллекции.

Индексы с указанной областью запроса группы коллекций позволяют выполнять запросы ко всем коллекциям, происходящим из определенного документа, указанного во время запроса, и которые имеют тот же идентификатор коллекции, что и этот индекс.

apiScope

enum ( ApiScope )

Область API, поддерживаемая этим индексом.

fields[]

object ( IndexField )

Поля, поддерживаемые этим индексом.

Для составных индексов требуется минимум 2 и максимум 100 полей. Последняя запись поля всегда относится к пути к полю __name__ . Если при создании __name__ не было указано в качестве последнего поля, оно будет добавлено автоматически в том же направлении, что и последнее определенное поле. Если последнее поле в составном индексе не является направленным, __name__ будет упорядочено по возрастанию (если не указано иное).

Для индексов с одним полем это всегда будет ровно одна запись с путем к полю, равным пути к связанному полю.

state

enum ( State )

Только вывод. Состояние обслуживания индекса.

ИндексФилд

Поле в индексе. FieldPath описывает, какое поле индексируется, value_mode описывает, как индексируется значение поля.

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.
}
Поля
fieldPath

string

Можно имя . Для индексов с одним полем оно должно совпадать с именем поля или может быть опущено.

Поле объединения value_mode . Как индексируется значение поля. value_mode может быть только одним из следующих:
order

enum ( Order )

Указывает, что это поле поддерживает упорядочивание по указанному порядку или сравнение с использованием =, !=, <, <=, >, >=.

arrayConfig

enum ( ArrayConfig )

Указывает, что это поле поддерживает операции с arrayValue .

vectorConfig

object ( VectorConfig )

Указывает, что это поле поддерживает операции с ближайшими соседями и расстоянием над вектором.

ВекторКонфиг

Конфигурация индекса для поддержки операций поиска векторов

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.
}
Поля
dimension

integer

Необходимый. Векторное измерение, к которому применяется эта конфигурация.

Результирующий индекс будет включать только векторы этого измерения и может использоваться для поиска векторов того же измерения.

type поля объединения. Тип используемого индекса. type может быть только одним из следующих:
flat

object ( FlatIndex )

Указывает, что векторный индекс является плоским индексом.

Флэтиндекс

Этот тип не имеет полей.

Индекс, который хранит векторы в плоской структуре данных и поддерживает исчерпывающий поиск.

Ттлконфигдельта

Информация об изменении конфигурации TTL.

JSON-представление
{
  "changeType": enum (ChangeType)
}
Поля
changeType

enum ( ChangeType )

Указывает, как изменяется конфигурация TTL.