REST Resource: projects.databases.collectionGroups.fields

{
  "name": string,
  "indexConfig": {
    object (IndexConfig)
  }
}

string

projects/{projectId}/databases/{databaseId}/collectionGroups/{collectionId}/fields/{fieldPath} 形式のフィールド名

フィールドパスは、シンプルなフィールド名（address など）か mapValue 内のフィールドへのパス（address.city など）か、特別なフィールドパスです。有効な特殊フィールドは * で、任意のフィールドを表します。

フィールドパスは、(backtick). The only character that needs to be escaped within a quoted field path is the backtick character itself, escaped using a backslash. Special characters in field paths that must be quoted include:*,., ``` (backtick),[,]または任意の ASCII 記号を使用して引用符で囲むことができます。

例: （注: ここでのコメントはマークダウン構文で記述されるため、コードブロックを表すバッククォートの追加レイヤが存在します）\address.city`represents a field namedaddress.city, not the map key cityin the fieldaddress. `*`represents a field named*`。フィールドはありません。

特別な Field には、すべてのフィールドのデフォルトのインデックス登録設定が含まれます。このフィールドのリソース名は projects/{projectId}/databases/{databaseId}/collectionGroups/__default__/fields/* です。この Field に定義されたインデックスは、独自の Field インデックス構成がないすべてのフィールドに適用されます。

object (IndexConfig)

このフィールドのインデックス構成。設定しない場合、フィールドのインデックスは、ancestorField で定義された構成に戻ります。このフィールドのすべてのインデックスを明示的に削除するには、インデックスの空のリストを含むインデックス構成を指定します。

{
  "indexes": [
    {
      object (Index)
    }
  ],
  "usesAncestorConfig": boolean,
  "ancestorField": string,
  "reverting": boolean
}

object (Index)

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

boolean

出力のみ。true の場合、Field のインデックス構成は ancestorField で指定された構成から設定されます。false の場合、Field のインデックス構成は明示的に定義されます。

string

出力のみ。このフィールドのインデックス構成の設定元（usesAncestorConfig が true の場合）またはこのフィールドのインデックス構成がない場合（usesAncestorConfig が false の場合）は設定される Field のリソース名を指定します。

boolean

出力のみ。true の場合、Field のインデックス構成は復元中です。完了すると、インデックス構成は ancestorField で指定されたフィールドと同じ状態に遷移し、その時点で usesAncestorConfig は true、reverting は false になります。