Auf dieser Seite des Cloud Search-Tutorials erfahren Sie, wie Sie eine Datenquelle und einen Inhalts-Connector zum Indexieren von Daten einrichten. Den Anfang dieses Tutorials finden Sie unter Erste Schritte mit Cloud Search.
Connector erstellen
Ändern Sie Ihr Arbeitsverzeichnis in das Verzeichnis cloud-search-samples/end-to-end/connector
und führen Sie den folgenden Befehl aus:
mvn package -DskipTests
Der Befehl lädt die erforderlichen Abhängigkeiten herunter, die zum Erstellen des Inhaltsconnectors erforderlich sind, und kompiliert den Code.
Anmeldedaten für ein Dienstkonto erstellen
Damit der Connector die Cloud Search APIs aufrufen kann, sind Anmeldedaten für das Dienstkonto erforderlich. So erstellen Sie die Anmeldedaten:
- Kehren Sie zur Google Cloud Console zurück.
- Klicken Sie im linken Navigationsmenü auf Anmeldedaten. Die Seite „Anmeldedaten“ wird angezeigt.
- Klicken Sie auf die Drop-down-Liste + ANMELDEDATEN ERSTELLEN und wählen Sie Dienstkonto aus. Die Seite „Dienstkonto erstellen“ wird angezeigt.
- Geben Sie im Feld Name des Dienstkontos „tutorial“ ein.
- Notieren Sie sich den Wert der Dienstkonto-ID (direkt nach dem Namen des Dienstkontos). Dieser Wert wird später verwendet.
- Klicken Sie auf Erstellen. Das Dialogfeld „Dienstkontoberechtigungen (optional)“ wird angezeigt.
- Klicke auf WEITER. Das Dialogfeld „Nutzern Zugriff auf dieses Dienstkonto gewähren (optional)“ wird angezeigt.
- Klicke auf FERTIG. Der Bildschirm „Anmeldedaten“ wird angezeigt.
- Klicken Sie unter „Dienstkonten“ auf die E‐Mail-Adresse des Dienstkontos. Die Seite „Dienstkontodetails“ wird angezeigt.
- Klicken Sie unter „Schlüssel“ auf die Drop-down-Liste SCHLÜSSEL HINZUFÜGEN und wählen Sie Neuen Schlüssel erstellen aus. Das Dialogfeld „Privaten Schlüssel erstellen“ wird angezeigt.
- Klicken Sie auf Erstellen.
- Optional: Wenn das Dialogfeld „Möchten Sie Downloads auf console.cloud.google.com zulassen?“ angezeigt wird, klicken Sie auf Zulassen.
- Eine Datei mit dem privaten Schlüssel wird auf Ihrem Computer gespeichert. Notieren Sie sich den Speicherort der heruntergeladenen Datei. Mit dieser Datei wird der Inhaltsconnector so konfiguriert, dass er sich beim Aufrufen der Google Cloud Search APIs authentifizieren kann.
Unterstützung von Drittanbietern initialisieren
Bevor Sie andere Cloud Search APIs aufrufen können, müssen Sie die Drittanbieterunterstützung für Google Cloud Search initialisieren.
So initialisieren Sie die Unterstützung von Drittanbietern für Cloud Search:
Ihr Projekt für die Cloud Search-Plattform enthält Anmeldedaten für ein Dienstkonto. Damit Sie die Unterstützung von Drittanbietern initialisieren können, müssen Sie jedoch Anmeldedaten für die Webanwendung erstellen. Eine Anleitung zum Erstellen von Anmeldedaten für Webanwendungen finden Sie unter Anmeldedaten erstellen. Nach Abschluss dieses Schritts sollten Sie eine Client-ID und eine Clientschlüsseldatei haben.
Verwenden Sie den OAuth 2-Playground von Google, um ein Zugriffstoken abzurufen:
- Klicken Sie auf „Settings“ (Einstellungen) und aktivieren Sie die Option User your own auth credentials (Eigene Anmeldedaten verwenden).
- Geben Sie die Client-ID und den Clientschlüssel aus Schritt 1 ein.
- Klicken Sie auf Schließen.
- Geben Sie im Feld mit den Bereichen
https://www.googleapis.com/auth/cloud_search.settings
ein und klicken Sie auf Autorisieren. Der OAuth 2 Playground gibt einen Autorisierungscode zurück. - Klicken Sie auf Autorisierungscode für Tokens austauschen. Ein Token wird zurückgegeben.
Initialisieren Sie die Unterstützung von Drittanbietern für Cloud Search mit dem folgenden curl-Befehl. Ersetzen Sie
[YOUR_ACCESS_TOKEN]
durch das Token aus Schritt 2.curl --request POST \ 'https://cloudsearch.googleapis.com/v1:initializeCustomer' \ --header 'Authorization: Bearer [YOUR_ACCESS_TOKEN]' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{}' \ --compressed
Wenn der Vorgang erfolgreich abgeschlossen wurde, enthält der Antworttext eine Instanz von
operation
. Beispiel:{ name: "operations/customers/01b3fqdm/lro/AOIL6eBv7fEfiZ_hUSpm8KQDt1Mnd6dj5Ru3MXf-jri4xK6Pyb2-Lwfn8vQKg74pgxlxjrY" }
Wenn das Problem weiterhin besteht, wenden Sie sich an den Cloud Search-Support.
Mit operations.get können Sie prüfen, ob die Unterstützung von Drittanbietern initialisiert wurde:
curl \ 'https://cloudsearch.googleapis.com/v1/operations/customers/01b3fqdm/lro/AOIL6eBv7fEfiZ_hUSpm8KQDt1Mnd6dj5Ru3MXf-jri4xK6Pyb2-Lwfn8vQKg74pgxlxjrY?key= [YOUR_API_KEY]' \ --header 'Authorization: Bearer [YOUR_ACCESS_TOKEN]' \ --header 'Accept: application/json' \ --compressed
Wenn die Initialisierung des Drittanbieters abgeschlossen ist, enthält es das Feld
done
, das auftrue
gesetzt ist. Beispiel:{ name: "operations/customers/01b3fqdm/lro/AOIL6eBv7fEfiZ_hUSpm8KQDt1Mnd6dj5Ru3MXf-jri4xK6Pyb2-Lwfn8vQKg74pgxlxjrY" done: true }
Datenquelle erstellen
Erstellen Sie als Nächstes in der Admin-Konsole eine Datenquelle. Die Datenquelle stellt einen Namespace für die Indexierung von Inhalten mit dem Connector bereit.
- Öffnen Sie die Admin-Konsole.
- Klicken Sie auf das Apps-Symbol. Die Seite „App-Verwaltung“ wird angezeigt.
- Klicken Sie auf Google Workspace. Die Seite „Apps – Google Workspace-Verwaltung“ wird angezeigt.
- Scrollen Sie nach unten und klicken Sie auf Cloud Search. Die Seite „Einstellungen für Google Workspace“ wird angezeigt.
- Klicken Sie auf Datenquellen von Drittanbietern. Die Seite „Datenquellen“ wird angezeigt.
- Klicken Sie auf das runde gelbe +. Das Dialogfeld „Neue Datenquelle hinzufügen“ wird angezeigt.
- Geben Sie im Feld Anzeigename „tutorial“ ein.
- Geben Sie im Feld E-Mail-Adressen des Dienstkontos die E-Mail-Adresse des Dienstkontos ein, das Sie im vorherigen Abschnitt erstellt haben. Wenn Sie die E-Mail-Adresse des Dienstkontos nicht kennen, suchen Sie den Wert auf der Seite Dienstkonten.
- Klicken Sie auf HINZUFÜGEN. Das Dialogfeld „Datenquelle wurde erstellt“ wird angezeigt.
- Klicken Sie auf *OK. Notieren Sie sich die Quellen-ID der neu erstellten Datenquelle. Mit der Quellen-ID wird der Inhaltsconnector konfiguriert.
Persönliches Zugriffstoken für die GitHub API generieren
Für ein ausreichendes Kontingent des Connectors ist authentifizierter Zugriff auf die GitHub API erforderlich. Der Einfachheit halber verwendet der Connector persönliche Zugriffstokens anstelle von OAuth. Persönliche Tokens ermöglichen die Authentifizierung als Nutzer mit einem begrenzten Satz von Berechtigungen, ähnlich wie bei OAuth.
- Melden Sie sich in GitHub an.
- Klicke oben rechts auf dein Profilbild. Ein Drop-down-Menü wird angezeigt.
- Klicke auf Einstellungen.
- Klicken Sie auf Entwicklereinstellungen.
- Klicken Sie auf Persönliche Zugriffstokens.
- Klicken Sie auf Generate personal access token (Persönliches Zugriffstoken generieren).
- Geben Sie in das Feld Note (Hinweis) „Cloud Search tutorial“ ein.
- Prüfen Sie den Bereich public_repo.
- Klicken Sie auf Token generieren.
- Notieren Sie sich das generierte Token. Er wird vom Connector verwendet, um die GitHub APIs aufzurufen, und stellt ein API-Kontingent für die Indexierung bereit.
Connector konfigurieren
Nachdem Sie die Anmeldedaten und die Datenquelle erstellt haben, aktualisieren Sie die Connector-Konfiguration mit den folgenden Werten:
- Ändern Sie das Verzeichnis von der Befehlszeile in
cloud-search-samples/end-to-end/connector/
. - Öffnen Sie die Datei
sample-config.properties
in einem Texteditor. - Legen Sie für den Parameter
api.serviceAccountPrivateKeyFile
den Dateipfad der Dienstanmeldedaten fest, die Sie zuvor heruntergeladen haben. - Legen Sie den Parameter
api.sourceId
auf die ID der zuvor erstellten Datenquelle fest. - Legen Sie für den Parameter
github.user
Ihren GitHub-Nutzernamen fest. - Legen Sie für den Parameter
github.token
das zuvor erstellte Zugriffstoken fest. - Speichern Sie die Datei.
Schema aktualisieren
Der Connector indexiert sowohl strukturierte als auch unstrukturierte Inhalte. Bevor Sie Daten indexieren, müssen Sie das Schema für die Datenquelle aktualisieren. Führen Sie den folgenden Befehl aus, um das Schema zu aktualisieren:
mvn exec:java -Dexec.mainClass=com.google.cloudsearch.tutorial.SchemaTool \
-Dexec.args="-Dconfig=sample-config.properties"
Connector ausführen
Führen Sie den folgenden Befehl aus, um den Connector auszuführen und mit der Indexierung zu beginnen:
mvn exec:java -Dexec.mainClass=com.google.cloudsearch.tutorial.GithubConnector \
-Dexec.args="-Dconfig=sample-config.properties"
In der Standardkonfiguration wird vom Connector ein einzelnes Repository in der Organisation googleworkspace
indexiert. Die Indexierung des Repositorys dauert etwa eine Minute.
Nach der ersten Indexierung fragt der Connector weiterhin Änderungen am Repository ab, die im Cloud Search-Index widergespiegelt werden müssen.
Code prüfen
In den verbleibenden Abschnitten wird der Aufbau des Connectors erläutert.
Anwendung starten
Der Einstiegspunkt für den Connector ist die Klasse GithubConnector
. Die Methode main
instanziiert die IndexingApplication
des SDK und startet sie.
Mit der vom SDK bereitgestellten ListingConnector
wird eine Durchlaufstrategie implementiert, bei der Cloud Search-Warteschlangen verwendet werden, um den Status von Elementen im Index zu verfolgen. Er delegiert außerdem an GithubRepository
, der vom Beispiel-Connector für den Zugriff auf Inhalte aus GitHub implementiert wurde.
GitHub-Repositories durchlaufen
Bei Durchläufen mit vollständiger Indexierung (Full Traversal) wird die Methode getIds()
aufgerufen, um zu indexierende Elemente in die Warteschlange zu verschieben.
Der Connector kann mehrere Repositories oder Organisationen indexieren. Um die Auswirkungen eines Fehlers möglichst gering zu halten, wird jeweils ein GitHub-Repository durchlaufen. Es wird ein Prüfpunkt zurückgegeben, bei dem in den Ergebnissen des Durchlaufs die Liste der Repositories enthalten ist, die in nachfolgenden Aufrufen von getIds()
indexiert werden sollen. Wenn ein Fehler auftritt, wird die Indexierung im aktuellen Repository fortgesetzt, anstatt noch einmal von vorn zu beginnen.
Die Methode collectRepositoryItems()
steuert den Durchlauf eines einzelnen GitHub-Repositorys. Bei dieser Methode wird eine Sammlung von ApiOperations
zurückgegeben, die die Elemente darstellt, die in die Warteschlange verschoben werden sollen. Elemente werden als Ressourcenname und als Hashwert gesendet, der den aktuellen Status des Elements darstellt.
Der Hashwert wird bei nachfolgenden Durchläufen der GitHub-Repositories verwendet. Mit diesem Wert kann geprüft werden, ob sich der Inhalt geändert hat, ohne dass zusätzlicher Inhalt hochgeladen werden muss. Der Connector stellt alle Elemente blind in die Warteschlange. Wenn das Element neu ist oder sich der Hashwert geändert hat, wird es zum Abfragen in der Warteschlange zur Verfügung gestellt. Andernfalls gilt das Element als unverändert.
Warteschlange verarbeiten
Nach Abschluss des vollständigen Durchlaufs beginnt der Connector damit, die zu indexierenden Elemente aus der Warteschlange abzufragen. Für jedes Element, das aus der Warteschlange genommen wird, wird die Methode getDoc()
aufgerufen. Die Methode liest das Element aus GitHub und konvertiert es in die für die Indexierung geeignete Darstellung.
Da der Connector für Livedaten ausgeführt wird, die sich jederzeit ändern können, prüft getDoc()
auch, ob das Element in der Warteschlange noch gültig ist, und löscht nicht mehr vorhandene Elemente aus dem Index.
Für jedes vom Connector indexierte GitHub-Objekt wird über die entsprechende Methode indexItem()
die Darstellung der Elemente für Cloud Search erstellt. So erstellen Sie beispielsweise die Darstellung von Inhaltselementen:
Stellen Sie als Nächstes die Suchoberfläche bereit.