Créer un connecteur de contenu

Un connecteur de contenu est un logiciel permettant de balayer les données d'un dépôt d'entreprise et de les insérer dans une source de données. Google propose les options suivantes pour développer des connecteurs de contenu:

  • SDK Content Connector C'est une bonne option si vous programmez en Java. Le SDK Content Connector est un wrapper pour l'API REST qui vous permet de créer rapidement des connecteurs. Pour créer un connecteur de contenu à l'aide du SDK, consultez l'article Créer un connecteur de contenu à l'aide du SDK Content Connector.

  • Une API REST de bas niveau ou des bibliothèques d'API. Utilisez ces options si vous ne programmez pas en Java, ou si votre codebase est mieux adapté à une API REST ou à une bibliothèque. Pour créer un connecteur de contenu avec l'API REST, consultez l'article Créer un connecteur de contenu à l'aide de l'API REST.

Un connecteur de contenu standard effectue les tâches suivantes:

  1. Lit et traite les paramètres de configuration.
  2. Extrait des fragments distincts de données indexables, appelés éléments, à partir du dépôt de contenu tiers.
  3. Combine les LCA, les métadonnées et les données de contenu dans des éléments indexables.
  4. Indexe des éléments dans la source de données Cloud Search.
  5. (Facultatif) Écoute les notifications de modification du dépôt de contenu tiers. Les notifications de modification sont converties en requêtes d'indexation afin que la source de données Cloud Search reste synchronisée avec le dépôt tiers. Le connecteur n'effectue cette tâche que si le dépôt accepte la détection des modifications.

Créer un connecteur de contenu à l'aide du SDK Content Connector

Les sections suivantes expliquent comment créer un connecteur de contenu à l'aide du SDK Content Connector.

Configurer des dépendances

Vous devez inclure certaines dépendances dans votre fichier de compilation pour utiliser le SDK. Cliquez sur un onglet ci-dessous pour afficher les dépendances de votre environnement de compilation:

Maven

<dependency>
<groupId>com.google.enterprise.cloudsearch</groupId>
<artifactId>google-cloudsearch-indexing-connector-sdk</artifactId>
<version>v1-0.0.3</version>
</dependency>

Gradle

compile group: 'com.google.enterprise.cloudsearch',
        name: 'google-cloudsearch-indexing-connector-sdk',
        version: 'v1-0.0.3'

Créer votre configuration de connecteur

Chaque connecteur dispose d'un fichier de configuration contenant les paramètres qu'il utilise, tels que l'ID de votre dépôt. Les paramètres sont définis sous forme de paires clé/valeur (par exemple, api.sourceId=1234567890abcdef).

Le SDK Google Cloud Search contient plusieurs paramètres de configuration fournis par Google qui sont utilisés par tous les connecteurs. Vous devez déclarer les paramètres suivants, fournis par Google, dans votre fichier de configuration:

  • Pour un connecteur de contenu, vous devez déclarer api.sourceId et api.serviceAccountPrivateKeyFile, car ces paramètres identifient l'emplacement du dépôt et de la clé privée nécessaires pour y accéder.
  • Pour un connecteur d'identité, vous devez déclarer api.identitySourceId, car ce paramètre identifie l'emplacement de votre source d'identité externe. Si vous synchronisez les utilisateurs, vous devez également déclarer api.customerId comme ID unique du compte Google Workspace de votre entreprise.

À moins que vous ne souhaitiez remplacer les valeurs par défaut d'autres paramètres fournis par Google, vous n'avez pas besoin de les déclarer dans votre fichier de configuration. Pour en savoir plus sur les paramètres de configuration fournis par Google, tels que la génération de certains ID et de certaines clés, consultez la section Paramètres de configuration fournis par Google.

Vous pouvez également définir des paramètres spécifiques au dépôt à utiliser dans votre fichier de configuration.

Transmettre le fichier de configuration au connecteur

Définissez la propriété système config pour transmettre le fichier de configuration à votre connecteur. Vous pouvez définir cette propriété à l'aide de l'argument -D lors du démarrage du connecteur. Par exemple, la commande suivante permet de démarrer le connecteur avec le fichier de configuration MyConfig.properties:

java -classpath myconnector.jar;... -Dconfig=MyConfig.properties MyConnector

Si cet argument est manquant, le SDK tente d'accéder à un fichier de configuration par défaut nommé connector-config.properties.

Déterminer votre stratégie de balayage

La fonction principale d'un connecteur de contenu est de balayer un dépôt et d'en indexer les données. Vous devez mettre en œuvre une stratégie de balayage en fonction de la taille et de la disposition des données dans votre dépôt. Vous pouvez concevoir votre propre stratégie ou choisir parmi les stratégies suivantes, mises en œuvre dans le SDK:

Stratégie de balayage complet

La stratégie de balayage complet consiste à analyser l'intégralité du dépôt et à indexer chaque élément de façon aveugle. Cette stratégie est couramment utilisée lorsque vous disposez d'un petit dépôt et que vous pouvez vous permettre d'effectuer un balayage complet à chaque indexation.

Cette stratégie de balayage est adaptée aux petits dépôts contenant des données principalement statiques et non hiérarchiques. Vous pouvez également utiliser cette stratégie de balayage lorsque la détection des modifications est difficile ou incompatible avec le dépôt.

Stratégie de balayage de liste

Une stratégie de balayage de liste permet d'analyser l'ensemble du dépôt, y compris tous les nœuds enfants, pour déterminer l'état de chaque élément. Ensuite, lors d'une seconde passe, le connecteur n'indexe que les éléments nouveaux ou qui ont été mis à jour depuis la dernière indexation. Cette stratégie est couramment utilisée pour effectuer des mises à jour incrémentielles sur un index existant (au lieu d'avoir à effectuer un balayage complet à chaque mise à jour de l'index).

Cette stratégie de balayage convient lorsque la détection des modifications est difficile ou non compatible avec le dépôt, que vous disposez de données non hiérarchiques et que vous travaillez avec de très grands ensembles de données.

Balayage de graphe

Une stratégie de balayage de graphe analyse l'ensemble du nœud parent pour déterminer l'état de chaque élément. Ensuite, lors d'une seconde passe, le connecteur n'indexe que les éléments du nœud racine nouveaux ou ayant été mis à jour depuis la dernière indexation. Enfin, le connecteur transmet tous les ID enfants, puis indexe les éléments des nœuds enfants qui sont nouveaux ou qui ont été mis à jour. Il continue de passer par tous les nœuds enfants de manière récursive jusqu'à ce que tous les éléments soient traités. Ce type de balayage est généralement utilisé pour les dépôts hiérarchiques dans lesquels il n'est pas pratique de lister tous les ID.

Cette stratégie convient si vous devez explorer des données hiérarchiques telles qu'une série de répertoires ou de pages Web.

Chacune de ces stratégies de balayage est mise en œuvre par un modèle de classe de connecteur dans le SDK. Bien que vous puissiez mettre en œuvre votre propre stratégie de balayage, ces modèles accélèrent considérablement le développement de votre connecteur. Pour créer un connecteur à partir d'un modèle, accédez à la section correspondant à votre stratégie de balayage:

