インデックス登録キューから予約されていないアイテムを調べて、優先度が最も高い ItemStatus
の最も古いタイムスタンプを持つアイテムから順に、セットを予約済みとしてマークします。優先順位は次のとおりです。
アイテムを予約することで、他のスレッドからポーリングしても重複するセットが作成されることがなくなります。
予約済みアイテムを処理した後、クライアントは index,
を呼び出すか、REQUEUE.
型で push
を呼び出すことによって、アイテムを予約解除状態に戻す必要があります。
アイテムは、update メソッドや push メソッドが呼び出されない場合でも、4 時間後に自動的に利用可能(予約解除)になります。
この API を実行するには、管理者またはサービス アカウントが必要です。使用されるサービス アカウントは、対応するデータソースの許可リストに登録されているアカウントである。
HTTP リクエスト
POST https://cloudsearch.googleapis.com/v1/indexing/{name=datasources/*}/items:poll
この URL は gRPC Transcoding 構文を使用します。
パスパラメータ
パラメータ | |
---|---|
name |
アイテムをポーリングするデータソースの名前。形式: datasources/{sourceId} |
リクエスト本文
リクエストの本文には、次の構造のデータが含まれます。
JSON 表現 |
---|
{ "connectorName": string, "statusCodes": [ enum ( |
フィールド | |
---|---|
connectorName |
この呼び出しを行うコネクタの名前。 形式: datasources/{sourceId}/connectors/{ID} |
statusCodes[] |
ポーリングされるアイテムを次のステータスを持つアイテムに限定します。 |
limit |
返されるアイテムの最大数。 最大値は 100、デフォルト値は 20 です。 |
queue |
アイテムを取得するキュー名。指定しない場合、items.poll は「default」キューから取得されます。最大で 100 文字です。 |
debugOptions |
一般的なデバッグ オプション。 |
レスポンスの本文
成功すると、レスポンスの本文に次の構造のデータが含まれます。
JSON 表現 |
---|
{
"items": [
{
object ( |
フィールド | |
---|---|
items[] |
コネクタが処理できるキューのアイテムのセット。 これらの項目には、次のフィールドのサブセットが入力されています。 |
認可スコープ
次の OAuth スコープのいずれかが必要です。
https://www.googleapis.com/auth/cloud_search.indexing
https://www.googleapis.com/auth/cloud_search
詳細については、承認ガイドをご覧ください。