Method: indexing.datasources.items.poll

Realiza sondeos para elementos sin reservar de la cola de indexación y marca un conjunto como reservado, comenzando por los elementos que tienen la marca de tiempo más antigua de la ItemStatus de prioridad más alta. El orden de prioridad es el siguiente:

ERROR

MODIFIED

NEW_ITEM

ACCEPTED

La reserva de elementos garantiza que la consulta de otros subprocesos no pueda crear conjuntos superpuestos.

Después de controlar los elementos reservados, el cliente debe volver a colocarlos en el estado no reservado, ya sea llamando a index, o 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 ningún método de actualización o push.

Esta API requiere una cuenta de administrador o de servicio para ejecutarse. La cuenta de servicio que se usa es la que se incluye en la lista de entidades permitidas 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

Es el nombre de la fuente de datos para consultar los elementos. Formato: datasources/{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

Es el nombre del conector que realiza esta llamada.

Formato: datasources/{sourceId}/connectors/{ID}
statusCodes[]

enum (ItemStatus.Code)

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

integer

Es la cantidad máxima de elementos que se mostrarán.

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

string

Es el nombre de la fila desde la que se recuperarán los elementos. Si no se especifica, items.poll recuperará datos de la cola "default". 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)

Es un conjunto de elementos de la fila disponibles para que el conector los procese.

Estos elementos tienen propagado el siguiente subconjunto de campos:

version

metadata.hash

structuredData.hash

content.hash

payload

status

queue

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