Method: indexing.datasources.items.poll

Pesquisa itens não reservados da fila de indexação e marca um conjunto como reservado, começando pelos itens que têm o carimbo de data/hora mais antigo da ItemStatus de prioridade mais alta. A ordem de prioridade é a seguinte:

ERROR

MODIFIED

NEW_ITEM

ACCEPTED

Reservar itens garante que a pesquisa de outras linhas de execução não crie conjuntos sobrepostos.

Depois de processar os itens reservados, o cliente precisa colocar os itens de volta no estado sem reserva, chamando index, ou push com o tipo REQUEUE..

Os itens ficam disponíveis automaticamente (não reservados) após quatro horas, mesmo que nenhum método de atualização ou push seja chamado.

Esta API requer uma conta de administrador ou de serviço para ser executada. A conta de serviço usada está na lista de permissões da fonte de dados correspondente.

Solicitação HTTP

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

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
name

string

O nome da fonte de dados para pesquisar itens. Formato: fontes de dados/{sourceId}

Corpo da solicitação

O corpo da solicitação contém dados com a seguinte estrutura:

Representação JSON 
{
  "connectorName": string,
  "statusCodes": [
    enum (ItemStatus.Code)
  ],
  "limit": integer,
  "queue": string,
  "debugOptions": {
    object (DebugOptions)
  }
}
Campos
connectorName

string

O nome do conector que está fazendo a chamada.

Formato: fontes de dados/{sourceId}/connectors/{ID}
statusCodes[]

enum (ItemStatus.Code)

Limite os itens pesquisados àqueles com estes status.
limit

integer

Número máximo de itens a serem retornados.

O valor máximo é 100, e o padrão é 20.
queue

string

Nome da fila de onde os itens serão buscados. Se não for especificado, items.poll será buscado em "default" fila. O comprimento máximo é de 100 caracteres.
debugOptions

object (DebugOptions)

Opções comuns de depuração.

Corpo da resposta

Se bem-sucedido, o corpo da resposta exibirá os dados com a seguinte estrutura:

Representação JSON 
{
  "items": [
    {
      object (Item)
    }
  ]
}
Campos
items[]

object (Item)

Conjunto de itens da fila disponíveis para o conector processar.

Esses itens têm o seguinte subconjunto de campos preenchidos:

version

metadata.hash

structuredData.hash

content.hash

payload

status

queue

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte o Guia de autorização.