Créer un connecteur de balayage complet à partir d'un modèle de classe

Cette section fait référence aux extraits de code de l'exemple FullTraversalSample.

Implémenter le point d'entrée du connecteur

Le point d'entrée d'un connecteur est la méthode main(). La tâche principale de cette méthode consiste à créer une instance de la classe Application et à appeler sa méthode start() pour exécuter le connecteur.

Avant d'appeler application.start(), utilisez la classe IndexingApplication.Builder pour instancier le modèle FullTraversalConnector. Le modèle FullTraversalConnector accepte un objet Repository dont vous implémentez les méthodes. L'extrait de code suivant montre comment mettre en œuvre la méthode main():

FullTraversalSample.java
/**
 * This sample connector uses the Cloud Search SDK template class for a full
 * traversal connector.
 *
 * @param args program command line arguments
 * @throws InterruptedException thrown if an abort is issued during initialization
 */
public static void main(String[] args) throws InterruptedException {
  Repository repository = new SampleRepository();
  IndexingConnector connector = new FullTraversalConnector(repository);
  IndexingApplication application = new IndexingApplication.Builder(connector, args).build();
  application.start();
}

En arrière-plan, le SDK appelle la méthode initConfig() après que la méthode main() de votre connecteur a appelé Application.build. La méthode initConfig() effectue les tâches suivantes:

  1. Appelle la méthode Configuation.isInitialized() pour s'assurer que l'objet Configuration n'a pas été initialisé.
  2. Initialise un objet Configuration avec les paires clé/valeur fournies par Google. Chaque paire clé-valeur est stockée dans un objet ConfigValue au sein de l'objet Configuration.

Implémenter l'interface Repository

L'objet Repository n'a qu'une fonction, qui consiste à balayer les éléments du dépôt et à les indexer. Lorsque vous utilisez un modèle, il vous suffit de remplacer certaines méthodes dans l'interface Repository pour créer un connecteur de contenu. Ces méthodes dépendent du modèle et de la stratégie de balayage que vous utilisez. Pour le modèle FullTraversalConnector, par exemple, vous devez remplacer les méthodes suivantes:

  • La méthode init(). Pour configurer et initialiser un dépôt de données, remplacez la méthode init().

  • La méthode getAllDocs(). Pour balayer et indexer tous les éléments du dépôt de données, remplacez la méthode getAllDocs(). Cette méthode est appelée une fois pour chaque balayage planifié (tel que défini par votre configuration).

  • (Facultatif) La méthode getChanges(). Si votre dépôt accepte la détection des modifications, remplacez la méthode getChanges(). Cette méthode est appelée une fois pour chaque balayage incrémentiel planifié (tel que défini par votre configuration) afin de récupérer les éléments modifiés et de les indexer.

  • (Facultatif) La méthode close(). Si vous devez nettoyer le dépôt, remplacez la méthode close(). Cette méthode est appelée une seule fois lors de l'arrêt du connecteur.

Chacune des méthodes de l'objet Repository renvoie un objet ApiOperation. Un objet ApiOperation effectue une action sous la forme d'un ou de plusieurs appels IndexingService.indexItem() pour effectuer l'indexation réelle de votre dépôt.

Obtenir des paramètres de configuration personnalisés

Lorsque vous gérez la configuration de votre connecteur, vous devez récupérer les éventuels paramètres personnalisés de l'objet Configuration. Cette tâche est généralement effectuée dans la méthode init() d'une classe Repository.

La classe Configuration comporte plusieurs méthodes permettant d'obtenir différents types de données à partir d'une configuration. Chaque méthode renvoie un objet ConfigValue. Vous allez ensuite utiliser la méthode get() de l'objet ConfigValue pour récupérer la valeur réelle. L'extrait de code suivant, tiré de FullTraversalSample, montre comment récupérer une seule valeur entière personnalisée à partir d'un objet Configuration:

FullTraversalSample.java
@Override
public void init(RepositoryContext context) {
  log.info("Initializing repository");
  numberOfDocuments = Configuration.getInteger("sample.documentCount", 10).get();
}

Pour obtenir et analyser un paramètre contenant plusieurs valeurs, utilisez l'un des analyseurs de type de la classe Configuration afin d'analyser les données par fragments distincts. L'extrait de code suivant (issu du connecteur du tutoriel) permet d'obtenir la liste des noms de dépôts GitHub grâce à la méthode getMultiValue:

GithubRepository.java
ConfigValue<List<String>> repos = Configuration.getMultiValue(
    "github.repos",
    Collections.emptyList(),
    Configuration.STRING_PARSER);

Effectuer un balayage complet

Remplacez getAllDocs() pour effectuer un balayage complet et indexer le dépôt. La méthode getAllDocs() accepte un point de contrôle. Ce point de contrôle permet de reprendre l'indexation à partir d'un élément spécifique si le processus est interrompu. Pour chaque élément de votre dépôt, vous accomplirez les tâches suivantes dans la méthode getAllDocs():

  1. Définissez les autorisations.
  2. Définissez les métadonnées de l'élément que vous indexez.
  3. Combinez les métadonnées et l'élément dans un seul RepositoryDoc indexable.
  4. Empaquetez chaque élément indexable dans un itérateur renvoyé par la méthode getAllDocs(). Notez que getAllDocs() renvoie en fait un CheckpointCloseableIterable, qui est une itération d'objets ApiOperation. Chaque objet représente une requête API effectuée sur un RepositoryDoc, comme son indexation.

Si l'ensemble d'éléments est trop volumineux pour être traité en un seul appel, incluez un point de contrôle et définissez hasMore(true) pour indiquer qu'il existe davantage d'éléments à indexer.

Définir les autorisations pour un élément

Votre dépôt utilise une liste de contrôle d'accès (LCA) pour identifier les utilisateurs ou les groupes ayant accès à un élément. Une LCA est une liste d'ID correspondant aux groupes ou aux utilisateurs ayant accès à l'élément.

Vous devez dupliquer la LCA utilisée par votre dépôt pour vous assurer que seuls les utilisateurs ayant accès à un élément peuvent le voir dans un résultat de recherche. La LCA d'un élément doit être incluse lors de son indexation pour que Google Cloud Search dispose des informations nécessaires pour fournir le niveau d'accès approprié à l'élément.

Le SDK Content Connector fournit un ensemble complet de classes et de méthodes de LCA pour modéliser les LCA de la plupart des dépôts. Vous devez analyser la LCA de chaque élément de votre dépôt et créer une LCA correspondante pour Google Cloud Search lorsque vous indexez un élément. Si la LCA de votre dépôt utilise des concepts tels que l'héritage des LCA, il peut s'avérer délicat de la modéliser. Consultez la section LCA de Google Cloud Search pour en savoir plus sur celles-ci.

