リソース: Field
データベース内の単一のフィールドを表します。
フィールドは「コレクション グループ」でグループ化されます。コレクション グループとは、データベース内の同じ ID を持つすべてのコレクションを表します。
JSON 表現 |
---|
{ "name": string, "indexConfig": { object ( |
フィールド | |
---|---|
name |
必須。 フィールドパスは、シンプルなフィールド名( フィールドパスは、 例: (注: ここでのコメントはマークダウン構文で記述されるため、コードブロックを表すバッククォートの追加レイヤが存在します) 特別な |
indexConfig |
このフィールドのインデックス構成。設定しない場合、フィールドのインデックスは、 |
ttlConfig |
この |
IndexConfig
このフィールドのインデックス構成。
JSON 表現 |
---|
{
"indexes": [
{
object ( |
フィールド | |
---|---|
indexes[] |
このフィールドでサポートされているインデックス。 |
usesAncestorConfig |
出力のみ。true の場合、 |
ancestorField |
出力のみ。このフィールドのインデックス構成の設定元( |
reverting |
出力のみ。true の場合、 |
TtlConfig
この 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 が詳細を示している可能性があります。 |
Methods |
|
---|---|
|
Field のメタデータと構成を取得します。 |
|
このデータベースのフィールド構成とメタデータを一覧表示します。 |
|
フィールド構成を更新します。 |