REST Resource: projects.databases.collectionGroups.fields

リソース: フィールド

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

フィールドは、同じ 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` は、 in the field address , not the map key address.city represents a field named . `*` は、任意のフィールドではなく、*` represents a field named

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

indexConfig

object ( IndexConfig )

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

ttlConfig

object ( TtlConfig )

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

インデックス構成

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

JSON表現
{
  "indexes": [
    {
      object (Index)
    }
  ],
  "usesAncestorConfig": boolean,
  "ancestorField": string,
  "reverting": boolean
}
田畑
indexes[]

object ( Index )

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

usesAncestorConfig

boolean

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

ancestorField

string

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

reverting

boolean

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

TtlConfig

この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

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