Diese Seite wurde von der Cloud Translation API übersetzt.

Connector bereitstellen

Auf dieser Seite der Cloud Search-Anleitung erfahren Sie, wie Sie eine Datenquelle einrichten. und Inhalts-Connector für die Indexierung von Daten. Den Anfang dieses Tutorials finden Sie unter Tutorial: Einführung in Cloud Search

Connector erstellen

Ändern Sie Ihr Arbeitsverzeichnis in das 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 Inhalts-Connector und kompiliert den Code.

Anmeldedaten für ein Dienstkonto erstellen

Der Connector benötigt Anmeldedaten für das Dienstkonto, um Cloud Search aufzurufen APIs So erstellen Sie die Anmeldedaten:

Zurück zum Google Cloud Console:
Klicken Sie im linken Navigationsmenü auf Anmeldedaten. Die „Qualifikation“ angezeigt.
Klicken Sie auf die Drop-down-Liste + ANMELDEDATEN ERSTELLEN und wählen Sie Dienstkonto. Das „Dienstkonto erstellen“ 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.
Klicke auf ERSTELLEN. „Dienstkontoberechtigungen (optional)“ wird angezeigt.
Klicke auf WEITER. Die Schaltfläche „Nutzern Zugriff auf dieses Dienstkonto gewähren (optional)" wird angezeigt.
Klicken Sie auf FERTIG. Die „Anmeldedaten“ erscheint.
Klicken Sie unter „Dienstkonten“ auf die E‐Mail-Adresse des Dienstkontos. Der „Service“ Kontodetails“ angezeigt wird.
Klicken Sie unter „Schlüssel“ auf die Drop-down-Liste SCHLÜSSEL HINZUFÜGEN und wählen Sie Neuen Schlüssel erstellen Die Option „Privaten Schlüssel erstellen“ wird angezeigt.
Klicke auf ERSTELLEN.
Optional: Wenn die Option "Möchten Sie Downloads auf console.cloud.google.com?” auf Zulassen.
Eine Datei mit dem privaten Schlüssel wird auf Ihrem Computer gespeichert. Notieren Sie sich den Standort. der heruntergeladenen Datei. Damit wird der Inhaltsconnector so konfiguriert, kann es sich beim Aufrufen der Google Cloud Search APIs authentifizieren.

Unterstützung von Drittanbietern initialisieren

Bevor Sie andere Cloud Search APIs aufrufen können, müssen Sie Unterstützung für Google Cloud Search.

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. Um den Drittanbieter-Support zu initialisieren, müssen Sie jedoch Anmeldedaten für die Anwendung. Anweisungen zum Erstellen einer Webanwendung finden Sie unter Anmeldedaten erstellen Nach Abschluss dieses Schritts sollten Sie eine Client-ID und eine Clientschlüsseldatei haben.
Verwenden Sie OAuth 2.0 von Google , um ein Zugriffstoken zu erhalten:
1. Klicken Sie auf „Settings“ (Einstellungen) und aktivieren Sie die Option User your own auth credentials (Eigene Anmeldedaten verwenden).
2. Geben Sie die Client-ID und den Clientschlüssel aus Schritt 1 ein.
3. Klicken Sie auf Schließen.
4. 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.
5. 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 folgendem curl-Befehl . Ersetzen Sie [YOUR_ACCESS_TOKEN] durch das Token aus der 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.

Verwenden Sie operations.get, um zu überprüfen, ob Unterstützung von Drittanbietern wird initialisiert:

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 sie Das Feld done wurde auf true festgelegt. 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“ angezeigt.
Klicken Sie auf Google Workspace. „Apps – Google Workspace-Verwaltung“ angezeigt.
Scrollen Sie nach unten und klicken Sie auf Cloud Search. Die Einstellungen für Google Workspace Seite angezeigt wird.
Klicken Sie auf Datenquellen von Drittanbietern. Unter „Datenquellen“ angezeigt.
Klicken Sie auf das runde gelbe +. Auf dem Tab „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 Dienstkonto, das Sie im vorherigen Abschnitt erstellt haben. Falls Sie nicht wissen, E-Mail-Adresse des Dienstkontos, suchen Sie den Wert in die Dienstkonten Seite.
Klicken Sie auf HINZUFÜGEN. Das Feld „Datenquelle wurde erstellt“ wird angezeigt.
Klicken Sie auf *OK. Notieren Sie sich die Quellen-ID der neu erstellten Datenquelle. Die Mit der Quellen-ID wird der Inhaltsconnector konfiguriert.

