針對索引佇列中的未保留項目進行輪詢,並將某項集合標示為保留,從優先順序最高的 ItemStatus
項目開始。優先順序如下:
保留項目可確保透過其他執行緒的輪詢作業不會建立重疊組合。
處理保留項目後,用戶端應透過呼叫 index,
或呼叫類型為 REQUEUE.
的 push
,將項目移回未保留狀態。
即使未呼叫更新或推送方法,項目在 4 小時後也會自動變成可用 (未保留)。
您必須具備管理員或服務帳戶才能執行這個 API。使用的服務帳戶已列入對應資料來源的許可清單。
HTTP 要求
POST https://cloudsearch.googleapis.com/v1/indexing/{name=datasources/*}/items:poll
這個網址使用 gRPC 轉碼語法。
路徑參數
參數 | |
---|---|
name |
輪詢項目的資料來源名稱。格式:datasources/{sourceId} |
要求主體
要求主體的資料會採用以下結構:
JSON 表示法 |
---|
{ "connectorName": string, "statusCodes": [ enum ( |
欄位 | |
---|---|
connectorName |
發出這項呼叫的連接器名稱。 格式:datasources/{sourceId}/connectors/{ID} |
statusCodes[] |
只針對具有這些狀態的項目輪詢項目。 |
limit |
要傳回的項目數上限。 最大值為 100,預設值為 20。 |
queue |
要擷取項目的佇列名稱。如未指定,items.poll 會從「預設」佇列擷取。長度上限為 100 個半形字元。 |
debugOptions |
常見的偵錯選項。 |
回應主體
如果成功,回應主體即會包含具有以下結構的資料:
JSON 表示法 |
---|
{
"items": [
{
object ( |
欄位 | |
---|---|
items[] |
佇列中可供連接器處理的項目集。 這些項目包含下列欄位子集: |
授權範圍
需要下列其中一種 OAuth 範圍:
https://www.googleapis.com/auth/cloud_search.indexing
https://www.googleapis.com/auth/cloud_search
詳情請參閱授權指南。