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/{source_id}

请求正文

请求正文中包含结构如下的数据:

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

string

进行此调用的连接器的名称。

格式:datasources/{source_id}/connectors/{ID}

statusCodes[]

enum (ItemStatus.Code)

将轮询的项限制为处于这些状态的项。

limit

integer

要返回的商品数量上限。

最大值为 100,默认值为 20。

queue

string

要从中提取项目的队列名称。如果未指定,items.poll 将从默认队列中提取。长度上限为 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

有关详情,请参阅 OAuth 2.0 概览