Method: indexing.datasources.items.poll

Pesquisa itens não reservados na fila de indexação e marca um conjunto como reservado, começando com itens que têm o carimbo de data/hora mais antigo do 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 não reservado chamando index, ou push com o tipo REQUEUE.

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

Essa API requer um administrador ou uma conta de serviço para ser executada. A conta de serviço usada é a que está na lista de permissões na 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 os itens da enquete. Formato: datasources/{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: datasources/{sourceId}/connectors/{ID}

statusCodes[]

enum (ItemStatus.Code)

Limite os itens pesquisados aos que têm esses status.

limit

integer

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

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

queue

string

Nome da fila para buscar itens. Se não for especificado, items.poll será buscado na fila "padrão". O comprimento máximo é de 100 caracteres.

debugOptions

object (DebugOptions)

Opções de depuração comuns.

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 processamento pelo conector.

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 de 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.