Remarque:L'API Cloud Search Indexing accepte les LCA à domaine unique. Il n'est pas compatible avec les LCA interdomaines. Utilisez la classe Acl.Builder pour définir l'accès à chaque élément à l'aide d'une LCA. L'extrait de code suivant, issu de l'exemple de balayage complet, permet à tous les utilisateurs ou "comptes principaux" (getCustomerPrincipal()) d'être des "lecteurs" de tous les éléments (.setReaders()) lors d'une recherche.

FullTraversalSample.java
// Make the document publicly readable within the domain
Acl acl = new Acl.Builder()
    .setReaders(Collections.singletonList(Acl.getCustomerPrincipal()))
    .build();

Vous devez comprendre les LCA afin de les modéliser correctement pour le dépôt. Il se peut, par exemple, que vous indexiez des fichiers dans un système de fichiers utilisant un modèle d'héritage, dans lequel les dossiers enfants héritent des autorisations des dossiers parents. La modélisation du mécanisme d'héritage des LCA nécessite des informations supplémentaires. Pour en savoir plus, consultez la section LCA de Google Cloud Search.

Définir les métadonnées d'un élément

Les métadonnées sont stockées dans un objet Item. Pour créer une Item, vous devez disposer au minimum d'un ID de chaîne unique, d'un type d'élément, d'une LCA, d'une URL et d'une version de l'élément. L'extrait de code suivant montre comment créer un Item à l'aide de la classe d'assistance IndexingItemBuilder.

FullTraversalSample.java
// Url is required. Use google.com as a placeholder for this sample.
String viewUrl = "https://www.google.com";

// Version is required, set to current timestamp.
byte[] version = Longs.toByteArray(System.currentTimeMillis());

// Using the SDK item builder class to create the document with appropriate attributes
// (this can be expanded to include metadata fields etc.)
Item item = IndexingItemBuilder.fromConfiguration(Integer.toString(id))
    .setItemType(IndexingItemBuilder.ItemType.CONTENT_ITEM)
    .setAcl(acl)
    .setSourceRepositoryUrl(IndexingItemBuilder.FieldOrValue.withValue(viewUrl))
    .setVersion(version)
    .build();

Créer l'élément indexable

Après avoir défini les métadonnées de l'élément, vous pouvez créer l'élément indexable avec la classe RepositoryDoc.Builder. L'exemple suivant montre comment créer un seul élément indexable.

FullTraversalSample.java
// For this sample, content is just plain text
String content = String.format("Hello world from sample doc %d", id);
ByteArrayContent byteContent = ByteArrayContent.fromString("text/plain", content);

// Create the fully formed document
RepositoryDoc doc = new RepositoryDoc.Builder()
    .setItem(item)
    .setContent(byteContent, IndexingService.ContentFormat.TEXT)
    .build();

Un RepositoryDoc est un type de ApiOperation qui exécute la requête IndexingService.indexItem() réelle.

Vous pouvez également utiliser la méthode setRequestMode() de la classe RepositoryDoc.Builder pour identifier la requête d'indexation comme ASYNCHRONOUS ou SYNCHRONOUS:

ASYNCHRONOUS
Le mode asynchrone augmente la latence entre l'indexation et la diffusion des éléments, tout en prenant en charge des quotas de débit importants pour les requêtes d'indexation. Le mode asynchrone est recommandé pour l'indexation initiale (le remplissage) de l'ensemble du dépôt.
SYNCHRONOUS
Le mode synchrone réduit la latence entre l'indexation et la diffusion des éléments et prend en charge un quota de débit limité. Le mode synchrone est recommandé pour l'indexation des mises à jour et des modifications apportées au dépôt. S'il n'est pas spécifié, le mode de requête par défaut est SYNCHRONOUS.

Empaqueter chaque élément indexable dans un itérateur

La méthode getAllDocs() renvoie un Iterator (plus précisément un CheckpointCloseableIterable) d'objets RepositoryDoc. Vous pouvez utiliser la classe CheckpointClosableIterableImpl.Builder pour construire et renvoyer un itérateur. L'extrait de code suivant montre comment créer et renvoyer un itérateur.

FullTraversalSample.java
CheckpointCloseableIterable<ApiOperation> iterator =
  new CheckpointCloseableIterableImpl.Builder<>(allDocs).build();

Le SDK exécute chaque appel d'indexation inclus dans l'itérateur.

Étapes suivantes

Voici quelques étapes que vous pouvez également suivre :

Créer un connecteur de balayage de liste à l'aide d'un modèle de classe

