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:
- Regresa a la consola de Google Cloud.
- En el panel de navegación izquierdo, haz clic en Credenciales. Aparecerá la página "Credencial".
- Haz clic en la lista desplegable + CREAR CREDENCIALES y selecciona Cuenta de servicio. Aparecerá la página “Crear cuenta de servicio”.
- En el campo Nombre de la cuenta de servicio, escribe "instructivo".
- 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.
- Haz clic en CREAR. Aparecerá el diálogo "Permisos de cuenta de servicio (opcional)".
- Haz clic en CONTINUAR. Aparecerá el diálogo “Otorgar a los usuarios acceso a esta cuenta de servicio (opcional)”.
- Haz clic en LISTO. Aparecerá la pantalla "Credentials".
- 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).
- En Claves, haz clic en la lista desplegable AGREGAR CLAVE y selecciona Crear clave nueva. Aparecerá el diálogo "Crear clave privada".
- Haz clic en CREAR.
- (Opcional) Si aparece el diálogo “¿Quieres permitir descargas en console.cloud.google.com?”, haz clic en Permitir.
- 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:
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.
Usa OAuth 2 Playground de Google para obtener un token de acceso:
- Haz clic en Configuración y marca la opción Usa tus propias credenciales de autenticación.
- Ingresa el ID de cliente y el secreto del cliente del paso 1.
- Haz clic en Cerrar.
- 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. - Haz clic en Intercambiar código de autorización para tokens. Se muestra un token.
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.
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 entrue
. 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.
- Abre la Consola del administrador de Google.
- Haz clic en el ícono Aplicaciones. Aparecerá la página "Administración de aplicaciones".
- Haz clic en Google Workspace. Aparecerá la página “Apps y administración de Google Workspace”.
- Desplázate hacia abajo y haz clic en Cloud Search. Aparecerá la página “Configuración de Google Workspace”.
- Haz clic en Fuentes de datos de terceros. Aparecerá la página "Fuentes de datos".
- Haz clic en el signo + redondo amarillo. Se mostrará el diálogo "Agregar nueva fuente de datos".
- En el campo Nombre visible, escribe "instructivo".
- 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.
- Haz clic en AGREGAR. Aparecerá el diálogo “La fuente de datos se creó correctamente”.
- 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.
- Accede a GitHub.
- En la esquina superior derecha, haz clic en tu foto de perfil. Aparecerá un menú desplegable.
- Haz clic en Configuración.
- Haz clic en Configuración para desarrolladores.
- Haz clic en Personal access tokens.
- Haz clic en Generate personal access token.
- En el campo Nota, ingresa “Instructivo de Cloud Search”.
- Verifica el alcance public_repo.
- Haz clic en Generate token.
- 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:
- Desde la línea de comandos, cambia el directorio a
cloud-search-samples/end-to-end/connector/
. - Abre el archivo
sample-config.properties
con un editor de texto. - Establece el parámetro
api.serviceAccountPrivateKeyFile
en la ruta de acceso al archivo de las credenciales de servicio que descargaste antes. - Establece el parámetro
api.sourceId
en el ID de la fuente de datos que creaste antes. - Establece el parámetro
github.user
en tu nombre de usuario de GitHub. - Establece el parámetro
github.token
en el token de acceso que creaste con anterioridad. - 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.
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.
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.
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.
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:
A continuación, implementa la interfaz de búsqueda.