リソース: Field
データベースの単一のフィールドを表します。
フィールドは「コレクション グループ」によってグループ化されます。これは、データベース内で同じ ID を持つすべてのコレクションを表します。
JSON 表現 |
---|
{ "name": string, "indexConfig": { object ( |
フィールド | |
---|---|
name |
必須。 フィールドパスは、単純なフィールド名の場合があります。次に例を示します。 フィールドパスは、 例: (注: ここでのコメントはマークダウン構文で記述されているため、コードブロックを表すためにバッククォートの追加のレイヤがあります) 特別な |
indexConfig |
このフィールドのインデックス構成。設定しない場合、フィールドのインデックス作成は |
ttlConfig |
この |
IndexConfig
このフィールドのインデックス構成。
JSON 表現 |
---|
{
"indexes": [
{
object ( |
フィールド | |
---|---|
indexes[] |
このフィールドでサポートされているインデックス。 |
usesAncestorConfig |
出力専用。true の場合、 |
ancestorField |
出力専用。このフィールドのインデックス構成の設定元( |
reverting |
出力のみ true の場合、 |
tlConfig
この Field
が設定されているドキュメントの TTL(有効期間)構成。
TTL が有効なフィールドにタイムスタンプ値を保存すると、ドキュメントの絶対有効期限として扱われます。過去のタイムスタンプ値が、ドキュメントが即時有効期限の対象であることを示しています。他のデータ型を使用したり、フィールドを空白のままにしたりすると、個々のドキュメントの有効期限が無効になります。
JSON 表現 |
---|
{
"state": enum ( |
フィールド | |
---|---|
state |
出力専用。TTL 構成の状態。 |
状態
すべてのドキュメントに TTL 構成を適用している状態。
列挙型 | |
---|---|
STATE_UNSPECIFIED |
状態が未指定または不明です。 |
CREATING |
TTL を適用しています。変更を追跡するアクティブな長時間実行オペレーションがあります。新たに作成されたドキュメントには、リクエストに応じて TTL が適用されます。既存のドキュメントでリクエストされた TTL がまだ処理中です。既存のすべてのドキュメントの TTL が処理されると、状態は「ACTIVE」に移行します。 |
ACTIVE |
TTL は、すべてのドキュメントで有効です。 |
NEEDS_REPAIR |
既存のドキュメントの一部で TTL 構成を有効にできませんでした。新しく作成されたドキュメントには、引き続き TTL が適用されます。この Field の TTL の有効化を最後に試みたときに失敗したときに返された LRO。詳細情報が含まれている可能性があります。 |