FirestoreAdmin.UpdateField
からの結果 google.longrunning.Operation
のメタデータ。
JSON 表現 |
---|
{ "startTime": string, "endTime": string, "field": string, "indexConfigDeltas": [ { object ( |
フィールド | |
---|---|
startTime |
このオペレーションが開始した時刻。 RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: |
endTime |
このオペレーションが完了した時刻。オペレーションが進行中の場合は設定されません。 RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: |
field |
このオペレーションの対象となるフィールド リソース。例: |
indexConfigDeltas[] |
このオペレーションの意図を記述する |
state |
オペレーションの状態。 |
progressDocuments |
このオペレーションの進行状況(ドキュメント単位)。 |
progressBytes |
このオペレーションの進行状況(バイト単位)。 |
ttlConfigDelta |
TTL 構成の差分を記述します。 |
IndexConfigDelta
インデックス構成の変更に関する情報。
JSON 表現 |
---|
{ "changeType": enum ( |
フィールド | |
---|---|
changeType |
インデックスの変更方法を指定します。 |
index |
変更されるインデックス。 |
索引
Cloud Firestore のインデックスを使用すると、データベース内のドキュメントに対して単純なクエリから複雑なクエリを行うことができます。
JSON 表現 |
---|
{ "name": string, "queryScope": enum ( |
フィールド | |
---|---|
name |
出力のみ。このインデックスに対してサーバーで定義された名前。複合インデックスの名前の形式は、 |
queryScope |
コレクション クエリのスコープが指定されたインデックスでは、特定のドキュメントの子であり、クエリ時に指定され、同じコレクション ID を持つコレクションに対してクエリを実行できます。 コレクション グループのクエリのスコープが指定されているインデックスでは、特定のドキュメントの子孫で、クエリ時に指定され、このインデックスと同じコレクション ID を持つすべてのコレクションに対してクエリを実行できます。 |
apiScope |
このインデックスでサポートされている API スコープ。 |
fields[] |
このインデックスでサポートされているフィールド。 複合インデックスの場合、フィールド数は 2 ~ 100 個です。最後のフィールド エントリは常にフィールドパス 単一フィールド インデックスの場合、これは常に、関連付けられたフィールドのフィールドパスと同じフィールドパスを持つ 1 つのエントリになります。 |
state |
出力のみ。インデックスの提供状態。 |
IndexField
インデックス内のフィールド。fieldPath は、どのフィールドにインデックスが付けられるかを示します。value_mode は、フィールド値にインデックスが付けられる方法です。
JSON 表現 |
---|
{ "fieldPath": string, // Union field |
フィールド | |
---|---|
fieldPath |
name の場合もあります。単一フィールド インデックスの場合は、フィールド名と一致させるか、省略できます。 |
共用体フィールド value_mode 。フィールド値にインデックスを付ける方法。value_mode は次のいずれかになります。 |
|
order |
このフィールドが、指定された順序による並べ替え、または =、!=、<、<=、>、>= を使用した比較をサポートしていることを示します。 |
arrayConfig |
このフィールドが |
vectorConfig |
このフィールドが、ベクトルに対する最近傍と距離演算をサポートしていることを示します。 |
VectorConfig
ベクトル検索オペレーションをサポートするためのインデックス構成
JSON 表現 |
---|
{ "dimension": integer, // Union field |
フィールド | |
---|---|
dimension |
必須。この構成が適用されるベクトルのディメンション。 結果として得られるインデックスには、この次元のベクトルのみが含まれ、同じ次元のベクトル検索に使用できます。 |
共用体フィールド type 。使用されるインデックスのタイプ。type は次のいずれかになります。 |
|
flat |
ベクトル インデックスがフラット インデックスであることを示します。 |
FlatIndex
このタイプにはフィールドがありません。
ベクトルをフラットなデータ構造で格納し、網羅的な検索をサポートするインデックス。
TtlConfigDelta
TTL 構成の変更に関する情報。
JSON 表現 |
---|
{
"changeType": enum ( |
フィールド | |
---|---|
changeType |
TTL 構成の変更方法を指定します。 |