FieldOperationMetadata

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

enum (ChangeType)

指定索引變更方式。

object (Index)

正在變更的索引。

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

string

僅供輸出。這個索引的伺服器定義名稱。複合式索引的名稱格式如下：projects/{projectId}/databases/{databaseId}/collectionGroups/{collectionId}/indexes/{composite_index_id}。如果是單一欄位索引，這個欄位將為空白。

enum (QueryScope)

如果索引已指定集合查詢範圍，您就能查詢特定文件 (在查詢時指定)，且集合 ID 相同的集合 ID 的集合。

如果索引已指定集合群組查詢範圍，則可查詢所有集合，這些集合皆來自於查詢時指定的特定文件，且集合 ID 與此索引相同。

enum (ApiScope)

這個索引支援的 API 範圍。

object (IndexField)

這個索引支援的欄位。

如果是複合式索引，則需要最少 2 個，最多 100 個欄位。最後一個欄位項目一律適用於欄位路徑 __name__。如果在建立時未指定 __name__ 做為最後一個欄位，系統會自動新增該欄位，方向與最後一個欄位定義的方向相同。如果複合式索引中的最後一個欄位沒有方向性，則 __name__ 會排序 ASCENDING (除非明確指定)。

如果是單一欄位索引，則一律為一個項目，且欄位路徑等於關聯欄位的欄位路徑。

enum (State)

僅供輸出。索引的服務狀態。

{
  "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

可以是 name。如果是單一欄位索引，這個值必須與欄位名稱相符，否則可省略。

enum (Order)

表示這個欄位支援依指定順序排序，或使用 =、!=、<、<=、>、>= 來比較。

enum (ArrayConfig)

表示這個欄位支援 arrayValue 的作業。

object (VectorConfig)

表示這個欄位支援在向量上最近的鄰點和距離操作。

{
  "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

必要欄位。套用這項設定的向量維度。

產生的索引只會包含這個維度的向量，可用於具有相同維度的向量搜尋。

object (FlatIndex)

表示向量索引是平面索引。

{
  "changeType": enum (ChangeType)
}

enum (ChangeType)

指定存留時間設定的變更方式。