从编入索引队列中轮询未预订的项,并将一组项标记为已预订,从优先级最高且时间戳最早的项 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 将从“default”队列中提取。长度上限为 100 个字符。 |
debugOptions |
常用调试选项。 |
响应正文
如果成功,响应正文将包含结构如下的数据:
JSON 表示法 |
---|
{
"items": [
{
object ( |
字段 | |
---|---|
items[] |
队列中可供连接器处理的一组项。 系统会为这些项填充以下部分字段: |
授权范围
需要以下 OAuth 范围之一:
https://www.googleapis.com/auth/cloud_search.indexing
https://www.googleapis.com/auth/cloud_search
如需了解详情,请参阅授权指南。