轮询索引队列中的未预留项,并将集标记为预留,从具有最高优先级 ItemStatus
的最早时间戳的项开始。优先级顺序如下:
预留内容可确保对其他线程的轮询不能创建重叠的集。
处理预留的商品后,客户端应通过调用 index,
或调用类型为 REQUEUE.
的 push
,使商品重新回到未预留状态
即使未调用 update 或 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
如需了解详情,请参阅 OAuth 2.0 概览。