Questa pagina del tutorial su Cloud Search mostra come configurare un'origine dati e un connettore di contenuti per l'indicizzazione dei dati. Per iniziare dall'inizio di questo tutorial, consulta Tutorial introduttivo su Cloud Search
Crea il connettore
Cambia la directory di lavoro nella directory cloud-search-samples/end-to-end/connector
ed esegui questo comando:
mvn package -DskipTests
Il comando scarica le dipendenze necessarie per creare il connettore di contenuti e compila il codice.
Crea le credenziali del service account
Il connettore richiede le credenziali dell'account di servizio per chiamare le API Cloud Search. Per creare le credenziali:
- Torna alla console Google Cloud.
- Nel menu di navigazione a sinistra, fai clic su Credenziali. Viene visualizzata la pagina "Credenziale".
- Fai clic sull'elenco a discesa + CREA CREDENZIALI e seleziona Account di servizio. Viene visualizzata la pagina "Crea account di servizio".
- Nel campo Nome account di servizio, inserisci "tutorial".
- Prendi nota del valore dell'ID account di servizio, subito dopo il nome dell'account di servizio. Questo valore verrà utilizzato in seguito.
- Fai clic su CREA. Viene visualizzata la finestra di dialogo "Autorizzazioni account di servizio (facoltativo)".
- Fai clic su CONTINUA. Viene visualizzata la finestra di dialogo "Concedi agli utenti l'accesso a questo account di servizio (facoltativo)".
- Fai clic su FINE. Viene visualizzata la schermata "Credenziali".
- In Account di servizio, fai clic sull'indirizzo email dell'account di servizio. Viene visualizzata la pagina "Dettagli account di servizio".
- In Chiavi, fai clic sull'elenco a discesa AGGIUNGI CHIAVE e seleziona Crea nuova chiave. Viene visualizzata la finestra di dialogo "Crea chiave privata".
- Fai clic su CREA.
- (Facoltativo) Se viene visualizzata la finestra di dialogo "Vuoi consentire i download su console.cloud.google.com?", fai clic su Consenti.
- Sul computer viene salvato un file della chiave privata. Prendi nota della posizione del file scaricato. Questo file viene utilizzato per configurare il connettore di contenuti in modo che possa eseguire l'autenticazione quando chiami le API Google Cloud Search.
Inizializzare l'assistenza di terze parti
Prima di poter chiamare qualsiasi altra API Cloud Search, devi inizializzare il supporto di terze parti per Google Cloud Search.
Per inizializzare il supporto di terze parti per Cloud Search:
Il progetto della piattaforma Cloud Search contiene le credenziali dell'account di servizio. Tuttavia, per inizializzare il supporto di terze parti, devi creare le credenziali per l'applicazione web. Per istruzioni su come creare le credenziali dell'applicazione web, consulta la pagina Creare credenziali. Una volta completato questo passaggio, dovresti avere un ID cliente e un file client secret.
Utilizza OAuth 2 Playground di Google per ottenere un token di accesso:
- Fai clic su Impostazioni e seleziona Utilizza le tue credenziali di autenticazione.
- Inserisci l'ID client e il client secret del passaggio 1.
- Fai clic su Chiudi.
- Nel campo Ambiti, digita
https://www.googleapis.com/auth/cloud_search.settings
e fai clic su Autorizza. Il Playground OAuth 2 restituisce un codice di autorizzazione. - Fai clic su Exchange Authorization code for tokens (Scambia codice di autorizzazione per i token). Viene restituito un token.
Per inizializzare il supporto di terze parti per Cloud Search, utilizza il seguente comando curl. Assicurati di sostituire
[YOUR_ACCESS_TOKEN]
con il token ottenuto nel passaggio 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
In caso di esito positivo, il corpo della risposta contiene un'istanza di
operation
. Ad esempio:{ name: "operations/customers/01b3fqdm/lro/AOIL6eBv7fEfiZ_hUSpm8KQDt1Mnd6dj5Ru3MXf-jri4xK6Pyb2-Lwfn8vQKg74pgxlxjrY" }
In caso contrario, contatta l'assistenza di Cloud Search.
Utilizza operations.get per verificare che il supporto di terze parti sia inizializzato:
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
Una volta completata l'inizializzazione di terze parti, contiene il campo
done
impostato sutrue
. Ad esempio:{ name: "operations/customers/01b3fqdm/lro/AOIL6eBv7fEfiZ_hUSpm8KQDt1Mnd6dj5Ru3MXf-jri4xK6Pyb2-Lwfn8vQKg74pgxlxjrY" done: true }
Creare l'origine dati
A questo punto, crea un'origine dati nella Console di amministrazione. L'origine dati fornisce uno spazio dei nomi per l'indicizzazione dei contenuti utilizzando il connettore.
- Apri la Console di amministrazione Google.
- Fai clic sull'icona App. Viene visualizzata la pagina "Amministrazione app".
- Fai clic su Google Workspace. Viene visualizzata la pagina "Amministrazione Google Workspace".
- Scorri verso il basso e fai clic su Cloud Search. Viene visualizzata la pagina "Impostazioni per Google Workspace".
- Fai clic su Origini dati di terze parti. Viene visualizzata la pagina "Origini dati".
- Fai clic sul pulsante giallo rotondo +. Viene visualizzata la finestra di dialogo "Aggiungi nuova origine dati".
- Nel campo Nome visualizzato, digita "tutorial".
- Nel campo Indirizzi email dell'account di servizio, inserisci l'indirizzo email dell'account di servizio creato nella sezione precedente. Se non conosci l'indirizzo email dell'account di servizio, cerca il valore nella pagina degli account di servizio.
- Fai clic su AGGIUNGI. Viene visualizzata la finestra di dialogo "Origine dati creata correttamente".
- Fai clic su *OK. Prendi nota dell'ID origine per l'origine dati appena creata. L'ID origine viene utilizzato per configurare il connettore di contenuti.
Genera un token di accesso personale per l'API GitHub
Per disporre di una quota sufficiente, il connettore richiede l'accesso autenticato all'API GitHub. Per semplicità, il connettore utilizza token di accesso personale anziché OAuth. I token personali consentono l'autenticazione come utente con un insieme limitato di autorizzazioni, come OAuth.
- Accedi a GitHub.
- Nell'angolo in alto a destra, fai clic sull'immagine del profilo. Viene visualizzato un menu a discesa.
- Fai clic su Impostazioni.
- Fai clic su Impostazioni sviluppatore.
- Fai clic su Token di accesso personali.
- Fai clic su Genera token di accesso personale.
- Nel campo Nota, inserisci "Tutorial Cloud Search".
- Controlla l'ambito public_repo.
- Fai clic su Genera token.
- Prendi nota del token generato. Viene utilizzato dal connettore per chiamare le API GitHub e fornisce la quota API per eseguire l'indicizzazione.
Configura il connettore
Dopo aver creato le credenziali e l'origine dati, aggiorna la configurazione del connettore in modo da includere questi valori:
- Dalla riga di comando, cambia la directory in
cloud-search-samples/end-to-end/connector/
. - Apri il file
sample-config.properties
con un editor di testo. - Imposta il parametro
api.serviceAccountPrivateKeyFile
sul percorso del file delle credenziali di servizio che hai scaricato in precedenza. - Imposta il parametro
api.sourceId
sull'ID dell'origine dati creata in precedenza. - Imposta il parametro
github.user
sul tuo nome utente GitHub. - Imposta il parametro
github.token
sul token di accesso che hai creato in precedenza. - Salva il file.
Aggiorna lo schema
Il connettore indicizza i contenuti strutturati e non strutturati. Prima di indicizzare i dati, devi aggiornare lo schema per l'origine dati. Esegui questo comando per aggiornare lo schema:
mvn exec:java -Dexec.mainClass=com.google.cloudsearch.tutorial.SchemaTool \
-Dexec.args="-Dconfig=sample-config.properties"
Esegui il connettore
Per eseguire il connettore e iniziare l'indicizzazione, esegui il comando:
mvn exec:java -Dexec.mainClass=com.google.cloudsearch.tutorial.GithubConnector \
-Dexec.args="-Dconfig=sample-config.properties"
La configurazione predefinita del connettore prevede l'indicizzazione di un singolo repository nell'organizzazione googleworkspace
. L'indicizzazione del repository richiede circa un minuto.
Dopo l'indicizzazione iniziale, il connettore continua a eseguire il polling delle modifiche al repository che devono essere riflesse nell'indice di Cloud Search.
Revisione del codice
Le sezioni rimanenti esaminano il modo in cui è creato il connettore.
Avvio dell'applicazione
Il punto di ingresso del connettore è la classe GithubConnector
. Il
metodo main
crea un'istanza dell'elemento IndexingApplication
dell'SDK e lo avvia.
Il ListingConnector
fornito dall'SDK implementa una strategia di attraversamento
che sfrutta le code di Cloud Search
per monitorare lo stato degli elementi nell'indice. Delega a GithubRepository
,
implementato dal connettore di esempio, per l'accesso ai contenuti da GitHub.
Attraversamento dei repository GitHub
Durante gli attraversamenti completi, viene chiamato il metodo getIds()
per inviare alla coda gli elementi che potrebbero dover essere indicizzati.
Il connettore può indicizzare più repository o organizzazioni. Per minimizzare l'impatto di un errore, viene attraversato un repository GitHub alla volta. Viene restituito un punto di controllo con i risultati dell'attraversamento contenente l'elenco dei repository da indicizzare nelle chiamate successive a getIds()
. Se si verifica un errore, l'indicizzazione viene ripresa nel repository attuale anziché ricominciare dall'inizio.
Il metodo collectRepositoryItems()
gestisce l'attraversamento di un singolo
repository GitHub. Questo metodo restituisce una raccolta di ApiOperations
che rappresenta gli elementi di cui eseguire il push in coda. Gli elementi vengono trasmessi come un nome risorsa e un valore hash che rappresenta lo stato attuale dell'elemento.
Il valore hash viene utilizzato negli attraversamenti successivi dei repository GitHub. Questo valore fornisce un controllo semplice per determinare se i contenuti sono cambiati senza dover caricare contenuti aggiuntivi. Il connettore mette in coda tutti gli elementi in coda. Se l'elemento è nuovo o il valore hash è stato modificato, viene reso disponibile per il polling in coda. In caso contrario, l'elemento non viene modificato.
Elaborazione della coda in corso...
Una volta completato l'attraversamento completo, il connettore inizia a eseguire il polling della coda per gli elementi da indicizzare. Viene richiamato il metodo getDoc()
per ogni elemento estratto dalla coda. Il metodo legge l'elemento da GitHub e lo converte nella rappresentazione corretta per l'indicizzazione.
Poiché il connettore è in esecuzione su dati attivi che possono essere modificati in qualsiasi momento, getDoc()
verifica anche che l'elemento in coda sia ancora valido ed elimina dall'indice tutti gli elementi che non esistono più.
Per ciascun oggetto GitHub indicizzato dal connettore, il metodo indexItem()
corrispondente gestisce la creazione della rappresentazione degli elementi per Cloud Search. Ad esempio, per creare la rappresentazione per elementi di contenuto:
Poi esegui il deployment dell'interfaccia di ricerca.