Connector SDK と Google Cloud Search API を使用すると、次のタスクを実行するために使用される Cloud Search インデックス登録キューを作成できます。
インデックスとリポジトリとの同期を保つために使用できるドキュメントごとの状態（ステータス、ハッシュ値など）を維持する。
走査プロセスで検出されたインデックス登録されるアイテムのリストを維持する。
アイテム ステータスに基づいてキュー内のアイテムの優先順位を付ける。
チェックポイント、変更トークンなど、効率的に統合するための追加の状態情報を維持する。
キューは、インデックスに登録されたアイテムに割り当てられるラベルです。デフォルト キューの場合は「default」、キュー B の場合は「B」などです。
ステータスと優先度
キュー内のドキュメントの優先度は、ItemStatus コードに基づいて決まります。使用可能な ItemStatus コードを優先度順（最初に処理したものから最後に処理）したものを以下に示します。
ERROR- インデックス登録中に非同期エラーが発生し、インデックスに再登録する必要があるアイテム。MODIFIED- 以前にインデックスに登録され、前回のインデックス登録以降にリポジトリ内で変更されたアイテム。NEW_ITEM- インデックスに登録されていないアイテム。ACCEPTED- 以前にインデックスに登録され、前回のインデックス登録以降にリポジトリ内で変更されていないドキュメント。
キュー内の 2 つのアイテムのステータスが同じ場合、長い時間キューに入っているアイテムの優先度が高くなります。
インデックス登録キューを使用して新規または変更されたアイテムをインデックス登録する方法の概要
図 1 は、インデックス キューを使用して新規または変更されたアイテムをインデックス登録する手順を示しています。次の手順では、REST API 呼び出しを示します。同等の SDK 呼び出しについては、キュー オペレーション（Connector SDK）をご覧ください。
コンテンツ コネクタは
items.pushを使用してアイテム（メタデータとハッシュ）をインデックス登録キューに push し、アイテムのステータス（MODIFIED、NEW_ITEM、DELETED）を確立します。具体的には、次のようになります。- プッシュする場合、コネクタにはプッシュ
typeまたはcontentHashが明示的に含まれます。 - コネクタに
typeが含まれていない場合、Cloud Search はcontentHashを使用してアイテムのステータスを自動的に判断します。 - アイテムが不明な場合、アイテムのステータスは
NEW_ITEMに設定されます。 - アイテムが存在し、ハッシュ値が一致する場合、ステータスは
ACCEPTEDのままになります。 - アイテムが存在し、ハッシュが異なる場合、ステータスは
MODIFIEDになります。
アイテムのステータスの設定方法については、Cloud Search スタートガイド チュートリアルの GitHub リポジトリの走査のサンプルコードをご覧ください。
通常、プッシュは、コネクタ内のコンテンツ トラバーサル プロセスや変更検出プロセスに関連付けられます。
- プッシュする場合、コネクタにはプッシュ
コンテンツ コネクタは
items.pollを使用してキューをポーリングし、インデックスに登録するアイテムを決定します。Cloud Search は、インデックス登録が最も必要なアイテムをコネクタに通知します。アイテムは、まずステータス コードで、次にキュー内の時間で並べ替えられます。コネクタは、これらのアイテムをリポジトリから取得し、インデックス API リクエストを作成します。
コネクタは
items.indexを使用してアイテムをインデックス登録します。Cloud Search でアイテムの処理が正常に完了した後にのみ、アイテムがACCEPTED状態になります。
コネクタは、リポジトリにアイテムが存在しなくなった場合はアイテムを削除することも、アイテムが変更されていない場合やソース リポジトリにエラーがある場合はアイテムを再度 push することもできます。アイテムの削除については、次のセクションをご覧ください。
インデックス登録キューを使用したアイテム削除の概要
完全走査戦略では、2 つのキュー プロセスを使用してアイテムをインデックス登録し、削除を検出します。図 2 は、2 つのインデックス キューを使用してアイテムを削除する手順を示しています。具体的には、図 2 は、完全走査戦略を使用して実行された 2 回目の走査を示しています。次の手順では、REST API 呼び出しを使用します。同等の SDK 呼び出しについては、キュー オペレーション（Connector SDK）をご覧ください。
最初の走査で、コンテンツ コネクタは
items.pushを使用して、アイテム（メタデータとハッシュ）をインデックス キュー（キュー A）に push します。キュー A はキュー内に存在しないため、NEW_ITEMとして push されます。各アイテムには、「キュー A」のラベル「A」が割り当てられます。コンテンツが Cloud Search にインデックス登録されます。コンテンツ コネクタは
items.pollを使用してキュー A をポーリングし、インデックスに登録するアイテムを決定します。Cloud Search は、インデックス登録が最も必要なアイテムをコネクタに通知します。アイテムは、まずステータス コードで、次にキュー内の時間で並べ替えられます。コネクタは、これらのアイテムをリポジトリから取得し、インデックス API リクエストを作成します。
コネクタは
items.indexを使用してアイテムをインデックス登録します。Cloud Search でアイテムの処理が正常に完了した後にのみ、アイテムがACCEPTED状態になります。deleteQueueItemsメソッドは「キュー B」で呼び出されます。ただし、キュー B にアイテムが push されていないため、何も削除できません。2 回目のフル走査では、コンテンツ コネクタが
items.pushを使用してアイテム（メタデータとハッシュ）をキュー B に push します。- プッシュする場合、コネクタにはプッシュ
typeまたはcontentHashが明示的に含まれます。 - コネクタに
typeが含まれていない場合、Cloud Search は自動的にcontentHashを使用してアイテムのステータスを判断します。 - アイテムが不明な場合、アイテムのステータスは
NEW_ITEMに設定され、キューのラベルは「B」に変更されます。 - アイテムが存在し、ハッシュ値が一致する場合、ステータスは
ACCEPTEDのままで、キューラベルは「B」に変更されます。 - アイテムが存在し、ハッシュが異なる場合、ステータスは
MODIFIEDになり、キューラベルは「B」に変更されます。
- プッシュする場合、コネクタにはプッシュ
コンテンツ コネクタは
items.pollを使用してキューをポーリングし、インデックスに登録するアイテムを決定します。Cloud Search は、インデックス登録が最も必要なアイテムをコネクタに伝え、まずステータス コードで並べ替えられ、次にキューに入っている時間で並べ替えます。コネクタはこれらのアイテムをリポジトリから取得し、インデックス API リクエストを作成します。
コネクタは
items.indexを使用してアイテムをインデックス登録します。アイテムがACCEPTED状態になるのは、Cloud Search がアイテムの処理を正常に完了した後です。最後に、キュー A で
deleteQueueItemsが呼び出され、キュー「A」ラベルがまだ付いている、以前にインデックスに登録されたすべての CCloud Search アイテムが削除されます。その後の完全な走査では、インデックスに使用されるキューと削除に使用されるキューが入れ替わります。
キュー オペレーション（Connector SDK）
Content Connector SDK は、キューにアイテムを push したり、キューからアイテムを pull したりするオペレーションを提供します。
アイテムをパッケージ化してキューに push するには、pushItems ビルダークラスを使用します。
処理のためにキューからアイテムを pull する場合、特別な操作を行う必要はありません。アイテムは、SDK によって、Repository クラスの getDoc メソッドを使用して優先度順にキューから自動的に pull されます。
キュー オペレーション（REST API）
REST API は、キューにアイテムを push し、キューからアイテムを pull する次の 2 つのメソッドを提供します。
- アイテムをキューに push するには、
Items.pushを使用します。 - キュー内のアイテムをポーリングするには、
Items.pollを使用します。
Items.index を使用して、インデックス登録中にアイテムをキューに push することもできます。インデックス作成中にキューに push されるアイテムには type は必要ありません。ステータスは自動的に ACCEPTED に割り当てられます。
Items.push
Items.push メソッドは、キューに ID を追加します。このメソッドは、push オペレーションの結果を決定する特定の type 値で呼び出すことができます。type 値の一覧については、Items.push メソッドの item.type フィールドをご覧ください。
新しい ID をプッシュすると、NEW_ITEM
ItemStatus コードを持つ新しいエントリが追加されます。
オプションのペイロードは常に保存されて、不透明な値として扱われ、Items.poll から返されます。
アイテムはポーリングされると予約され、以降の Items.poll 呼び出しでは返されなくなります。Items.push を NOT_MODIFIED、REPOSITORY_ERROR、または REQUEUE として type で使用すると、ポーリングされたエントリが予約解除されます。予約されたエントリと予約解除されたエントリの詳細については、Items.poll をご覧ください。
ハッシュを含む Items.push
Google Cloud Search API は、Items.index リクエストでメタデータとコンテンツ ハッシュ値の指定をサポートしています。type を指定する代わりに、push リクエストでメタデータやコンテンツ ハッシュ値を指定できます。Cloud Search インデックス登録キューは、指定されたハッシュ値を、データソース内のアイテムで使用可能な保存された値と比較します。一致しない場合、そのエントリは MODIFIED としてマークされます。対応するアイテムがインデックスに存在しない場合、ステータスは NEW_ITEM です。
Items.poll
Items.poll メソッドは、キューから優先度が最も高いエントリを取得します。リクエストおよび返されたステータス値は、リクエストされた優先キューのステータスまたは返された ID のステータスを示します。
デフォルトでは、優先度に基づいてキューのいずれかのセクションからエントリが返されます。返される各エントリは予約されており、次のいずれかの条件が満たされるまで、Items.poll への他の呼び出しでは返されません。
- 予約がタイムアウトする。
- エントリが
Items.indexによって再びキューに入れられる。 Items.pushは、typeの値がNOT_MODIFIED、REPOSITORY_ERROR、またはREQUEUEで呼び出されます。