Persönliches Zugriffstoken für die GitHub API generieren

Der Connector benötigt einen authentifizierten Zugriff auf die GitHub API, damit um ein ausreichendes Kontingent zu haben. Der Einfachheit halber nutzt der Connector persönliche Zugriffstokens statt OAuth verwenden. Persönliche Tokens ermöglichen die Authentifizierung als Nutzer mit eingeschränkten Berechtigungen, ähnlich wie bei OAuth.

Melden Sie sich in GitHub an.
Klicke oben rechts auf dein Profilbild. Ein Drop-down-Menü wird angezeigt.
Klicken Sie 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 das GitHub-Objekt aufzurufen. APIs und stellt API-Kontingente für die Indexierung bereit.

Connector konfigurieren

Nachdem Sie die Anmeldedaten und die Datenquelle erstellt haben, aktualisieren Sie den Connector. konfigurieren, um diese Werte einzubeziehen:

Ändern Sie in der Befehlszeile das Verzeichnis in cloud-search-samples/end-to-end/connector/
Öffnen Sie die Datei sample-config.properties in einem Texteditor.
Legen Sie den api.serviceAccountPrivateKeyFile-Parameter auf den Dateipfad der die Sie zuvor heruntergeladen haben.
Legen Sie den Parameter api.sourceId auf die ID der Datenquelle fest, erstellt wurde.
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. Vor der Indexierung 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 indexiert in der Organisation googleworkspace. Die Indexierung des Repositorys dauert etwa eine Minute. Nach der ersten Indexierung fragt der Connector weiterhin Änderungen am die im Cloud Search-Index berücksichtigt 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 Mit der Methode main wird IndexingApplication des SDKs instanziiert und startet ihn.

GithubConnector.java

Auf GitHub ansehen

/**
 * Main entry point for the connector. Creates and starts an indexing
 * application using the {@code ListingConnector} template and the sample's
 * custom {@code Repository} implementation.
 *
 * @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 GithubRepository();
  IndexingConnector connector = new ListingConnector(repository);
  IndexingApplication application = new IndexingApplication.Builder(connector, args)
      .build();
  application.start();
}

Die ListingConnector wird eine Durchlaufstrategie implementiert, die vom SDK bereitgestellt wird. die Cloud Search-Warteschlangen nutzt zum Verfolgen des Status von Elementen im Index. Delegiert wird 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 führt der getIds() wird aufgerufen, um die zu indexierenden Elemente in die Warteschlange zu verschieben.

Der Connector kann mehrere Repositories oder Organisationen indexieren. Um die Auswirkungen von Auswirkungen eines Ausfalls, wird jeweils nur ein GitHub-Repository durchlaufen. Einen Prüfpunkt wird zurückgegeben, wobei die Ergebnisse des Durchlaufs die Liste Repositories, die bei nachfolgenden Aufrufen von getIds() indexiert werden sollen. Wenn ein Fehler erfolgt, wird die Indexierung im aktuellen Repository fortgesetzt, anstatt die Indexierung zu starten von Anfang an.

GithubRepository.java

Auf GitHub ansehen

/**
 * Gets all of the existing item IDs from the data repository. While
 * multiple repositories are supported, only one repository is traversed
 * per call. The remaining repositories are saved in the checkpoint
 * are traversed on subsequent calls. This minimizes the amount of
 * data that needs to be reindex in the event of an error.
 *
 * <p>This method is called by {@link ListingConnector#traverse()} during
 * <em>full traversals</em>. Every document ID and metadata hash value in
 * the <em>repository</em> is pushed to the Cloud Search queue. Each pushed
 * document is later polled and processed in the {@link #getDoc(Item)} method.
 * <p>
 * The metadata hash values are pushed to aid document change detection. The
 * queue sets the document status depending on the hash comparison. If the
 * pushed ID doesn't yet exist in Cloud Search, the document's status is
 * set to <em>new</em>. If the ID exists but has a mismatched hash value,
 * its status is set to <em>modified</em>. If the ID exists and matches
 * the hash value, its status is unchanged.
 *
 * <p>In every case, the pushed content hash value is only used for
 * comparison. The hash value is only set in the queue during an
 * update (see {@link #getDoc(Item)}).
 *
 * @param checkpoint value defined and maintained by this connector
 * @return this is typically a {@link PushItems} instance
 */
