Method: indexing.datasources.items.poll

Interroge les éléments non réservés de la file d'attente d'indexation et marque un ensemble comme réservé, en commençant par les éléments dont l'horodatage est le plus ancien et dont la priorité est la plus élevée (ItemStatus). L'ordre de priorité est le suivant:

ERROR

MODIFIED

NEW_ITEM

ACCEPTED

En réservant des éléments, vous vous assurez que les interrogations d'autres threads ne peuvent pas créer d'ensembles qui se chevauchent.

Après avoir traité les éléments réservés, le client doit les remettre à l'état non réservé, soit en appelant index,, soit en appelant push avec le type REQUEUE..

Les éléments deviennent automatiquement disponibles (non réservés) au bout de quatre heures, même si aucune méthode de mise à jour ou push n'est appelée.

L'exécution de cette API nécessite un administrateur ou un compte de service. Le compte de service utilisé est celui qui figure sur la liste blanche de la source de données correspondante.

Requête HTTP

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

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
name

string

Nom de la source de données dans laquelle interroger les éléments. Format: datasources/{sourceId}

Corps de la requête

Le corps de la requête contient des données présentant la structure suivante :

Représentation JSON 
{
  "connectorName": string,
  "statusCodes": [
    enum (ItemStatus.Code)
  ],
  "limit": integer,
  "queue": string,
  "debugOptions": {
    object (DebugOptions)
  }
}
Champs
connectorName

string

Nom du connecteur qui effectue cet appel.

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

enum (ItemStatus.Code)

Limitez les éléments interrogés à ceux ayant ces états.
limit

integer

Nombre maximal d'articles à renvoyer.

La valeur maximale est 100 et la valeur par défaut est 20.
queue

string

Nom de la file d'attente dans laquelle récupérer les éléments. Si aucune valeur n'est spécifiée, items.poll récupérera à partir de "default" file d'attente. La longueur ne doit pas dépasser 100 caractères.
debugOptions

object (DebugOptions)

Options de débogage courantes.

Corps de la réponse

Si la requête aboutit, le corps de la réponse contient des données présentant la structure suivante :

Représentation JSON 
{
  "items": [
    {
      object (Item)
    }
  ]
}
Champs
items[]

object (Item)

Ensemble d'éléments de la file d'attente devant être traités par le connecteur.

Le sous-ensemble de champs suivant est renseigné pour ces éléments:

version

metadata.hash

structuredData.hash

content.hash

payload

status

queue

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

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

Pour en savoir plus, consultez le Guide relatif aux autorisations.