Method: indexing.datasources.items.push

Place un élément dans une file d'attente pour l'interroger et le mettre à jour plus tard.

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/{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'item à insérer dans 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 de l'opération push qui définit le comportement push.
item.metadataHash

string

Hachage des métadonnées de l'élément selon le référentiel. Si spécifié, permet de déterminer comment modifier l'état de cet élément. Définir ce champ et le 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 selon le dépôt. Si spécifié, permet de déterminer comment modifier l'état de cet élément. Définir ce champ et le 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 selon le dépôt. Si spécifié, permet de déterminer comment modifier l'état de cet élément. Définir ce champ et le 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 du document pour le connecteur, telles qu'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 à laquelle cet élément appartient. La file d'attente default est choisie si ce champ n'est pas spécifié. La longueur ne doit pas dépasser 512 caractères.
item.repositoryError

object (RepositoryError)

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

string

Nom du connecteur effectuant 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 d'autorisation.

PushItem

Représente un élément à ajouter à la file 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'item à insérer dans 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 de l'opération push qui définit le comportement push.
metadataHash

string

Hachage des métadonnées de l'élément selon le dépôt. Si spécifié, permet de déterminer comment modifier l'état de cet élément. Définir ce champ et le 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 selon le dépôt. Si spécifié, permet de déterminer comment modifier l'état de cet élément. Définir ce champ et le 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 selon le dépôt. Si spécifié, permet de déterminer comment modifier l'état de cet élément. Définir ce champ et le 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 du document pour le connecteur, telles qu'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 à laquelle cet élément appartient. La file d'attente default est choisie si ce champ n'est pas spécifié. La longueur ne doit pas dépasser 512 caractères.
repositoryError

object (RepositoryError)

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

PushItem.Type

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

Enums
UNSPECIFIED La valeur par défaut est "NON SPÉCIFIÉ". Indique que l'opération de transfert 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. L'état de l'élément existant passe à MODIFIED. Si cette méthode est appelée sur un élément inexistant, l'état passe à 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 de transfert définira l'état sur ACCEPTED.
REPOSITORY_ERROR Le connecteur rencontre une erreur de dépôt concernant cet élément. Définissez l'état sur REPOSITORY_ERROR. L'élément est libéré et reprogrammé à une date ultérieure déterminée par un délai exponentiel.
REQUEUE Utilisez le push d'appel 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 son heure de disponibilité sur l'heure de l'horloge.