Method: indexing.datasources.items.push

Ajoute un élément à une file d'attente pour une interrogation et une mise à jour ultérieures.

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/{item.name=datasources/*/items/*}:push

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
item.name

string

Nom de l'élément item à ajouter à la file d'attente d'indexation.

Format: datasources/{sourceId}/items/{ID}

Ce champ est obligatoire. La longueur maximale est de 1 536 caractères.

Corps de la requête

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

Représentation JSON 
{
  "item": {
    "name": string,
    "type": enum (PushItem.Type),
    "metadataHash": string,
    "structuredDataHash": string,
    "contentHash": string,
    "payload": string,
    "queue": string,
    "repositoryError": {
      "type": enum (RepositoryError.Type),
      "httpStatusCode": integer,
      "errorMessage": string
    }
  },
  "connectorName": string,
  "debugOptions": {
    object (DebugOptions)
  }
}
Champs
item.type

enum (PushItem.Type)

Type d'opération push qui définit le comportement de transmission.
item.metadataHash

string

Hachage des métadonnées de l'élément en fonction du dépôt. Si spécifié, sert à déterminer comment modifier l'état de cet élément. La définition de ce champ et du champ type entraîne une erreur d'argument. La longueur maximale est de 2 048 caractères.
item.structuredDataHash

string

Hachage des données structurées de l'élément en fonction du dépôt. Si spécifié, sert à déterminer comment modifier l'état de cet élément. La définition de ce champ et du champ type entraîne une erreur d'argument. La longueur maximale est de 2 048 caractères.
item.contentHash

string

Hachage du contenu de l'élément en fonction du dépôt. Si spécifié, sert à déterminer comment modifier l'état de cet élément. La définition de ce champ et du champ type entraîne une erreur d'argument. La longueur maximale est de 2 048 caractères.
item.payload

string (bytes format)

Fournit des informations supplémentaires sur l'état des documents pour le connecteur, telles qu'un autre ID de référentiel et d'autres métadonnées. La longueur maximale est de 8 192 octets.

Chaîne encodée en base64.
item.queue

string

File d'attente à laquelle appartient cet élément. La file d'attente default est choisie si ce champ n'est pas spécifié. La longueur maximale est de 512 caractères.
item.repositoryError

object (RepositoryError)

Renseignez ce champ pour stocker les détails des erreurs liées au connecteur ou au dépôt. Ces informations s'affichent dans la console d'administration. Ce champ ne peut être renseigné que si type est défini sur REPOSITORY_ERROR.
connectorName

string

Nom du connecteur qui effectue cet appel.

Format: datasources/{sourceId}/connectors/{ID}
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 une instance de Item.

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.

PushItem

Représente un élément à ajouter à la file d'attente d'indexation.

Représentation JSON 
{
  "name": string,
  "type": enum (PushItem.Type),
  "metadataHash": string,
  "structuredDataHash": string,
  "contentHash": string,
  "payload": string,
  "queue": string,
  "repositoryError": {
    object (RepositoryError)
  }
}
Champs
name

string

Nom de l'élément item à ajouter à la file d'attente d'indexation.

Format: datasources/{sourceId}/items/{ID}

Ce champ est obligatoire. La longueur maximale est de 1 536 caractères.
type

enum (PushItem.Type)

Type d'opération push qui définit le comportement de transmission.
metadataHash

string

Hachage des métadonnées de l'élément en fonction du dépôt. Si spécifié, sert à déterminer comment modifier l'état de cet élément. La définition de ce champ et du champ type entraîne une erreur d'argument. La longueur maximale est de 2 048 caractères.
structuredDataHash

string

Hachage des données structurées de l'élément en fonction du dépôt. Si spécifié, sert à déterminer comment modifier l'état de cet élément. La définition de ce champ et du champ type entraîne une erreur d'argument. La longueur maximale est de 2 048 caractères.
contentHash

string

Hachage du contenu de l'élément en fonction du dépôt. Si spécifié, sert à déterminer comment modifier l'état de cet élément. La définition de ce champ et du champ type entraîne une erreur d'argument. La longueur maximale est de 2 048 caractères.
payload

string (bytes format)

Fournit des informations supplémentaires sur l'état des documents pour le connecteur, telles qu'un autre ID de référentiel et d'autres métadonnées. La longueur maximale est de 8 192 octets.

Chaîne encodée en base64.
queue

string

File d'attente à laquelle appartient cet élément. La file d'attente default est choisie si ce champ n'est pas spécifié. La longueur maximale est de 512 caractères.
repositoryError

object (RepositoryError)

Renseignez ce champ pour stocker les détails des erreurs liées au connecteur ou au dépôt. Ces informations s'affichent dans la console d'administration. Ce champ ne peut être renseigné que si type est défini sur REPOSITORY_ERROR.

PushItem.Type

Type d'opération push qui définit le comportement de transmission.

Enums
UNSPECIFIED Valeur par défaut NON SPÉCIFIÉE. Indique que l'opération push ne doit pas modifier ItemStatus
MODIFIED Indique que le document du dépôt a été modifié ou mis à jour depuis le dernier appel update. L'état d'un élément existant passe à l'état MODIFIED. Si cette méthode est appelée pour un élément qui n'existe pas, l'état est défini sur NEW_ITEM.
NOT_MODIFIED L'élément du dépôt n'a pas été modifié depuis le dernier appel de mise à jour. Cette opération d'envoi va définir l'état sur ACCEPTED.
REPOSITORY_ERROR Le connecteur rencontre une erreur de référentiel concernant cet élément. Faites passer l'état à l'état REPOSITORY_ERROR. L'élément n'est plus réservé et est reprogrammé à une date ultérieure déterminée par un intervalle exponentiel entre les tentatives.
REQUEUE Appel push avec REQUEUE uniquement pour les éléments qui ont été réservés. Cette action annule la réservation de l'article et rétablit l'heure d'exécution.