Method: indexing.datasources.items.poll

Esegue il polling degli elementi non riservati dalla coda di indicizzazione e contrassegna un insieme come riservato, a partire dagli elementi con il timestamp più antico della priorità più alta ItemStatus. L'ordine di priorità è il seguente:

ERROR

MODIFIED

NEW_ITEM

ACCEPTED

La prenotazione degli elementi assicura che il polling da altri thread non possa creare insiemi sovrapposti.

Dopo aver gestito gli elementi riservati, il cliente deve ripristinare lo stato non riservato chiamando index, o push con il tipo REQUEUE.

Gli articoli diventano disponibili automaticamente (senza prenotazione) dopo 4 ore anche se non viene chiamato alcun metodo di aggiornamento o push.

Per l'esecuzione di questa API è necessario un account amministratore o un account di servizio. L'account di servizio utilizzato è quello inserito nella lista consentita nell'origine dati corrispondente.

Richiesta HTTP

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

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri del percorso

Parametri
name

string

Il nome dell'origine dati da cui eseguire il polling degli elementi. Formato: datasources/{sourceId}

Corpo della richiesta

Il corpo della richiesta contiene dati con la seguente struttura:

Rappresentazione JSON 
{
  "connectorName": string,
  "statusCodes": [
    enum (ItemStatus.Code)
  ],
  "limit": integer,
  "queue": string,
  "debugOptions": {
    object (DebugOptions)
  }
}
Campi
connectorName

string

Il nome del connettore che effettua questa chiamata.

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

enum (ItemStatus.Code)

Limita gli elementi sottoposti a polling a quelli con questi stati.
limit

integer

Il numero massimo di elementi da restituire.

Il valore massimo è 100 e il valore predefinito è 20.
queue

string

Nome della coda da cui recuperare gli elementi. Se non specificato, items.poll eseguirà il recupero dalla coda "predefinita". La lunghezza massima è di 100 caratteri.
debugOptions

object (DebugOptions)

Opzioni di debug comuni.

Corpo della risposta

In caso di esito positivo, il corpo della risposta contiene dati con la seguente struttura:

Rappresentazione JSON 
{
  "items": [
    {
      object (Item)
    }
  ]
}
Campi
items[]

object (Item)

Set di elementi della coda disponibili per l'elaborazione da parte del connettore.

Per questi elementi è stato compilato il seguente sottoinsieme di campi:

version

metadata.hash

structuredData.hash

content.hash

payload

status

queue

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

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

Per ulteriori informazioni, consulta la Guida all'autorizzazione.