Эта страница переведена с помощью 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:

Ваш проект платформы Cloud Search содержит учётные данные сервисной учётной записи. Однако для инициализации сторонней поддержки необходимо создать учётные данные веб-приложения. Инструкции по созданию учётных данных веб-приложения см. в разделе Создание учётных данных . После выполнения этого шага у вас должен быть файл с идентификатором клиента и секретным ключом клиента.
Воспользуйтесь площадкой OAuth 2 от Google для получения токена доступа:
1. Нажмите «Настройки» и установите флажок «Использовать собственные учетные данные для авторизации» .
2. Введите идентификатор клиента и секретный код клиента из шага 1.
3. Нажмите «Закрыть» .
4. В поле «Области действия» введите https://www.googleapis.com/auth/cloud_search.settings и нажмите «Авторизовать» . Площадка OAuth 2 возвращает код авторизации.
5. Нажмите «Обменять код авторизации на токены» . Возвращается токен.
Чтобы инициализировать стороннюю поддержку Cloud Search, используйте следующую команду curl. Не забудьте заменить [YOUR_ACCESS_TOKEN] на токен, полученный на шаге 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
```
В случае успеха тело ответа содержит экземпляр operation . Например:
```
{
name: "operations/customers/01b3fqdm/lro/AOIL6eBv7fEfiZ_hUSpm8KQDt1Mnd6dj5Ru3MXf-jri4xK6Pyb2-Lwfn8vQKg74pgxlxjrY"
}
```
В случае неудачи обратитесь в службу поддержки Cloud Search.

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

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

После завершения сторонней инициализации поле done будет установлено в true . Например:

{
name: "operations/customers/01b3fqdm/lro/AOIL6eBv7fEfiZ_hUSpm8KQDt1Mnd6dj5Ru3MXf-jri4xK6Pyb2-Lwfn8vQKg74pgxlxjrY"
done: true
}

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

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

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

Создайте персональный токен доступа для 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

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

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