Method: indexing.datasources.items.poll

在索引队列中轮询未预留项，并将一个集标记为预留项，从优先级最高的 ItemStatus 中时间戳最早的项开始。优先级顺序如下：

ERROR

MODIFIED

NEW_ITEM

ACCEPTED

预留项可确保从其他线程进行轮询时不会创建重叠集。

处理预留的商品后，客户端应通过调用 index, 或调用类型为 REQUEUE. 的 push 将商品恢复到未预留状态

即使未调用更新或推送方法，商品也会在 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

有关详情，请参阅授权指南。