La file d'attente d'indexation Cloud Search permet de conserver l'ID et les valeurs de hachage facultatives de chaque élément du dépôt. Un connecteur de balayage de liste place les ID d'élément dans la file d'attente d'indexation Google Cloud Search, puis les récupère un par un pour les indexer. Google Cloud Search gère les files d'attente et compare leur contenu pour déterminer l'état des éléments (par exemple, s'ils ont été supprimés du dépôt). Pour en savoir plus sur la file d'attente d'indexation Cloud Search, consultez l'article File d'attente d'indexation Cloud Search.

Cette section fait référence aux extraits de code de l'exemple ListTraversalSample.

Implémenter le point d'entrée du connecteur

Le point d'entrée d'un connecteur est la méthode main(). La tâche principale de cette méthode consiste à créer une instance de la classe Application et à appeler sa méthode start() pour exécuter le connecteur.

Avant d'appeler application.start(), utilisez la classe IndexingApplication.Builder pour instancier le modèle ListingConnector. ListingConnector accepte un objet Repository dont vous implémentez les méthodes. L'extrait de code suivant montre comment instancier ListingConnector et son Repository associé:

ListTraversalSample.java
/**
 * This sample connector uses the Cloud Search SDK template class for a
 * list traversal connector.
 *
 * @param args program command line arguments
 * @throws InterruptedException thrown if an abort is issued during initialization
 */
public static void main(String[] args) throws InterruptedException {
  Repository repository = new SampleRepository();
  IndexingConnector connector = new ListingConnector(repository);
  IndexingApplication application = new IndexingApplication.Builder(connector, args).build();
  application.start();
}

En arrière-plan, le SDK appelle la méthode initConfig() après que la méthode main() de votre connecteur a appelé Application.build. La méthode initConfig():

  1. Appelle la méthode Configuation.isInitialized() pour s'assurer que l'objet Configuration n'a pas été initialisé.
  2. Initialise un objet Configuration avec les paires clé/valeur fournies par Google. Chaque paire clé-valeur est stockée dans un objet ConfigValue au sein de l'objet Configuration.

Implémenter l'interface Repository

L'objet Repository n'a qu'une fonction, qui consiste à balayer les éléments du dépôt et à les indexer. Lorsque vous utilisez un modèle, il vous suffit de remplacer certaines méthodes dans l'interface Repository pour créer un connecteur de contenu. Les méthodes à remplacer dépendent du modèle et de la stratégie de balayage que vous utilisez. Pour le modèle ListingConnector, par exemple, vous devez remplacer les méthodes suivantes:

  • La méthode init(). Pour configurer et initialiser un dépôt de données, remplacez la méthode init().

  • La méthode getIds(). Pour récupérer les ID et les valeurs de hachage de tous les enregistrements du dépôt, remplacez la méthode getIds().

  • La méthode getDoc(). Pour ajouter, mettre à jour, modifier ou supprimer des éléments de l'index, remplacez la méthode getDoc().

  • (Facultatif) La méthode getChanges(). Si votre dépôt accepte la détection des modifications, remplacez la méthode getChanges(). Cette méthode est appelée une fois pour chaque balayage incrémentiel planifié (tel que défini par votre configuration) afin de récupérer les éléments modifiés et de les indexer.

  • (Facultatif) La méthode close(). Si vous devez nettoyer le dépôt, remplacez la méthode close(). Cette méthode est appelée une seule fois lors de l'arrêt du connecteur.

Chacune des méthodes de l'objet Repository renvoie un objet ApiOperation. Un objet ApiOperation effectue une action sous la forme d'un ou de plusieurs appels IndexingService.indexItem() pour effectuer l'indexation réelle de votre dépôt.

Obtenir des paramètres de configuration personnalisés

Lorsque vous gérez la configuration de votre connecteur, vous devez récupérer les éventuels paramètres personnalisés de l'objet Configuration. Cette tâche est généralement effectuée dans la méthode init() d'une classe Repository.

La classe Configuration comporte plusieurs méthodes permettant d'obtenir différents types de données à partir d'une configuration. Chaque méthode renvoie un objet ConfigValue. Vous allez ensuite utiliser la méthode get() de l'objet ConfigValue pour récupérer la valeur réelle. L'extrait de code suivant, tiré de FullTraversalSample, montre comment récupérer une seule valeur entière personnalisée à partir d'un objet Configuration:

FullTraversalSample.java
@Override
public void init(RepositoryContext context) {
  log.info("Initializing repository");
  numberOfDocuments = Configuration.getInteger("sample.documentCount", 10).get();
}

Pour obtenir et analyser un paramètre contenant plusieurs valeurs, utilisez l'un des analyseurs de type de la classe Configuration afin d'analyser les données par fragments distincts. L'extrait de code suivant (issu du connecteur du tutoriel) permet d'obtenir la liste des noms de dépôts GitHub grâce à la méthode getMultiValue:

GithubRepository.java
ConfigValue<List<String>> repos = Configuration.getMultiValue(
    "github.repos",
    Collections.emptyList(),
    Configuration.STRING_PARSER);

Effectuer un balayage de liste

Remplacez la méthode getIds() pour récupérer les ID et les valeurs de hachage de tous les enregistrements du dépôt. La méthode getIds() accepte un point de contrôle. Ce point de contrôle permet de reprendre l'indexation à partir d'un élément spécifique si le processus est interrompu.

Remplacez ensuite la méthode getDoc() pour gérer chaque élément de la file d'attente d'indexation Cloud Search.

Transmettre les ID et valeurs de hachage des éléments

Remplacez getIds() pour récupérer les ID des éléments et les valeurs de hachage de contenu associées dans le dépôt. Les paires ID/valeur de hachage sont ensuite empaquetées dans une requête d'opération d'envoi vers la file d'attente d'indexation Cloud Search. Les ID racine ou parent sont généralement envoyés en premier, suivis des ID enfants jusqu'à ce que l'ensemble de la hiérarchie des éléments ait été traité.

La méthode getIds() accepte un point de contrôle représentant le dernier élément à indexer. Le point de contrôle permet de reprendre l'indexation à partir d'un élément spécifique si le processus est interrompu. Pour chaque élément de votre dépôt, vous accomplirez les tâches suivantes dans la méthode getIds():

  • Récupérez l'ID de chaque élément et la valeur de hachage associée dans le dépôt.
  • Empaquetez chaque paire ID/valeur de hachage dans un objet PushItems.
  • Combinez chaque PushItems dans un itérateur renvoyé par la méthode getIds(). Notez que getIds() renvoie en fait un CheckpointCloseableIterable, qui est une itération d'objets ApiOperation, chaque objet représentant une requête API effectuée sur un RepositoryDoc, par exemple en envoyant les éléments dans la file d'attente.

L'extrait de code suivant montre comment récupérer l'ID et la valeur de hachage de chaque élément, puis les insérer dans un objet PushItems. Un PushItems est une requête ApiOperation visant à placer un élément dans la file d'attente d'indexation Cloud Search.

ListTraversalSample.java
PushItems.Builder allIds = new PushItems.Builder();
for (Map.Entry<Integer, Long> entry : this.documents.entrySet()) {
  String documentId = Integer.toString(entry.getKey());
  String hash = this.calculateMetadataHash(entry.getKey());
  PushItem item = new PushItem().setMetadataHash(hash);
  log.info("Pushing " + documentId);
  allIds.addPushItem(documentId, item);
}

L'extrait de code suivant montre comment utiliser la classe PushItems.Builder pour empaqueter les ID et les valeurs de hachage dans un seul ApiOperation push.

ListTraversalSample.java
ApiOperation pushOperation = allIds.build();
CheckpointCloseableIterable<ApiOperation> iterator =
  new CheckpointCloseableIterableImpl.Builder<>(
      Collections.singletonList(pushOperation))
  .build();
return iterator;

Les éléments sont placés dans la file d'attente d'indexation Cloud Search en vue d'un traitement plus poussé.

Récupérer et traiter chaque élément

Remplacez getDoc() afin de traiter chaque élément de la file d'attente d'indexation Cloud Search. Un élément peut être nouveau, modifié, inchangé ou ne plus exister dans le dépôt source. Récupérez et indexez chaque élément nouveau ou modifié. Supprimez de l'index les éléments qui n'existent plus dans le dépôt source.

La méthode getDoc() accepte un élément de la file d'attente d'indexation Google Cloud Search. Pour chaque élément de la file d'attente, vous accomplirez les tâches suivantes dans la méthode getDoc():

  1. Vérifiez si l'élément figure dans le dépôt, dans la file d'attente d'indexation Cloud Search. Si ce n'est pas le cas, supprimez l'élément de l'index.

  2. Interrogez l'index pour connaître l'état de l'élément et, si celui-ci n'a pas changé (ACCEPTED), ne faites rien.

  3. Éléments nouveaux ou modifiés dans l'index:

    1. Définissez les autorisations.
    2. Définissez les métadonnées de l'élément que vous indexez.
    3. Combinez les métadonnées et l'élément dans un seul RepositoryDoc indexable.
    4. Renvoyez RepositoryDoc.

Remarque:Le modèle ListingConnector ne permet pas de renvoyer null sur la méthode getDoc(). Le renvoi de null génère une NullPointerException.

Gérer les éléments supprimés

L'extrait de code suivant montre comment déterminer si un élément existe dans le dépôt et, si ce n'est pas le cas, le supprimer.

ListTraversalSample.java
String resourceName = item.getName();
int documentId = Integer.parseInt(resourceName);

if (!documents.containsKey(documentId)) {
  // Document no longer exists -- delete it
  log.info(() -> String.format("Deleting document %s", item.getName()));
  return ApiOperations.deleteItem(resourceName);
}

Notez que documents est une structure de données représentant le dépôt. Si documentID est introuvable dans documents, renvoyez APIOperations.deleteItem(resourceName) pour supprimer l'élément de l'index.

Traiter les éléments inchangés

L'extrait de code suivant montre comment interroger l'état d'un élément dans la file d'attente d'indexation Cloud Search et gérer un élément inchangé.

ListTraversalSample.java
String currentHash = this.calculateMetadataHash(documentId);
if (this.canSkipIndexing(item, currentHash)) {
  // Document neither modified nor deleted, ack the push
  log.info(() -> String.format("Document %s not modified", item.getName()));
  PushItem pushItem = new PushItem().setType("NOT_MODIFIED");
  return new PushItems.Builder().addPushItem(resourceName, pushItem).build();
}

Pour déterminer si l'élément n'a pas été modifié, vérifiez son état ainsi que les autres métadonnées pouvant indiquer une modification. Dans cet exemple, le hachage des métadonnées permet de déterminer si l'élément a été modifié.

ListTraversalSample.java
/**
 * Checks to see if an item is already up to date
 *
 * @param previousItem Polled item
 * @param currentHash  Metadata hash of the current github object
 * @return PushItem operation
 */
private boolean canSkipIndexing(Item previousItem, String currentHash) {
  if (previousItem.getStatus() == null || previousItem.getMetadata() == null) {
    return false;
  }
  String status = previousItem.getStatus().getCode();
  String previousHash = previousItem.getMetadata().getHash();
  return "ACCEPTED".equals(status)
      && previousHash != null
      && previousHash.equals(currentHash);
}

Définir les autorisations pour un élément

Votre dépôt utilise une liste de contrôle d'accès (LCA) pour identifier les utilisateurs ou les groupes ayant accès à un élément. Une LCA est une liste d'ID correspondant aux groupes ou aux utilisateurs ayant accès à l'élément.

Vous devez dupliquer la LCA utilisée par votre dépôt pour vous assurer que seuls les utilisateurs ayant accès à un élément peuvent le voir dans un résultat de recherche. La LCA d'un élément doit être incluse lors de son indexation pour que Google Cloud Search dispose des informations nécessaires pour fournir le niveau d'accès approprié à l'élément.

Le SDK Content Connector fournit un ensemble complet de classes et de méthodes de LCA pour modéliser les LCA de la plupart des dépôts. Vous devez analyser la LCA de chaque élément de votre dépôt et créer une LCA correspondante pour Google Cloud Search lorsque vous indexez un élément. Si la LCA de votre dépôt utilise des concepts tels que l'héritage des LCA, il peut s'avérer délicat de la modéliser. Consultez la section LCA de Google Cloud Search pour en savoir plus sur celles-ci.

Remarque:L'API Cloud Search Indexing accepte les LCA à domaine unique. Il n'est pas compatible avec les LCA interdomaines. Utilisez la classe Acl.Builder pour définir l'accès à chaque élément à l'aide d'une LCA. L'extrait de code suivant, issu de l'exemple de balayage complet, permet à tous les utilisateurs ou "comptes principaux" (getCustomerPrincipal()) d'être des "lecteurs" de tous les éléments (.setReaders()) lors d'une recherche.

FullTraversalSample.java
// Make the document publicly readable within the domain
Acl acl = new Acl.Builder()
    .setReaders(Collections.singletonList(Acl.getCustomerPrincipal()))
    .build();

Vous devez comprendre les LCA afin de les modéliser correctement pour le dépôt. Il se peut, par exemple, que vous indexiez des fichiers dans un système de fichiers utilisant un modèle d'héritage, dans lequel les dossiers enfants héritent des autorisations des dossiers parents. La modélisation du mécanisme d'héritage des LCA nécessite des informations supplémentaires. Pour en savoir plus, consultez la section LCA de Google Cloud Search.

Définir les métadonnées d'un élément

Les métadonnées sont stockées dans un objet Item. Pour créer une Item, vous devez disposer au minimum d'un ID de chaîne unique, d'un type d'élément, d'une LCA, d'une URL et d'une version de l'élément. L'extrait de code suivant montre comment créer un Item à l'aide de la classe d'assistance IndexingItemBuilder.

ListTraversalSample.java
// Url is required. Use google.com as a placeholder for this sample.
String viewUrl = "https://www.google.com";

// Version is required, set to current timestamp.
byte[] version = Longs.toByteArray(System.currentTimeMillis());

// Set metadata hash so queue can detect changes
String metadataHash = this.calculateMetadataHash(documentId);

// Using the SDK item builder class to create the document with
// appropriate attributes. This can be expanded to include metadata
// fields etc.
Item item = IndexingItemBuilder.fromConfiguration(Integer.toString(documentId))
    .setItemType(IndexingItemBuilder.ItemType.CONTENT_ITEM)
    .setAcl(acl)
    .setSourceRepositoryUrl(IndexingItemBuilder.FieldOrValue.withValue(viewUrl))
    .setVersion(version)
    .setHash(metadataHash)
    .build();

Créer un élément indexable

Après avoir défini les métadonnées de l'élément, vous pouvez créer l'élément indexable avec RepositoryDoc.Builder. L'exemple suivant montre comment créer un seul élément indexable.

ListTraversalSample.java
// For this sample, content is just plain text
String content = String.format("Hello world from sample doc %d", documentId);
ByteArrayContent byteContent = ByteArrayContent.fromString("text/plain", content);

// Create the fully formed document
RepositoryDoc doc = new RepositoryDoc.Builder()
    .setItem(item)
    .setContent(byteContent, IndexingService.ContentFormat.TEXT)
    .build();

Un RepositoryDoc est un type de ApiOperation qui exécute la requête IndexingService.indexItem().

Vous pouvez également utiliser la méthode setRequestMode() de la classe RepositoryDoc.Builder pour identifier la requête d'indexation comme ASYNCHRONOUS ou SYNCHRONOUS:

ASYNCHRONOUS
Le mode asynchrone augmente la latence entre l'indexation et la diffusion des éléments, tout en prenant en charge des quotas de débit importants pour les requêtes d'indexation. Le mode asynchrone est recommandé pour l'indexation initiale (le remplissage) de l'ensemble du dépôt.
SYNCHRONOUS
Le mode synchrone réduit la latence entre l'indexation et la diffusion des éléments et prend en charge un quota de débit limité. Le mode synchrone est recommandé pour l'indexation des mises à jour et des modifications apportées au dépôt. S'il n'est pas spécifié, le mode de requête par défaut est SYNCHRONOUS.

Étapes suivantes

Voici quelques étapes que vous pouvez également suivre :

Créer un connecteur de balayage de graphe à l'aide d'un modèle de classe

La file d'attente d'indexation Cloud Search permet de conserver l'ID et les valeurs de hachage facultatives de chaque élément du dépôt. Un connecteur de balayage de graphe place les ID d'élément dans la file d'attente d'indexation Google Cloud Search, puis les récupère un par un pour les indexer. Google Cloud Search gère les files d'attente et compare leur contenu pour déterminer l'état des éléments (par exemple, s'ils ont été supprimés du dépôt). Pour en savoir plus sur la file d'attente d'indexation Cloud Search, consultez l'article File d'attente d'indexation Google Cloud Search.

Pendant l'index, le contenu des éléments est extrait du dépôt de données et tous les ID d'éléments enfants sont placés dans la file d'attente. Le connecteur traite les ID des parents et enfants de manière récursive jusqu'à ce que tous les éléments soient traités.

Cette section fait référence aux extraits de code de l'exemple GraphTraversalSample.

Implémenter le point d'entrée du connecteur

Le point d'entrée d'un connecteur est la méthode main(). La tâche principale de cette méthode consiste à créer une instance de la classe Application et à appeler sa méthode start() pour exécuter le connecteur.

Avant d'appeler application.start(), utilisez la classe IndexingApplication.Builder pour instancier le modèle ListingConnector. Le modèle ListingConnector accepte un objet Repository dont vous implémentez les méthodes.

L'extrait de code suivant montre comment instancier ListingConnector et son Repository associé:

GraphTraversalSample.java
/**
 * This sample connector uses the Cloud Search SDK template class for a graph
 * traversal connector.
 *
 * @param args program command line arguments
 * @throws InterruptedException thrown if an abort is issued during initialization
 */
public static void main(String[] args) throws InterruptedException {
  Repository repository = new SampleRepository();
  IndexingConnector connector = new ListingConnector(repository);
  IndexingApplication application = new IndexingApplication.Builder(connector, args).build();
  application.start();
}

En arrière-plan, le SDK appelle la méthode initConfig() après que la méthode main() de votre connecteur a appelé Application.build. La méthode initConfig():

  1. Appelle la méthode Configuation.isInitialized() pour s'assurer que l'objet Configuration n'a pas été initialisé.
  2. Initialise un objet Configuration avec les paires clé/valeur fournies par Google. Chaque paire clé-valeur est stockée dans un objet ConfigValue au sein de l'objet Configuration.

Implémenter l'interface Repository

L'objet Repository n'a qu'une fonction, qui consiste à balayer les éléments du dépôt et à les indexer. Lorsque vous utilisez un modèle, il vous suffit de remplacer certaines méthodes dans l'interface Repository pour créer un connecteur de contenu. Les méthodes à remplacer dépendent du modèle et de la stratégie de balayage que vous utilisez. Pour le modèle ListingConnector, vous devez remplacer les méthodes suivantes:

  • La méthode init(). Pour configurer et initialiser un dépôt de données, remplacez la méthode init().

  • La méthode getIds(). Pour récupérer les ID et les valeurs de hachage de tous les enregistrements du dépôt, remplacez la méthode getIds().

  • La méthode getDoc(). Pour ajouter, mettre à jour, modifier ou supprimer des éléments de l'index, remplacez la méthode getDoc().

  • (Facultatif) La méthode getChanges(). Si votre dépôt accepte la détection des modifications, remplacez la méthode getChanges(). Cette méthode est appelée une fois pour chaque balayage incrémentiel planifié (tel que défini par votre configuration) afin de récupérer les éléments modifiés et de les indexer.

  • (Facultatif) La méthode close(). Si vous devez nettoyer le dépôt, remplacez la méthode close(). Cette méthode est appelée une seule fois lors de l'arrêt du connecteur.

Chacune des méthodes de l'objet Repository renvoie un objet ApiOperation. Un objet ApiOperation effectue une action sous la forme d'un ou de plusieurs appels IndexingService.indexItem() pour effectuer l'indexation réelle de votre dépôt.

Obtenir des paramètres de configuration personnalisés

Lorsque vous gérez la configuration de votre connecteur, vous devez récupérer les éventuels paramètres personnalisés de l'objet Configuration. Cette tâche est généralement effectuée dans la méthode init() d'une classe Repository.

La classe Configuration comporte plusieurs méthodes permettant d'obtenir différents types de données à partir d'une configuration. Chaque méthode renvoie un objet ConfigValue. Vous allez ensuite utiliser la méthode get() de l'objet ConfigValue pour récupérer la valeur réelle. L'extrait de code suivant, tiré de FullTraversalSample, montre comment récupérer une seule valeur entière personnalisée à partir d'un objet Configuration:

FullTraversalSample.java
@Override
public void init(RepositoryContext context) {
  log.info("Initializing repository");
  numberOfDocuments = Configuration.getInteger("sample.documentCount", 10).get();
}

Pour obtenir et analyser un paramètre contenant plusieurs valeurs, utilisez l'un des analyseurs de type de la classe Configuration afin d'analyser les données par fragments distincts. L'extrait de code suivant (issu du connecteur du tutoriel) permet d'obtenir la liste des noms de dépôts GitHub grâce à la méthode getMultiValue:

GithubRepository.java
ConfigValue<List<String>> repos = Configuration.getMultiValue(
    "github.repos",
    Collections.emptyList(),
    Configuration.STRING_PARSER);

Effectuer un balayage de graphe

Remplacez la méthode getIds() pour récupérer les ID et les valeurs de hachage de tous les enregistrements du dépôt. La méthode getIds() accepte un point de contrôle. Ce point de contrôle permet de reprendre l'indexation à partir d'un élément spécifique si le processus est interrompu.

Remplacez ensuite la méthode getDoc() pour gérer chaque élément de la file d'attente d'indexation Cloud Search.

Transmettre les ID et valeurs de hachage des éléments

Remplacez getIds() pour récupérer les ID des éléments et les valeurs de hachage de contenu associées dans le dépôt. Les paires ID/valeur de hachage sont ensuite empaquetées dans une requête d'opération d'envoi vers la file d'attente d'indexation Cloud Search. Les ID racine ou parent sont généralement envoyés en premier, suivis des ID enfants jusqu'à ce que l'ensemble de la hiérarchie des éléments ait été traité.

La méthode getIds() accepte un point de contrôle représentant le dernier élément à indexer. Le point de contrôle permet de reprendre l'indexation à partir d'un élément spécifique si le processus est interrompu. Pour chaque élément de votre dépôt, vous accomplirez les tâches suivantes dans la méthode getIds():

  • Récupérez l'ID de chaque élément et la valeur de hachage associée dans le dépôt.
  • Empaquetez chaque paire ID/valeur de hachage dans un objet PushItems.
  • Combinez chaque PushItems dans un itérateur renvoyé par la méthode getIds(). Notez que getIds() renvoie en fait un CheckpointCloseableIterable, qui est une itération d'objets ApiOperation, chaque objet représentant une requête API effectuée sur un RepositoryDoc, par exemple en envoyant les éléments dans la file d'attente.

L'extrait de code suivant montre comment obtenir l'ID et la valeur de hachage de chaque élément, puis les insérer dans un objet PushItems. Un PushItems est une requête ApiOperation visant à placer un élément dans la file d'attente d'indexation Cloud Search.

GraphTraversalSample.java
PushItems.Builder allIds = new PushItems.Builder();
PushItem item = new PushItem();
allIds.addPushItem("root", item);

L'extrait de code suivant montre comment utiliser la classe PushItems.Builder pour empaqueter les ID et les valeurs de hachage dans un seul ApiOperation d'envoi.

GraphTraversalSample.java
ApiOperation pushOperation = allIds.build();
CheckpointCloseableIterable<ApiOperation> iterator =
  new CheckpointCloseableIterableImpl.Builder<>(
      Collections.singletonList(pushOperation))
  .build();

Les éléments sont placés dans la file d'attente d'indexation Cloud Search en vue d'un traitement plus poussé.

Récupérer et traiter chaque élément

Remplacez getDoc() afin de traiter chaque élément de la file d'attente d'indexation Cloud Search. Un élément peut être nouveau, modifié, inchangé ou ne plus exister dans le dépôt source. Récupérez et indexez chaque élément nouveau ou modifié. Supprimez de l'index les éléments qui n'existent plus dans le dépôt source.

La méthode getDoc() accepte un élément de la file d'attente d'indexation Cloud Search. Pour chaque élément de la file d'attente, vous accomplirez les tâches suivantes dans la méthode getDoc():

  1. Vérifiez si l'élément figure dans le dépôt, dans la file d'attente d'indexation Cloud Search. Si ce n'est pas le cas, supprimez l'élément de l'index. Si l'élément existe, passez à l'étape suivante.

  2. Éléments nouveaux ou modifiés dans l'index:

    1. Définissez les autorisations.
    2. Définissez les métadonnées de l'élément que vous indexez.
    3. Combinez les métadonnées et l'élément dans un seul RepositoryDoc indexable.
    4. Placez les ID des éléments enfants dans la file d'attente d'indexation Cloud Search afin qu'ils soient traités.
    5. Renvoyez RepositoryDoc.

Gérer les éléments supprimés

L'extrait de code suivant montre comment déterminer si un élément existe dans l'index et, s'il ne l'est pas, le supprimer.

GraphTraversalSample.java
String resourceName = item.getName();
if (documentExists(resourceName)) {
  return buildDocumentAndChildren(resourceName);
}
// Document doesn't exist, delete it
log.info(() -> String.format("Deleting document %s", resourceName));
return ApiOperations.deleteItem(resourceName);

Définir les autorisations pour un élément

Votre dépôt utilise une liste de contrôle d'accès (LCA) pour identifier les utilisateurs ou les groupes ayant accès à un élément. Une LCA est une liste d'ID correspondant aux groupes ou aux utilisateurs ayant accès à l'élément.

Vous devez dupliquer la LCA utilisée par votre dépôt pour vous assurer que seuls les utilisateurs ayant accès à un élément peuvent le voir dans un résultat de recherche. La LCA d'un élément doit être incluse lors de son indexation pour que Google Cloud Search dispose des informations nécessaires pour fournir le niveau d'accès approprié à l'élément.

Le SDK Content Connector fournit un ensemble complet de classes et de méthodes de LCA pour modéliser les LCA de la plupart des dépôts. Vous devez analyser la LCA de chaque élément de votre dépôt et créer une LCA correspondante pour Google Cloud Search lorsque vous indexez un élément. Si la LCA de votre dépôt utilise des concepts tels que l'héritage des LCA, il peut s'avérer délicat de la modéliser. Consultez la section LCA de Google Cloud Search pour en savoir plus sur celles-ci.

Remarque:L'API Cloud Search Indexing accepte les LCA à domaine unique. Il n'est pas compatible avec les LCA interdomaines. Utilisez la classe Acl.Builder pour définir l'accès à chaque élément à l'aide d'une LCA. L'extrait de code suivant, issu de l'exemple de balayage complet, permet à tous les utilisateurs ou "comptes principaux" (getCustomerPrincipal()) d'être des "lecteurs" de tous les éléments (.setReaders()) lors d'une recherche.

FullTraversalSample.java
// Make the document publicly readable within the domain
Acl acl = new Acl.Builder()
    .setReaders(Collections.singletonList(Acl.getCustomerPrincipal()))
    .build();

Vous devez comprendre les LCA afin de les modéliser correctement pour le dépôt. Il se peut, par exemple, que vous indexiez des fichiers dans un système de fichiers utilisant un modèle d'héritage, dans lequel les dossiers enfants héritent des autorisations des dossiers parents. La modélisation du mécanisme d'héritage des LCA nécessite des informations supplémentaires. Pour en savoir plus, consultez la section LCA de Google Cloud Search.

Définir les métadonnées d'un élément

Les métadonnées sont stockées dans un objet Item. Pour créer une Item, vous devez disposer au minimum d'un ID de chaîne unique, d'un type d'élément, d'une LCA, d'une URL et d'une version de l'élément. L'extrait de code suivant montre comment créer un Item à l'aide de la classe d'assistance IndexingItemBuilder.

GraphTraversalSample.java
// Url is required. Use google.com as a placeholder for this sample.
String viewUrl = "https://www.google.com";

// Version is required, set to current timestamp.
byte[] version = Longs.toByteArray(System.currentTimeMillis());

// Using the SDK item builder class to create the document with
// appropriate attributes. This can be expanded to include metadata
// fields etc.
Item item = IndexingItemBuilder.fromConfiguration(documentId)
    .setItemType(IndexingItemBuilder.ItemType.CONTENT_ITEM)
    .setAcl(acl)
    .setSourceRepositoryUrl(IndexingItemBuilder.FieldOrValue.withValue(viewUrl))
    .setVersion(version)
    .build();

Créer l'élément indexable

Après avoir défini les métadonnées de l'élément, vous pouvez créer l'élément indexable avec RepositoryDoc.Builder. L'exemple suivant montre comment créer un seul élément indexable.

GraphTraversalSample.java
// For this sample, content is just plain text
String content = String.format("Hello world from sample doc %s", documentId);
ByteArrayContent byteContent = ByteArrayContent.fromString("text/plain", content);

RepositoryDoc.Builder docBuilder = new RepositoryDoc.Builder()
    .setItem(item)
    .setContent(byteContent, IndexingService.ContentFormat.TEXT);

Un RepositoryDoc est un type de ApiOperation qui exécute la requête IndexingService.indexItem() réelle.

Vous pouvez également utiliser la méthode setRequestMode() de la classe RepositoryDoc.Builder pour identifier la requête d'indexation comme ASYNCHRONOUS ou SYNCHRONOUS:

ASYNCHRONOUS
Le mode asynchrone augmente la latence entre l'indexation et la diffusion des éléments, tout en prenant en charge des quotas de débit importants pour les requêtes d'indexation. Le mode asynchrone est recommandé pour l'indexation initiale (le remplissage) de l'ensemble du dépôt.
SYNCHRONOUS
Le mode synchrone réduit la latence entre l'indexation et la diffusion des éléments et prend en charge un quota de débit limité. Le mode synchrone est recommandé pour l'indexation des mises à jour et des modifications apportées au dépôt. S'il n'est pas spécifié, le mode de requête par défaut est SYNCHRONOUS.

Placer les ID des éléments enfants dans la file d'attente d'indexation Cloud Search

L'extrait de code suivant montre comment inclure les ID enfants de l'élément parent en cours de traitement dans la file d'attente. Ces ID sont traités après l'indexation de l'élément parent.

GraphTraversalSample.java
// Queue the child nodes to visit after indexing this document
Set<String> childIds = getChildItemNames(documentId);
for (String id : childIds) {
  log.info(() -> String.format("Pushing child node %s", id));
  PushItem pushItem = new PushItem();
  docBuilder.addChildId(id, pushItem);
}

RepositoryDoc doc = docBuilder.build();

Étapes suivantes

Voici quelques étapes que vous pouvez également suivre :

Créer un connecteur de contenu à l'aide de l'API REST

Les sections suivantes expliquent comment créer un connecteur de contenu à l'aide de l'API REST.

Déterminer votre stratégie de balayage

La fonction principale d'un connecteur de contenu est de balayer un dépôt et d'en indexer les données. Vous devez mettre en œuvre une stratégie de balayage en fonction de la taille et de la disposition des données dans votre dépôt. Voici trois stratégies de balayage courantes:

Stratégie de balayage complet

La stratégie de balayage complet consiste à analyser l'intégralité du dépôt et à indexer chaque élément de façon aveugle. Cette stratégie est couramment utilisée lorsque vous disposez d'un petit dépôt et que vous pouvez vous permettre d'effectuer un balayage complet à chaque indexation.

Cette stratégie de balayage est adaptée aux petits dépôts contenant des données principalement statiques et non hiérarchiques. Vous pouvez également utiliser cette stratégie de balayage lorsque la détection des modifications est difficile ou incompatible avec le dépôt.

Stratégie de balayage de liste

Une stratégie de balayage de liste permet d'analyser l'ensemble du dépôt, y compris tous les nœuds enfants, pour déterminer l'état de chaque élément. Ensuite, lors d'une seconde passe, le connecteur n'indexe que les éléments nouveaux ou qui ont été mis à jour depuis la dernière indexation. Cette stratégie est couramment utilisée pour effectuer des mises à jour incrémentielles sur un index existant (au lieu d'avoir à effectuer un balayage complet à chaque mise à jour de l'index).

Cette stratégie de balayage convient lorsque la détection des modifications est difficile ou non compatible avec le dépôt, que vous disposez de données non hiérarchiques et que vous travaillez avec de très grands ensembles de données.

Balayage de graphe

Une stratégie de balayage de graphe analyse l'ensemble du nœud parent pour déterminer l'état de chaque élément. Ensuite, lors d'une seconde passe, le connecteur n'indexe que les éléments du nœud racine nouveaux ou ayant été mis à jour depuis la dernière indexation. Enfin, le connecteur transmet tous les ID enfants, puis indexe les éléments des nœuds enfants qui sont nouveaux ou qui ont été mis à jour. Il continue de passer par tous les nœuds enfants de manière récursive jusqu'à ce que tous les éléments soient traités. Ce type de balayage est généralement utilisé pour les dépôts hiérarchiques dans lesquels il n'est pas pratique de lister tous les ID.

Cette stratégie convient si vous devez explorer des données hiérarchisées, telles que des répertoires ou des pages Web de séries.

Implémenter votre stratégie de balayage et les éléments d'index

Chaque élément indexable pour Cloud Search est appelé élément dans l'API Cloud Search. Un élément peut être un fichier, un dossier, une ligne d'un fichier CSV ou un enregistrement de base de données.

Une fois votre schéma enregistré, vous pouvez remplir l'index de l'une des manières suivantes:

  1. (Facultatif) Utilisez items.upload pour importer des fichiers de plus de 100 Kio à indexer. Pour les fichiers plus petits, intégrez le contenu en tant que inlineContent avec items.index.

  2. (Facultatif) Utilisez media.upload pour importer des fichiers multimédias à indexer.

  3. Utilisation de items.index pour indexer l'élément Par exemple, si votre schéma utilise la définition d'objet dans le schéma de film, une requête d'indexation pour un seul élément se présentera comme suit:

    {
  "name": "datasource/<data_source_id>/items/titanic",
  "acl": {
    "readers": [
      {
        "gsuitePrincipal": {
          "gsuiteDomain": true
        }
      }
    ]
  },
  "metadata": {
    "title": "Titanic",
    "viewUrl": "http://www.imdb.com/title/tt2234155/?ref_=nv_sr_1",
    "objectType": "movie"
  },
  "structuredData": {
    "object": {
      "properties": [
        {
          "name": "movieTitle",
          "textValues": {
            "values": [
              "Titanic"
            ]
          }
        },
        {
          "name": "releaseDate",
          "dateValues": {
            "values": [
              {
                "year": 1997,
                "month": 12,
                "day": 19
              }
            ]
          }
        },
        {
          "name": "actorName",
          "textValues": {
            "values": [
              "Leonardo DiCaprio",
              "Kate Winslet",
              "Billy Zane"
            ]
          }
        },
        {
          "name": "genre",
          "enumValues": {
            "values": [
              "Drama",
              "Action"
            ]
          }
        },
        {
          "name": "userRating",
          "integerValues": {
            "values": [
              8
            ]
          }
        },
        {
          "name": "mpaaRating",
          "textValues": {
            "values": [
              "PG-13"
            ]
          }
        },
        {
          "name": "duration",
          "textValues": {
            "values": [
              "3 h 14 min"
            ]
          }
        }
      ]
    }
  },
  "content": {
    "inlineContent": "A seventeen-year-old aristocrat falls in love with a kind but poor artist aboard the luxurious, ill-fated R.M.S. Titanic.",
    "contentFormat": "TEXT"
  },
  "version": "01",
  "itemType": "CONTENT_ITEM"
}

  4. (Facultatif) Utilisation des appels items.get pour vérifier qu'un élément a été indexé.

Pour effectuer un balayage complet, vous devez réindexer régulièrement l'ensemble du dépôt. Pour effectuer un balayage de liste ou de graphe, vous devez ajouter du code pour gérer les modifications du dépôt.

Gérer les modifications du dépôt

Vous pouvez rassembler et indexer régulièrement chaque élément d'un dépôt pour effectuer une indexation complète. Bien qu'efficace pour garantir que votre index est à jour, une indexation complète peut s'avérer coûteuse dans le cas de dépôts plus importants ou hiérarchiques.

Plutôt que d'utiliser des appels d'index pour indexer un dépôt entier de temps à autre, vous pouvez également utiliser la file d'attente d'indexation Google Cloud pour suivre les modifications et n'indexer que les éléments qui ont changé. Vous pouvez envoyer des requêtes items.push pour placer des éléments dans la file d'attente afin d'interroger et de mettre à jour ultérieurement des éléments. Consultez l'article File d'attente d'indexation Google Cloud pour en savoir plus.

Pour en savoir plus sur l'API Google Cloud Search, consultez l'article API Cloud Search.