@Override
public CheckpointCloseableIterable<ApiOperation> getIds(byte[] checkpoint)
    throws RepositoryException {
  List<String> repositories;
  // Decode the checkpoint if present to get the list of remaining
  // repositories to index.
  if (checkpoint != null) {
    try {
      FullTraversalCheckpoint decodedCheckpoint = FullTraversalCheckpoint
          .fromBytes(checkpoint);
      repositories = decodedCheckpoint.getRemainingRepositories();
    } catch (IOException e) {
      throw new RepositoryException.Builder()
          .setErrorMessage("Unable to deserialize checkpoint")
          .setCause(e)
          .build();
    }
  } else {
    // No previous checkpoint, scan for repositories to index
    // based on the connector configuration.
    try {
      repositories = scanRepositories();
    } catch (IOException e) {
      throw toRepositoryError(e, Optional.of("Unable to scan repositories"));
    }
  }

  if (repositories.isEmpty()) {
    // Nothing left to index. Reset the checkpoint to null so the
    // next full traversal starts from the beginning
    Collection<ApiOperation> empty = Collections.emptyList();
    return new CheckpointCloseableIterableImpl.Builder<>(empty)
        .setCheckpoint((byte[]) null)
        .setHasMore(false)
        .build();
  }

  // Still have more repositories to index. Pop the next repository to
  // index off the list. The remaining repositories make up the next
  // checkpoint.
  String repositoryToIndex = repositories.get(0);
  repositories = repositories.subList(1, repositories.size());

  try {
    log.info(() -> String.format("Traversing repository %s", repositoryToIndex));
    Collection<ApiOperation> items = collectRepositoryItems(repositoryToIndex);
    FullTraversalCheckpoint newCheckpoint = new FullTraversalCheckpoint(repositories);
    return new CheckpointCloseableIterableImpl.Builder<>(items)
        .setHasMore(true)
        .setCheckpoint(newCheckpoint.toBytes())
        .build();
  } catch (IOException e) {
    String errorMessage = String.format("Unable to traverse repo: %s",
        repositoryToIndex);
    throw toRepositoryError(e, Optional.of(errorMessage));
  }
}

Mit der Methode collectRepositoryItems() wird der Durchlauf GitHub-Repository. Diese Methode gibt eine Sammlung von ApiOperations zurück. für die Elemente, die in die Warteschlange verschoben werden sollen. Elemente werden als Ressourcenname und einen Hashwert, der den aktuellen Status des Elements darstellt.

Der Hashwert wird bei nachfolgenden Durchläufen des GitHub Repositories. Dieser Wert bietet eine einfache Prüfung, um festzustellen, ohne zusätzlichen Content hochladen zu müssen. Den Anschluss blind lassen stellt alle Elemente in die Warteschlange. Wenn das Element neu ist oder sich der Hashwert geändert hat, zum Abfragen in der Warteschlange verfügbar. Andernfalls gilt das Element als unverändert.

GithubRepository.java

Auf GitHub ansehen

/**
 * Fetch IDs to  push in to the queue for all items in the repository.
 * Currently captures issues & content in the master branch.
 *
 * @param name Name of repository to index
 * @return Items to push into the queue for later indexing
 * @throws IOException if error reading issues
 */
private Collection<ApiOperation> collectRepositoryItems(String name)
    throws IOException {
  List<ApiOperation> operations = new ArrayList<>();
  GHRepository repo = github.getRepository(name);

  // Add the repository as an item to be indexed
  String metadataHash = repo.getUpdatedAt().toString();
  String resourceName = repo.getHtmlUrl().getPath();
  PushItem repositoryPushItem = new PushItem()
      .setMetadataHash(metadataHash);
  PushItems items = new PushItems.Builder()
      .addPushItem(resourceName, repositoryPushItem)
      .build();

  operations.add(items);
  // Add issues/pull requests & files
  operations.add(collectIssues(repo));
  operations.add(collectContent(repo));
  return operations;
}

Warteschlange verarbeiten

Nach Abschluss des vollständigen Durchlaufs beginnt der Connector mit dem Abfragen des für Elemente, die indexiert werden müssen. Die getDoc() für jedes aus der Warteschlange abgerufene Element aufgerufen. Die Methode liest das Element aus GitHub und konvertiert es in die richtige Darstellungsform für die Indexierung.

Der Connector wird für Live-Daten ausgeführt, die sich jederzeit ändern können. Zeit, überprüft getDoc() auch, ob das Element in der Warteschlange noch gültig ist und löscht alle nicht mehr vorhandenen Elemente aus dem Index.

