Эта страница переведена с помощью Cloud Translation API.

Разверните соединитель

На этой странице руководства по Cloud Search показано, как настроить источник данных и коннектор контента для индексирования данных. Чтобы начать работу с самого начала этого руководства, обратитесь к руководству по началу работы с Cloud Search.

Создайте коннектор

Перейдите в рабочую директорию cloud-search-samples/end-to-end/connector и выполните следующую команду:

mvn package -DskipTests

Эта команда загружает необходимые зависимости для создания коннектора контента и компилирует код.

Создать учетные данные сервисной учетной записи

Для вызова API Cloud Search коннектору требуются учетные данные сервисной учетной записи. Чтобы создать учетные данные:

Вернуться в консоль Google Cloud .
В левой панели навигации нажмите «Учетные данные» . Откроется страница «Учетные данные».
Нажмите на выпадающий список «+ СОЗДАТЬ УЧЕТНЫЕ ДАННЫЕ» и выберите «Учетная запись службы ». Откроется страница «Создать учетную запись службы».
В поле « Имя учетной записи службы » введите «tutorial».
Обратите внимание на значение идентификатора учетной записи службы (сразу после имени учетной записи службы). Это значение будет использоваться далее.
Нажмите кнопку СОЗДАТЬ . Откроется диалоговое окно «Разрешения учетной записи службы (необязательно)».
Нажмите ПРОДОЛЖИТЬ . Откроется диалоговое окно «Предоставить пользователям доступ к этой учетной записи службы (необязательно)».
Нажмите кнопку ГОТОВО . Откроется экран «Учетные данные».
В разделе «Сервисные учетные записи» щелкните по адресу электронной почты сервисной учетной записи. Откроется страница с «подробными сведениями о сервисной учетной записи».
В разделе «Ключи» щелкните раскрывающийся список «ДОБАВИТЬ КЛЮЧ» и выберите «Создать новый ключ ». Откроется диалоговое окно «Создать закрытый ключ».
Нажмите СОЗДАТЬ .
(необязательно) Если появится диалоговое окно «Разрешить ли загрузку файлов на console.cloud.google.com?», нажмите «Разрешить ».
Файл закрытого ключа сохранен на вашем компьютере. Запомните местоположение загруженного файла. Этот файл используется для настройки коннектора контента, чтобы он мог проходить аутентификацию при вызове API Google Cloud Search.

Инициализация поддержки сторонних организаций

Перед вызовом любых других API Cloud Search необходимо инициализировать поддержку сторонних сервисов для Google Cloud Search.

Для инициализации поддержки сторонних сервисов:

Создайте учетные данные веб-приложения в проекте платформы Cloud Search. См. раздел «Создание учетных данных» . Вам понадобятся идентификатор клиента и секретный ключ клиента.
Получите токен доступа, используя OAuth 2.0 Playground :
1. Нажмите «Конфигурация OAuth 2.0» (значок настроек) и установите флажок «Использовать собственные учетные данные OAuth» .
2. Введите свой идентификатор клиента и секретный ключ клиента.
3. В поле «Области действия» введите https://www.googleapis.com/auth/cloud_search.settings и нажмите «Авторизовать API» .
4. Нажмите «Код авторизации биржи для получения токенов» .
Выполните следующую команду curl, заменив [YOUR_ACCESS_TOKEN] на ваш токен:
```
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
```
В случае успеха тело ответа будет содержать описание operation . В случае неудачи обратитесь в службу поддержки Cloud Search.

Используйте operations.get для проверки инициализации:

curl 'https://cloudsearch.googleapis.com/v1/operations/<var>operation_name</var>?key=[YOUR_API_KEY]' \
--header 'Authorization: Bearer [YOUR_ACCESS_TOKEN]' \
--header 'Accept: application/json' \
--compressed

Инициализация считается завершенной, когда done равно true .

Создайте источник данных

Далее создайте источник данных в консоли администратора. Источник данных предоставляет пространство имен для индексирования контента с помощью коннектора.

Откройте консоль администратора Google .
Нажмите на значок «Приложения». Откроется страница «Администрирование приложений».
Нажмите «Google Workspace» . Откроется страница «Администрирование приложений Google Workspace».
Прокрутите вниз и нажмите «Облачный поиск ». Откроется страница «Настройки Google Workspace».
Нажмите «Сторонние источники данных ». Откроется страница «Источники данных».
Нажмите на круглую желтую кнопку «+» . Откроется диалоговое окно «Добавить новый источник данных».
В поле «Отображаемое имя » введите «tutorial».
В поле «Адреса электронной почты учетных записей служб» введите адрес электронной почты учетной записи службы, созданной вами в предыдущем разделе. Если вы не знаете адрес электронной почты учетной записи службы, найдите это значение на странице учетных записей служб .
Нажмите кнопку ДОБАВИТЬ . Откроется диалоговое окно «Источник данных успешно создан».
Нажмите * ОК . Запишите идентификатор источника для только что созданного источника данных. Идентификатор источника используется для настройки коннектора контента.

Сгенерируйте персональный токен доступа для API GitHub.

Для обеспечения достаточного объема квоты коннектору требуется аутентифицированный доступ к API GitHub. Для простоты коннектор использует персональные токены доступа вместо OAuth. Персональные токены позволяют аутентифицироваться как пользователь с ограниченным набором прав, аналогично OAuth.

