Implementa el conector

En esta página del instructivo de Cloud Search, se muestra cómo configurar una fuente de datos y un conector de contenido para indexar datos. Para comenzar desde el principio de este instructivo, consulta el instructivo de introducción a Cloud Search.

Compila el conector

Cambia tu directorio de trabajo al directorio cloud-search-samples/end-to-end/connector y ejecuta este comando:

mvn package -DskipTests

El comando descarga las dependencias necesarias para compilar el conector de contenido y compila el código.

Crea credenciales de cuenta de servicio

El conector requiere credenciales de cuenta de servicio para llamar a las APIs de Cloud Search. Para crear las credenciales, sigue estos pasos:

1. Regresa a la consola de Google Cloud.
2. En el panel de navegación izquierdo, haz clic en Credenciales. Aparecerá la página "Credencial".
3. Haz clic en la lista desplegable + CREAR CREDENCIALES y selecciona Cuenta de servicio. Aparecerá la página “Crear cuenta de servicio”.
4. En el campo Nombre de la cuenta de servicio, escribe "instructivo".
5. Anota el valor del ID de la cuenta de servicio (justo después del nombre de la cuenta de servicio). Este valor se usa más adelante.
6. Haz clic en CREAR. Aparecerá el diálogo "Permisos de cuenta de servicio (opcional)".
7. Haz clic en CONTINUAR. Aparecerá el diálogo “Otorgar a los usuarios acceso a esta cuenta de servicio (opcional)”.
8. Haz clic en LISTO. Aparecerá la pantalla "Credentials".
9. En Cuentas de servicio, haz clic en el correo electrónico de la cuenta de servicio. Los aplicadores de la página “Detalles de la cuenta de servicio” (Service account details).
10. En Claves, haz clic en la lista desplegable AGREGAR CLAVE y selecciona Crear clave nueva. Aparecerá el diálogo "Crear clave privada".
11. Haz clic en CREAR.
12. (Opcional) Si aparece el diálogo “¿Quieres permitir descargas en console.cloud.google.com?”, haz clic en Permitir.
13. Se guardará un archivo de claves privadas en tu computadora. Toma nota de la ubicación del archivo descargado. Este archivo se usa para configurar el conector de contenido de modo que pueda autenticarse cuando se llama a las APIs de Google Cloud Search.

Inicializa la asistencia de terceros

Antes de llamar a cualquier otra API de Cloud Search, debes inicializar la compatibilidad de terceros para Google Cloud Search.

Para inicializar la compatibilidad de terceros con Cloud Search, sigue estos pasos:

1. Tu proyecto de la plataforma de Cloud Search contiene credenciales de cuenta de servicio. Sin embargo, para inicializar la asistencia de terceros, debes crear credenciales de aplicaciones web. Si quieres obtener instrucciones para crear credenciales de aplicaciones web, consulta Crea credenciales. Después de completar este paso, deberías tener un ID de cliente y un archivo de secreto del cliente.

2. Usa OAuth 2 Playground de Google para obtener un token de acceso:

   1. Haz clic en Configuración y marca la opción Usa tus propias credenciales de autenticación.
   2. Ingresa el ID de cliente y el secreto del cliente del paso 1.
   3. Haz clic en Cerrar.
   4. En el campo de permisos, escribe https://www.googleapis.com/auth/cloud_search.settings y haz clic en Autorizar. OAuth 2 Playground muestra un código de autorización.
   5. Haz clic en Intercambiar código de autorización para tokens. Se muestra un token.

3. Para inicializar la asistencia de terceros para Cloud Search, usa el siguiente comando curl. Asegúrate de sustituir [YOUR_ACCESS_TOKEN] por el token que obtuviste en el paso 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
   

   Si se ejecuta de forma correcta, el cuerpo de la respuesta contiene una instancia de operation. Por ejemplo:

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

   Si el problema persiste, comunícate con el equipo de asistencia de Cloud Search.

4. Usa operations.get para verificar que se inicializó la asistencia de terceros:

   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
   

   Cuando se completa la inicialización del tercero, contiene el campo done establecido en true. Por ejemplo:

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

Cómo crear la fuente de datos

A continuación, crea una fuente de datos en la Consola del administrador. La fuente de datos proporciona un espacio de nombres para indexar contenido mediante el conector.

1. Abre la Consola del administrador de Google.
2. Haz clic en el ícono Aplicaciones. Aparecerá la página "Administración de aplicaciones".
3. Haz clic en Google Workspace. Aparecerá la página “Apps y administración de Google Workspace”.
4. Desplázate hacia abajo y haz clic en Cloud Search. Aparecerá la página “Configuración de Google Workspace”.
5. Haz clic en Fuentes de datos de terceros. Aparecerá la página "Fuentes de datos".
6. Haz clic en el signo + redondo amarillo. Se mostrará el diálogo "Agregar nueva fuente de datos".
7. En el campo Nombre visible, escribe "instructivo".
8. En el campo Direcciones de correo electrónico de la cuenta de servicio, ingresa la dirección de correo electrónico de la cuenta de servicio que creaste en la sección anterior. Si no conoces la dirección de correo electrónico de la cuenta de servicio, busca el valor en la página de las cuentas de servicio.
9. Haz clic en AGREGAR. Aparecerá el diálogo “La fuente de datos se creó correctamente”.
10. Haz clic en *Aceptar. Toma nota del ID de origen de la fuente de datos recién creada. El ID de origen se usa para configurar el conector de contenido.

