REST Resource: projects.databases.collectionGroups.indexes

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

出力のみ。インデックスの提供状態。