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 を持つすべてのコレクションに対してクエリを実行できます。

enum (ApiScope)

このインデックスでサポートされている API スコープ。

object (IndexField)

このインデックスでサポートされているフィールド。

複合インデックスの場合、フィールド数は 2 ～ 100 個です。最後のフィールド エントリは常にフィールドパス __name__ になります。作成時に、__name__ が最後のフィールドとして指定されていない場合は、最後に定義されたフィールドと同じ方向で自動的に追加されます。複合インデックスの最後のフィールドがディレクショナルでない場合、__name__ は（明示的に指定しない限り）昇順になります。

単一フィールド インデックスの場合、これは常に、関連付けられたフィールドのフィールドパスと同じフィールドパスを持つ 1 つのエントリになります。

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)

TTL 構成の変更方法を指定します。