En esta página del instructivo de Cloud Search, se muestra cómo configurar una fuente de datos y conector de contenido para indexar datos. Para comenzar desde el principio de este instructivo, consulta Instructivo para comenzar a usar Cloud Search
Compila el conector
Cambia tu directorio de trabajo a cloud-search-samples/end-to-end/connector
.
y ejecuta este comando:
mvn package -DskipTests
El comando descarga las dependencias necesarias para compilar la y compila el código.
Crea credenciales de cuenta de servicio
El conector requiere credenciales de cuenta de servicio para llamar a Cloud Search APIs 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. El campo “Credencial” .
- Haz clic en la lista desplegable + CREAR CREDENCIALES y selecciona la opción correspondiente. Cuenta de servicio. La opción “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. La sección “Permisos de cuenta de servicio (opcional)” .
- Haz clic en CONTINUAR. La opción "Otorga a usuarios acceso a esta cuenta de servicio (opcional)" .
- Haz clic en LISTO. El panel “Credenciales” aparecerá una pantalla.
- En Cuentas de servicio, haz clic en el correo electrónico de la cuenta de servicio. La fase de cambio detalles de la cuenta" apples de página.
- En Claves, haz clic en la lista desplegable AGREGAR CLAVE y selecciona Crea una clave nueva. La opción “Crear clave privada” .
- Haz clic en CREAR.
- (opcional) Si el botón "¿Deseas permitir descargas console.cloud.google.com?” haz clic en Permitir.
- Se guardará un archivo de claves privadas en tu computadora. Anota la ubicación del archivo descargado. Este archivo se usa para configurar el conector de contenido de modo que puede autenticarse cuando 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 APIs de terceros la compatibilidad con 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 sitios web credenciales de aplicaciones. Obtén instrucciones para crear una aplicación web credenciales, 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: kubectl. Asegúrate de sustituir
[YOUR_ACCESS_TOKEN]
por el token que obtuviste en 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 el proceso es satisfactorio, 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 inicializa 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 la el campo
done
se estableció 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. La sección “Administración de Google Apps” .
- Haz clic en Google Workspace. La sección “Administración de apps de Google Workspace” .
- Desplázate hacia abajo y haz clic en Cloud Search. La “Configuración de Google Workspace” página .
- Haz clic en Fuentes de datos de terceros. El panel “Fuentes de datos” .
- Haz clic en el signo + redondo amarillo. La sección "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 el de correo electrónico de la cuenta de servicio, busca el valor en el cuentas de servicio .
- Haz clic en AGREGAR. La fuente “Se creó correctamente la fuente de datos” .
- Haz clic en *Aceptar. Toma nota del ID de origen de la fuente de datos recién creada. El El ID de fuente 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 tengan una cuota suficiente. Para simplificar, el conector aprovecha tokens de acceso en lugar de OAuth. Los tokens personales permiten autenticarse un 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 al GitHub APIs y proporciona cuota de API para realizar la indexación.
Configura el conector
Después de crear las credenciales y la fuente de datos, actualiza el conector. de Terraform 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 la las credenciales del servicio que descargaste anteriormente. - Establece el parámetro
api.sourceId
en el ID de la fuente de datos que creados previamente. - 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 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 único repositorio
de 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 si hay cambios en la
que se deben reflejar 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
El método main
crea una instancia del IndexingApplication
del SDK.
y lo inicia.
La ListingConnector
proporcionados por el SDK implementa una estrategia de recorrido
que aprovecha las colas de Cloud Search
para hacer un seguimiento del estado de los elementos en el índice. Se delega a GithubRepository
,
que implementa el conector de muestra para acceder al contenido de GitHub.
Explora los repositorios de GitHub
Durante los recorridos completos, la getIds()
para enviar a la cola elementos que deban indexarse.
El conector puede indexar varios repositorios y distintas organizaciones. Para minimizar el
de un error, se recorre un repositorio de GitHub a la vez. Un punto de control
se devuelve con los resultados del recorrido que contiene la lista de
repositorios que se indexarán en 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 representan los elementos que se enviarán a la cola. Los elementos se envían
nombre del recurso y un valor de hash que representa el estado actual del elemento.
El valor de hash se usa en los recorridos posteriores de GitHub. de Cloud Storage. Este valor proporciona una verificación ligera para determinar si el contenido cambió sin tener que subir contenido adicional. El conector a ciegas pone en fila todos los elementos. Si el elemento es nuevo o cambió el valor de hash, se crea 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, el conector comienza a sondear
para los elementos que deben indexarse. La getDoc()
para cada elemento extraído 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 activos que pueden modificarse en cualquier
getDoc()
también verifica que el elemento de la fila 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 correspondiente
El método indexItem()
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.