Войдите в GitHub.
В правом верхнем углу нажмите на свою фотографию профиля. Появится выпадающее меню.
Нажмите «Настройки» .
Нажмите «Настройки разработчика» .
Нажмите «Персональные токены доступа» .
Нажмите «Сгенерировать персональный токен доступа» .
В поле «Примечание » введите «Учебное пособие по поиску в облаке».
Проверьте область видимости public_repo .
Нажмите «Сгенерировать токен» .
Обратите внимание на сгенерированный токен. Он используется коннектором для вызова API GitHub и предоставляет квоту API для выполнения индексирования.

Настройте коннектор

После создания учетных данных и источника данных обновите конфигурацию коннектора, добавив следующие значения:

В командной строке перейдите в каталог cloud-search-samples/end-to-end/connector/ .
Откройте файл sample-config.properties с помощью текстового редактора.
Установите параметр api.serviceAccountPrivateKeyFile равным пути к файлу учетных данных службы, которые вы ранее загрузили.
Установите параметр api.sourceId равным идентификатору ранее созданного источника данных.
Установите параметр github.user равным вашему имени пользователя на GitHub.
Установите параметр github.token равным ранее созданному вами токену доступа.
Сохраните файл.

Обновите схему

Коннектор индексирует как структурированный, так и неструктурированный контент. Перед индексированием данных необходимо обновить схему источника данных. Для обновления схемы выполните следующую команду:

mvn exec:java -Dexec.mainClass=com.google.cloudsearch.tutorial.SchemaTool \
    -Dexec.args="-Dconfig=sample-config.properties"

Запустите коннектор

Чтобы запустить коннектор и начать индексирование, выполните команду:

mvn exec:java -Dexec.mainClass=com.google.cloudsearch.tutorial.GithubConnector \
    -Dexec.args="-Dconfig=sample-config.properties"

По умолчанию коннектор индексирует один репозиторий в организации googleworkspace . Индексирование репозитория занимает около 1 минуты. После первоначального индексирования коннектор продолжает опрашивать репозиторий на предмет изменений, которые необходимо отразить в индексе Cloud Search.

Проверка кода

В оставшихся разделах рассматривается конструкция разъема.

Запуск приложения

Точкой входа в коннектор является класс GithubConnector . Метод main создает экземпляр IndexingApplication из SDK и запускает его.

GithubConnector.java

Посмотреть на GitHub

/**
 * 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();
}

ListingConnector предоставляемый SDK, реализует стратегию обхода, использующую очереди Cloud Search для отслеживания состояния элементов в индексе. Он делегирует доступ к контенту из GitHub компоненту GithubRepository , реализованному в примере коннектора.

Обход репозиториев GitHub

При полном обходе каталога вызывается метод getIds() для добавления в очередь элементов, которые могут потребовать индексации.

Коннектор может индексировать несколько репозиториев или организаций. Чтобы минимизировать последствия сбоя, индексация выполняется по одному репозиторию GitHub за раз. Возвращается контрольная точка с результатами индексации, содержащая список репозиториев, которые будут индексироваться в последующих вызовах функции getIds() . В случае ошибки индексация возобновляется с текущего репозитория, а не начинается с начала.

GithubRepository.java

Посмотреть на GitHub

/**
 * 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));
  }
}

Метод collectRepositoryItems() обрабатывает обход отдельного репозитория GitHub. Этот метод возвращает коллекцию ApiOperations , представляющих элементы, которые необходимо добавить в очередь. Элементы добавляются в виде имени ресурса и хеш-значения, представляющего текущее состояние элемента.

Хэш-значение используется при последующих обходах репозиториев GitHub. Это значение обеспечивает упрощенную проверку, позволяющую определить, изменилось ли содержимое, без необходимости загрузки дополнительного контента. Коннектор автоматически ставит все элементы в очередь. Если элемент новый или хэш-значение изменилось, он становится доступным для опроса в очереди. В противном случае элемент считается неизмененным.

GithubRepository.java

Посмотреть на GitHub

/**
 * 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;
}

Обработка очереди

После завершения полного обхода коннектор начинает опрашивать очередь на наличие элементов, которые необходимо проиндексировать. Метод getDoc() вызывается для каждого элемента, извлеченного из очереди. Этот метод считывает элемент из GitHub и преобразует его в соответствующее представление для индексации.

Поскольку коннектор работает с данными в реальном времени, которые могут изменяться в любой момент, getDoc() также проверяет, что элемент в очереди по-прежнему действителен, и удаляет из индекса все элементы, которые больше не существуют.

GithubRepository.java

Посмотреть на GitHub

/**
 * 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));
  }
}

Для каждого из объектов GitHub, индексируемых коннектором, соответствующий метод indexItem() отвечает за создание представления элемента для Cloud Search. Например, для создания представления элементов контента:

GithubRepository.java

Посмотреть на GitHub

/**
 * 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();
}

Далее разверните интерфейс поиска.

Предыдущая Следующая

Разверните соединитель Оптимизируйте свои подборки Сохраняйте и классифицируйте контент в соответствии со своими настройками.

Создайте коннектор

Создать учетные данные сервисной учетной записи

Инициализация поддержки сторонних организаций

Создайте источник данных

Сгенерируйте персональный токен доступа для API GitHub.

Настройте коннектор

Обновите схему

Запустите коннектор

Проверка кода

Запуск приложения

Обход репозиториев GitHub

Обработка очереди

Разверните соединитель