Method: indexing.datasources.items.poll

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

ERROR

MODIFIED

NEW_ITEM

ACCEPTED

Réserver des éléments garantit que l'interrogation à partir d'autres threads ne peut pas créer d'ensembles qui se chevauchent.

Après avoir traité les éléments réservés, le client doit les rétablir à 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 de transfert n'est appelée.

Pour s'exécuter, cette API nécessite un compte administrateur ou de service. Le compte de service utilisé est celui ajouté à la liste blanche dans 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 à interroger pour 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 effectuant cet appel.

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

enum (ItemStatus.Code)

Limitez les éléments interrogés à ceux qui présentent ces états.
limit

integer

Nombre maximal d'éléments à renvoyer.

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

string

Nom de la file d'attente à partir de laquelle extraire les éléments. Si cet indicateur n'est pas spécifié, items.poll extrait les données de la file d'attente "par défaut". 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 disponibles pour le traitement par le connecteur.

Le sous-ensemble de champs suivants 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 d'autorisation.