Method: indexing.datasources.items.push

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

Cette API nécessite un administrateur ou un compte de service pour s'exécuter. 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/{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 la classe item à transmettre à la file d'attente d'indexation.

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

Ce champ est obligatoire. Ne doit pas dépasser 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 la transmission.

item.metadataHash

string

Hachage de métadonnées de l'élément en fonction du dépôt. Si elle est spécifiée, elle permet de déterminer l'état à modifier de cet élément. La définition de ce champ et du champ type entraîne une erreur d'argument. Ne doit pas dépasser 2 048 caractères

item.structuredDataHash

string

Hachage de données structurées de l'élément en fonction du dépôt. Si elle est spécifiée, elle permet de déterminer l'état à modifier de cet élément. La définition de ce champ et du champ type entraîne une erreur d'argument. Ne doit pas dépasser 2 048 caractères

item.contentHash

string

Hachage de contenu de l'élément en fonction du dépôt. Si elle est spécifiée, elle permet de déterminer l'état à modifier de cet élément. La définition de ce champ et du champ type entraîne une erreur d'argument. Ne doit pas dépasser 2 048 caractères

item.payload

string (bytes format)

Fournit des informations supplémentaires sur l'état du document, par exemple un autre ID de dépôt 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 de cet élément. Si ce champ n'est pas spécifié, la file d'attente default est choisie. Ne doit pas dépasser 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 sont affichées dans la console d'administration. Ce champ ne peut être renseigné que si la valeur de type est REPOSITORY_ERROR.

connectorName

string

Nom du connecteur qui effectue cet appel.

Format: datasources/{source_id}/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 la Présentation d'OAuth 2.0.

Poussée

Représente un élément à transmettre à 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 la classe item à transmettre à la file d'attente d'indexation.

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

Ce champ est obligatoire. Ne doit pas dépasser 1 536 caractères

type

enum (PushItem.Type)

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

metadataHash

string

Hachage de métadonnées de l'élément en fonction du dépôt. Si elle est spécifiée, elle permet de déterminer l'état à modifier de cet élément. La définition de ce champ et du champ type entraîne une erreur d'argument. Ne doit pas dépasser 2 048 caractères

structuredDataHash

string

Hachage de données structurées de l'élément en fonction du dépôt. Si elle est spécifiée, elle permet de déterminer l'état à modifier de cet élément. La définition de ce champ et du champ type entraîne une erreur d'argument. Ne doit pas dépasser 2 048 caractères

contentHash

string

Hachage de contenu de l'élément en fonction du dépôt. Si elle est spécifiée, elle permet de déterminer l'état à modifier de cet élément. La définition de ce champ et du champ type entraîne une erreur d'argument. Ne doit pas dépasser 2 048 caractères

payload

string (bytes format)

Fournit des informations supplémentaires sur l'état du document, par exemple un autre ID de dépôt 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 de cet élément. Si ce champ n'est pas spécifié, la file d'attente default est choisie. Ne doit pas dépasser 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 sont affichées dans la console d'administration. Ce champ ne peut être renseigné que si la valeur de type est REPOSITORY_ERROR.

Type d'élément push

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

Enums
UNSPECIFIED Valeur par défaut UNSPECIFIED. 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 l'appel update précédent. Cet état passe à l'état MODIFIED pour un élément existant. Si cette méthode est appelée sur un élément qui n'existe pas, l'état passe à NEW_ITEM.
NOT_MODIFIED L'élément du dépôt n'a pas été modifié depuis la dernière mise à jour. Cette opération push définira l'état sur ACCEPTED.
REPOSITORY_ERROR Le connecteur rencontre une erreur de dépôt concernant cet élément. Utiliser l'état REPOSITORY_ERROR L'élément est non réservé et reprogrammé à une date ultérieure et déterminé par un intervalle exponentiel entre les tentatives.
REQUEUE Appelez le mode Push avec REQUEUE uniquement pour les éléments qui ont été réservés. Cette action annule la réservation de l'élément et rétablit l'heure disponible sur l'horloge murale.