Method: indexing.datasources.items.poll

Sondaggio per gli elementi non prenotati dalla coda di indicizzazione e contrassegna un insieme come prenotato, iniziando dagli elementi con il timestamp meno recente e con la priorità più alta ItemStatus. L'ordine di priorità è il seguente:

ERROR

MODIFIED

NEW_ITEM

ACCEPTED

La prenotazione degli elementi garantisce che il polling di altri thread non possa creare insiemi sovrapposti.

Dopo aver gestito gli elementi prenotati, il client deve riportarli allo stato Non prenotato, chiamando index, o chiamando push con il tipo REQUEUE.

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

L'esecuzione di questa API richiede un account amministratore o di servizio. L'account di servizio utilizzato è quello consentito 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 per 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 la chiamata.

Formato: datasources/{sourceId}/connectors/{ID}

statusCodes[]

enum (ItemStatus.Code)

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

limit

integer

Numero massimo di articoli da restituire.

Il valore massimo è 100, mentre il valore predefinito è 20.

queue

string

Nome coda da cui recuperare gli elementi. Se non specificato, items.poll recupererà da "default" in coda. 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)

Insieme di elementi della coda disponibili per l'elaborazione del connettore.

Per questi elementi sono stati compilati i seguenti sottoinsiemi 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.