REST Resource: projects.databases.collectionGroups.fields

リソース: Field

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

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

JSON 表現 
{
  "name": string,
  "indexConfig": {
    object (IndexConfig)
  },
  "ttlConfig": {
    object (TtlConfig)
  }
}
フィールド
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 で定義された構成に戻ります。このフィールドのすべてのインデックスを明示的に削除するには、インデックスの空のリストを使用してインデックス構成を指定します。
ttlConfig

object (TtlConfig)

この Field の TTL 構成。この設定を設定または設定解除すると、この Field が含まれるドキュメントの TTL が有効または無効になります。

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 になります。

tlConfig

この Field が設定されているドキュメントの TTL（有効期間）構成。

TTL が有効なフィールドにタイムスタンプ値を保存すると、ドキュメントの絶対有効期限として扱われます。過去のタイムスタンプ値が、ドキュメントが即時有効期限の対象であることを示しています。他のデータ型を使用したり、フィールドを空白のままにしたりすると、個々のドキュメントの有効期限が無効になります。

JSON 表現 
{
  "state": enum (State)
}
フィールド
state

enum (State)

出力専用。TTL 構成の状態。

状態

すべてのドキュメントに TTL 構成を適用している状態。

列挙型
STATE_UNSPECIFIED 状態が未指定または不明です。
CREATING TTL を適用しています。変更を追跡するアクティブな長時間実行オペレーションがあります。新たに作成されたドキュメントには、リクエストに応じて TTL が適用されます。既存のドキュメントでリクエストされた TTL がまだ処理中です。既存のすべてのドキュメントの TTL が処理されると、状態は「ACTIVE」に移行します。
ACTIVE TTL は、すべてのドキュメントで有効です。
NEEDS_REPAIR 既存のドキュメントの一部で TTL 構成を有効にできませんでした。新しく作成されたドキュメントには、引き続き TTL が適用されます。この Field の TTL の有効化を最後に試みたときに失敗したときに返された LRO。詳細情報が含まれている可能性があります。

メソッド

get

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

list

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

patch

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