Genera un token de acceso personal para la API de GitHub

El conector requiere acceso autenticado a la API de GitHub para tener suficiente cuota. Para simplificar, el conector aprovecha los tokens de acceso personales en lugar de OAuth. Los tokens personales permiten autenticarse como usuario con un conjunto limitado de permisos similares a OAuth.

1. Accede a GitHub.
2. En la esquina superior derecha, haz clic en tu foto de perfil. Aparecerá un menú desplegable.
3. Haz clic en Configuración.
4. Haz clic en Configuración para desarrolladores.
5. Haz clic en Personal access tokens.
6. Haz clic en Generate personal access token.
7. En el campo Nota, ingresa “Instructivo de Cloud Search”.
8. Verifica el alcance public_repo.
9. Haz clic en Generate token.
10. Toma nota del token generado. El conector lo usa para llamar a las APIs de GitHub y proporciona una cuota de API para realizar la indexación.

Configura el conector

Después de crear las credenciales y la fuente de datos, actualiza la configuración del conector para incluir estos valores:

1. Desde la línea de comandos, cambia el directorio a cloud-search-samples/end-to-end/connector/.
2. Abre el archivo sample-config.properties con un editor de texto.
3. Establece el parámetro api.serviceAccountPrivateKeyFile en la ruta de acceso al archivo de las credenciales de servicio que descargaste antes.
4. Establece el parámetro api.sourceId en el ID de la fuente de datos que creaste antes.
5. Establece el parámetro github.user en tu nombre de usuario de GitHub.
6. Establece el parámetro github.token en el token de acceso que creaste con anterioridad.
7. Guarda el archivo.

Actualiza el esquema

El conector indexa contenido estructurado y no estructurado. Antes de indexar datos, debes actualizar el esquema de la fuente de datos. Ejecuta el siguiente comando para actualizar el esquema:

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

Ejecución del conector

Para ejecutar el conector y comenzar la indexación, ejecuta el siguiente comando:

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

La configuración predeterminada del conector es indexar un solo repositorio en la organización googleworkspace. La indexación del repositorio tarda alrededor de 1 minuto. Después de la indexación inicial, el conector continúa sondeando en busca de cambios en el repositorio que deban reflejarse en el índice de Cloud Search.

Revisa el código

En las secciones restantes, se examina cómo se compila el conector.

Inicia la aplicación

El punto de entrada al conector es la clase GithubConnector. El método main crea una instancia del IndexingApplication del SDK y lo inicia.

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

El ListingConnector proporcionado por el SDK implementa una estrategia de recorrido que aprovecha las colas de Cloud Search para realizar un seguimiento del estado de los elementos en el índice. Se delega a GithubRepository, implementado por el conector de muestra, para acceder al contenido desde GitHub.

Explora los repositorios de GitHub

Durante los recorridos completos, se llama al método getIds() para enviar a la cola elementos que tal vez deban indexarse.

El conector puede indexar varios repositorios y distintas organizaciones. Para minimizar el impacto de una falla, se recorre un repositorio de GitHub a la vez. Se muestra un punto de control con los resultados del recorrido que contiene la lista de repositorios que se indexarán en las llamadas posteriores a getIds(). Si se produce un error, la indexación se reanuda en el repositorio actual, en lugar de iniciarse desde el principio.

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

El método collectRepositoryItems() controla el recorrido de un solo repositorio de GitHub. Este método muestra una colección de ApiOperations que representa los elementos que se enviarán a la cola. Los elementos se envían como un nombre de recurso y un valor de hash que representa el estado actual del elemento.

El valor de hash se usa en los recorridos posteriores de los repositorios de GitHub. Este valor proporciona una verificación ligera para determinar si el contenido cambió sin tener que subir contenido adicional. El conector pone en cola todos los elementos a ciegas. Si el elemento es nuevo o el valor de hash cambió, está disponible para el sondeo en la cola. De lo contrario, el elemento se considera sin modificar.

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

Procesa la cola

Una vez que se completa el recorrido completo, el conector comienza a sondear la cola en busca de elementos que deben indexarse. Se llama al método getDoc() para cada elemento que se extrae de la cola. El método lee el elemento de GitHub y lo convierte en la representación adecuada para la indexación.

Como el conector se ejecuta con datos en vivo que pueden modificarse en cualquier momento, getDoc() también verifica que el elemento de la cola siga siendo válido y borra los elementos del índice que ya no existen.

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

Para cada uno de los objetos de GitHub que el conector indexa, el método indexItem() correspondiente controla la compilación de la representación del elemento para Cloud Search. Por ejemplo, para compilar la representación de los elementos de contenido, haz lo siguiente:

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

A continuación, implementa la interfaz de búsqueda.

Anterior Siguiente