REST Resource: projects.databases.collectionGroups.fields

リソース: Field

データベースの単一のフィールドを表します。

フィールドは「コレクション グループ」ごとにグループ化されます。これは、データベース内で同じ ID を持つすべてのコレクションを表します。

JSON 表現 
{
  "name": string,
  "indexConfig": {
    object (IndexConfig)
  }
}
フィールド
name

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 インデックス構成を持たないすべてのフィールドに適用されます。
indexConfig

object (IndexConfig)

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

IndexConfig

このフィールドのインデックス構成。

JSON 表現 
{
  "indexes": [
    {
      object (Index)
    }
  ],
  "usesAncestorConfig": boolean,
  "ancestorField": string,
  "reverting": boolean
}
フィールド
indexes[]

object (Index)

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

boolean

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

string

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

boolean

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

メソッド

get

 フィールドのメタデータと構成を取得します。

list

 このデータベースのフィールド構成とメタデータを一覧表示します。

patch

 フィールド構成を更新します。