Method: indexing.datasources.items.poll

Sondea los elementos no reservados de la cola de indexación y marca un conjunto como reservado, comenzando con los elementos que tienen la marca de tiempo más antigua de la ItemStatus de mayor prioridad. El orden de prioridad es el siguiente:

ERROR

MODIFIED

NEW_ITEM

ACCEPTED

La reserva de elementos garantiza que el sondeo de otros subprocesos no pueda crear conjuntos superpuestos.

Después de controlar los elementos reservados, el cliente debe volver a colocar los elementos en el estado no reservado, ya sea llamando a index, o llamando a push con el tipo REQUEUE..

Los elementos estarán disponibles automáticamente (sin reservar) después de 4 horas, incluso si no se llama a un método de actualización o envío.

Para ejecutar esta API, se requiere una cuenta de administrador o de servicio. La cuenta de servicio que se usa es la que está incluida en la lista blanca de la fuente de datos correspondiente.

Solicitud HTTP

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

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de ruta de acceso

Parámetros
name

string

El nombre de la fuente de datos para sondear los elementos. Formato: fuentes de datos/{sourceId}

Cuerpo de la solicitud

El cuerpo de la solicitud contiene datos con la siguiente estructura:

Representación JSON 
{
  "connectorName": string,
  "statusCodes": [
    enum (ItemStatus.Code)
  ],
  "limit": integer,
  "queue": string,
  "debugOptions": {
    object (DebugOptions)
  }
}
Campos
connectorName

string

El nombre del conector que realiza esta llamada.

Formato: fuentes de datos/{sourceId}/connectors/{ID}
statusCodes[]

enum (ItemStatus.Code)

Limita los elementos sondeados a los que tienen estos estados.
limit

integer

Cantidad máxima de elementos que se mostrarán.

El valor máximo es 100 y el valor predeterminado es 20.
queue

string

Nombre de la cola desde la que se recuperarán los elementos. Si no se especifica, items.poll se recuperará de “default” en la fila. La longitud máxima es de 100 caracteres.
debugOptions

object (DebugOptions)

Opciones de depuración comunes.

Cuerpo de la respuesta

Si el proceso es satisfactorio, el cuerpo de la respuesta contiene datos con la siguiente estructura:

Representación JSON 
{
  "items": [
    {
      object (Item)
    }
  ]
}
Campos
items[]

object (Item)

Conjunto de elementos de la cola disponibles para que el conector los procese.

Estos elementos tienen el siguiente subconjunto de campos propagado:

version

metadata.hash

structuredData.hash

content.hash

payload

status

queue

Alcances de la autorización

Se necesita uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta la Guía de autorización.