Method: indexing.datasources.items.poll

從索引佇列中輪詢未預訂的項目，並將集合標示為已預訂，從優先順序最高的 ItemStatus 中找出最久的時間戳記的項目開始。優先順序如下：

ERROR

MODIFIED

NEW_ITEM

ACCEPTED

預留項目可確保其他執行緒的輪詢不會建立重疊的集合。

處理保留項目後，用戶端應將項目還原為未保留狀態，方法是呼叫 index,，或呼叫 push 並使用 REQUEUE. 類型

即使未呼叫更新或推送方法，項目也會在 4 小時後自動變為可用 (未保留)。

這個 API 需要管理員或服務帳戶才能執行。系統會使用對應資料來源中已加入白名單的服務帳戶。

HTTP 要求

POST https://cloudsearch.googleapis.com/v1/indexing/{name=datasources/*}/items:poll

這個網址使用 gRPC 轉碼語法。

路徑參數

參數
name

string

要輪詢項目的資料來源名稱。格式：datasources/{sourceId}

要求主體

要求主體的資料會採用以下結構：

JSON 表示法 
{
  "connectorName": string,
  "statusCodes": [
    enum (ItemStatus.Code)
  ],
  "limit": integer,
  "queue": string,
  "debugOptions": {
    object (DebugOptions)
  }
}
欄位
connectorName

string

發出這項呼叫的連接器名稱。

格式：datasources/{sourceId}/connectors/{id}
statusCodes[]

enum (ItemStatus.Code)

將輪詢的項目限制為具有這些狀態的項目。
limit

integer

傳回的項目數量上限。

最大值為 100，預設值為 20。
queue

string

要擷取項目的佇列名稱。如果未指定，items.poll 會從「default」佇列擷取資料。長度上限為 100 個半形字元。
debugOptions

object (DebugOptions)

常見的偵錯選項。

回應主體

如果成功，回應主體即會包含具有以下結構的資料：

JSON 表示法 
{
  "items": [
    {
      object (Item)
    }
  ]
}
欄位
items[]

object (Item)

待處理清單中的項目集合，可供連接器處理。

這些項目會填入下列欄位子集：

version

metadata.hash

structuredData.hash

content.hash

payload

status

queue

授權範圍

需要下列其中一種 OAuth 範圍：

  • https://www.googleapis.com/auth/cloud_search.indexing
  • https://www.googleapis.com/auth/cloud_search

詳情請參閱授權指南。