インデックス キューから未予約のアイテムをポーリングし、最も優先度の高い 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
詳細については、承認ガイドをご覧ください。