GithubRepository.java

Auf GitHub ansehen

/**
 * Gets a single data repository item and indexes it if required.
 *
 * <p>This method is called by the {@link ListingConnector} during a poll
 * of the Cloud Search queue. Each queued item is processed
 * individually depending on its state in the data repository.
 *
 * @param item the data repository item to retrieve
 * @return the item's state determines which type of
 * {@link ApiOperation} is returned:
 * {@link RepositoryDoc}, {@link DeleteItem}, or {@link PushItem}
 */
@Override
public ApiOperation getDoc(Item item) throws RepositoryException {
  log.info(() -> String.format("Processing item: %s ", item.getName()));
  Object githubObject;
  try {
    // Retrieve the item from GitHub
    githubObject = getGithubObject(item.getName());
    if (githubObject instanceof GHRepository) {
      return indexItem((GHRepository) githubObject, item);
    } else if (githubObject instanceof GHPullRequest) {
      return indexItem((GHPullRequest) githubObject, item);
    } else if (githubObject instanceof GHIssue) {
      return indexItem((GHIssue) githubObject, item);
    } else if (githubObject instanceof GHContent) {
      return indexItem((GHContent) githubObject, item);
    } else {
      String errorMessage = String.format("Unexpected item received: %s",
          item.getName());
      throw new RepositoryException.Builder()
          .setErrorMessage(errorMessage)
          .setErrorType(RepositoryException.ErrorType.UNKNOWN)
          .build();
    }
  } catch (FileNotFoundException e) {
    log.info(() -> String.format("Deleting item: %s ", item.getName()));
    return ApiOperations.deleteItem(item.getName());
  } catch (IOException e) {
    String errorMessage = String.format("Unable to retrieve item: %s",
        item.getName());
    throw toRepositoryError(e, Optional.of(errorMessage));
  }
}

Für jedes vom Connector indexierte GitHub-Objekt sowie das entsprechende Die Methode indexItem() erstellt die Elementdarstellung für Cloud Search So erstellen Sie beispielsweise die Darstellung von Inhaltselementen:

GithubRepository.java

Auf GitHub ansehen

/**
 * Build the ApiOperation to index a content item (file).
 *
 * @param content      Content item to index
 * @param previousItem Previous item state in the index
 * @return ApiOperation (RepositoryDoc if indexing,  PushItem if not modified)
 * @throws IOException if unable to create operation
 */
private ApiOperation indexItem(GHContent content, Item previousItem)
    throws IOException {
  String metadataHash = content.getSha();

  // If previously indexed and unchanged, just requeue as unmodified
  if (canSkipIndexing(previousItem, metadataHash)) {
    return notModified(previousItem.getName());
  }

  String resourceName = new URL(content.getHtmlUrl()).getPath();
  FieldOrValue<String> title = FieldOrValue.withValue(content.getName());
  FieldOrValue<String> url = FieldOrValue.withValue(content.getHtmlUrl());

  String containerName = content.getOwner().getHtmlUrl().getPath();
  String programmingLanguage = FileExtensions.getLanguageForFile(content.getName());

  // Structured data based on the schema
  Multimap<String, Object> structuredData = ArrayListMultimap.create();
  structuredData.put("organization", content.getOwner().getOwnerName());
  structuredData.put("repository", content.getOwner().getName());
  structuredData.put("path", content.getPath());
  structuredData.put("language", programmingLanguage);

  Item item = IndexingItemBuilder.fromConfiguration(resourceName)
      .setTitle(title)
      .setContainerName(containerName)
      .setSourceRepositoryUrl(url)
      .setItemType(IndexingItemBuilder.ItemType.CONTAINER_ITEM)
      .setObjectType("file")
      .setValues(structuredData)
      .setVersion(Longs.toByteArray(System.currentTimeMillis()))
      .setHash(content.getSha())
      .build();

  // Index the file content too
  String mimeType = FileTypeMap.getDefaultFileTypeMap()
      .getContentType(content.getName());
  AbstractInputStreamContent fileContent = new InputStreamContent(
      mimeType, content.read())
      .setLength(content.getSize())
      .setCloseInputStream(true);
  return new RepositoryDoc.Builder()
      .setItem(item)
      .setContent(fileContent, IndexingService.ContentFormat.RAW)
      .setRequestMode(IndexingService.RequestMode.SYNCHRONOUS)
      .build();
}

Stellen Sie als Nächstes die Suchoberfläche bereit.

Zurück Weiter