フィードバックを送信
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
になり、 reverting
はfalse
になります。
TtlConfig このField
セットを持つドキュメントの TTL (有効期限) 設定。
TTL が有効なフィールドにタイムスタンプ値を保存すると、ドキュメントの絶対有効期限として扱われます。過去のタイムスタンプ値は、ドキュメントが即時有効期限切れになる可能性があることを示します。他のデータ型を使用するか、フィールドを省略したままにすると、個々のドキュメントの有効期限が無効になります。
JSON表現 {
"state" : enum (State
)
}
田畑 state
enum ( State
)
出力のみ。 TTL 構成の状態。
州 列挙型 STATE_UNSPECIFIED
状態は未指定または不明です。 CREATING
TTLが適用されています。変更を追跡するためのアクティブな長時間実行操作があります。新しく書かれたドキュメントには、要求に応じて TTL が適用されます。既存のドキュメントで要求された TTL はまだ処理中です。すべての既存のドキュメントの TTL が処理されると、状態は「ACTIVE」に移行します。 ACTIVE
TTL はすべてのドキュメントに対して有効です。 NEEDS_REPAIR
すべての既存のドキュメントに対して TTL 構成を有効にすることができませんでした。新しく書かれたドキュメントには引き続き TTL が適用されます。このField
の TTL を最後に有効にしようとして失敗したときに返された LRO には、詳細が含まれている可能性があります。
メソッド フィールドのメタデータと構成を取得します。 このデータベースのフィールド構成とメタデータをリストします。 フィールド構成を更新します。
フィードバックを送信
特に記載のない限り、このページのコンテンツはクリエイティブ・コモンズの表示 4.0 ライセンス により使用許諾されます。コードサンプルは Apache 2.0 ライセンス により使用許諾されます。詳しくは、Google Developers サイトのポリシー をご覧ください。Java は Oracle および関連会社の登録商標です。
最終更新日 2023-12-01 UTC。
[{
"type": "thumb-down",
"id": "missingTheInformationINeed",
"label":"必要な情報がない"
},{
"type": "thumb-down",
"id": "tooComplicatedTooManySteps",
"label":"複雑すぎる / 手順が多すぎる"
},{
"type": "thumb-down",
"id": "outOfDate",
"label":"最新ではない"
},{
"type": "thumb-down",
"id": "translationIssue",
"label":"翻訳に関する問題"
},{
"type": "thumb-down",
"id": "samplesCodeIssue",
"label":"サンプル / コードに問題がある"
},{
"type": "thumb-down",
"id": "otherDown",
"label":"その他"
}]
[{
"type": "thumb-up",
"id": "easyToUnderstand",
"label":"わかりやすい"
},{
"type": "thumb-up",
"id": "solvedMyProblem",
"label":"問題の解決に役立った"
},{
"type": "thumb-up",
"id": "otherUp",
"label":"その他"
}]
ご意見をお聞かせください