Halaman tutorial Cloud Search ini menunjukkan cara menyiapkan sumber data dan konektor konten untuk mengindeks data. Untuk memulai tutorial ini dari awal, lihat Tutorial memulai Cloud Search
Buat konektor
Ubah direktori kerja Anda ke direktori cloud-search-samples/end-to-end/connector
dan jalankan perintah ini:
mvn package -DskipTests
Perintah ini akan mendownload dependensi yang diperlukan untuk membangun konektor konten dan mengompilasi kode.
Membuat kredensial akun layanan
Konektor memerlukan kredensial akun layanan untuk memanggil API Cloud Search. Untuk membuat kredensial:
- Kembali ke Konsol Google Cloud.
- Di navigasi sebelah kiri, klik Kredensial. Halaman "Kredensial" akan muncul.
- Klik menu drop-down + BUAT KREDENSIAL, lalu pilih Akun layanan. Halaman "Buat akun layanan" akan muncul.
- Di kolom Service account name, masukkan "tutorial".
- Catat nilai ID akun layanan (tepat setelah Nama akun layanan). Nilai ini akan digunakan nanti.
- Klik BUAT. Dialog "Izin akun layanan (opsional)" akan muncul.
- Klik LANJUTKAN. Dialog "Beri pengguna akses ke akun layanan ini (opsional)" akan muncul.
- Klik SELESAI. Layar "Kredensial" akan muncul.
- Di bagian Akun Layanan, klik email akun layanan. Halaman "detail akun layanan" akan muncul.
- Di bagian Kunci, klik daftar drop-down ADD KEY, lalu pilih Create new key. Dialog "Buat kunci pribadi" akan muncul.
- Klik BUAT.
- (opsional) Jika muncul dialog "Do you want to allow downloads on console.cloud.google.com?”, klik Allow.
- File kunci pribadi disimpan ke komputer Anda. Catat lokasi file yang didownload. File ini digunakan untuk mengonfigurasi konektor konten agar dapat mengautentikasi dirinya sendiri saat memanggil Google Cloud Search API.
Menginisialisasi dukungan pihak ketiga
Sebelum dapat memanggil API Cloud Search lainnya, Anda harus menginisialisasi dukungan pihak ketiga untuk Google Cloud Search.
Untuk menginisialisasi dukungan pihak ketiga untuk Cloud Search:
Project platform Cloud Search Anda berisi kredensial akun layanan. Namun, untuk menginisialisasi dukungan pihak ketiga, Anda harus membuat kredensial aplikasi web. Untuk mengetahui petunjuk cara membuat kredensial aplikasi web, lihat Membuat kredensial. Setelah menyelesaikan langkah ini, Anda akan memiliki file client ID dan rahasia klien.
Gunakan OAuth 2 Playground Google untuk mendapatkan token akses:
- Klik setelan dan centang Gunakan kredensial autentikasi Anda sendiri.
- Masukkan client ID dan rahasia klien dari langkah 1.
- Klik Tutup.
- Di kolom cakupan, ketik
https://www.googleapis.com/auth/cloud_search.settings
lalu klik Beri otorisasi. OAuth 2 Playground menampilkan kode otorisasi. - Klik Exchange authorization code for tokens. Token ditampilkan.
Untuk menginisialisasi dukungan pihak ketiga untuk Cloud Search, gunakan perintah curl berikut. Pastikan untuk mengganti
[YOUR_ACCESS_TOKEN]
dengan token yang diperoleh di langkah 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
Jika berhasil, isi respons berisi instance
operation
. Contoh:{ name: "operations/customers/01b3fqdm/lro/AOIL6eBv7fEfiZ_hUSpm8KQDt1Mnd6dj5Ru3MXf-jri4xK6Pyb2-Lwfn8vQKg74pgxlxjrY" }
Jika tidak berhasil, hubungi dukungan Cloud Search.
Gunakan operations.get untuk memverifikasi bahwa dukungan pihak ketiga telah diinisialisasi:
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
Setelah inisialisasi pihak ketiga selesai, inisialisasi tersebut akan berisi kolom
done
yang ditetapkan ketrue
. Contoh:{ name: "operations/customers/01b3fqdm/lro/AOIL6eBv7fEfiZ_hUSpm8KQDt1Mnd6dj5Ru3MXf-jri4xK6Pyb2-Lwfn8vQKg74pgxlxjrY" done: true }
Membuat sumber data
Selanjutnya, buat sumber data di konsol admin. Sumber data menyediakan namespace untuk mengindeks konten menggunakan konektor.
- Buka konsol Google Admin.
- Klik ikon Aplikasi. Halaman "Administrasi aplikasi" akan muncul.
- Klik Google Workspace. Halaman "Administrasi Google Workspace aplikasi" akan muncul.
- Scroll ke bawah, lalu klik Cloud Search. Halaman "Setelan untuk Google Workspace" akan muncul.
- Klik Sumber data pihak ketiga. Halaman "Sumber Data" akan muncul.
- Klik + kuning bulat. Dialog "Tambahkan sumber data baru" akan muncul.
- Di kolom Nama tampilan, ketik "tutorial".
- Di kolom Service account email addresses, masukkan alamat email akun layanan yang Anda buat di bagian sebelumnya. Jika Anda tidak mengetahui alamat email akun layanan, cari nilai di halaman akun layanan.
- Klik TAMBAHKAN. Dialog "Sumber data berhasil dibuat" akan muncul.
- Klik *OK. Catat ID Sumber untuk sumber data yang baru dibuat. ID Sumber digunakan untuk mengonfigurasi konektor konten.
Membuat token akses pribadi untuk GitHub API
Konektor memerlukan akses yang diautentikasi ke GitHub API agar memiliki kuota yang memadai. Untuk kesederhanaan, konektor memanfaatkan token akses pribadi, bukan OAuth. Token pribadi memungkinkan autentikasi sebagai pengguna dengan serangkaian izin terbatas yang serupa dengan OAuth.
- Login ke GitHub.
- Di sudut kanan atas, klik foto profil Anda. Menu drop-down akan muncul.
- Klik Setelan.
- Klik Setelan developer.
- Klik Personal access tokens.
- Klik Generate personal access token.
- Di kolom Note, masukkan "Cloud Search tutorial".
- Periksa cakupan public_repo.
- Klik Generate Token.
- Catat token yang dihasilkan. Digunakan oleh konektor untuk memanggil GitHub API dan menyediakan kuota API untuk melakukan pengindeksan.
Mengonfigurasi konektor
Setelah membuat kredensial dan sumber data, perbarui konfigurasi konektor untuk menyertakan nilai berikut:
- Dari command line, ubah direktori ke
cloud-search-samples/end-to-end/connector/
. - Buka file
sample-config.properties
dengan editor teks. - Tetapkan parameter
api.serviceAccountPrivateKeyFile
ke jalur file kredensial layanan yang Anda download sebelumnya. - Tetapkan parameter
api.sourceId
ke ID sumber data yang Anda buat sebelumnya. - Tetapkan parameter
github.user
ke nama pengguna GitHub Anda. - Tetapkan parameter
github.token
ke token akses yang Anda buat sebelumnya. - Simpan file.
Memperbarui skema
Konektor mengindeks konten terstruktur dan tidak terstruktur. Sebelum mengindeks data, Anda harus memperbarui skema untuk sumber data. Jalankan perintah berikut untuk memperbarui skema:
mvn exec:java -Dexec.mainClass=com.google.cloudsearch.tutorial.SchemaTool \
-Dexec.args="-Dconfig=sample-config.properties"
Menjalankan konektor
Untuk menjalankan konektor dan memulai pengindeksan, jalankan perintah:
mvn exec:java -Dexec.mainClass=com.google.cloudsearch.tutorial.GithubConnector \
-Dexec.args="-Dconfig=sample-config.properties"
Konfigurasi default untuk konektor adalah mengindeks satu repositori di organisasi googleworkspace
. Pengindeksan repositori memerlukan waktu sekitar 1 menit.
Setelah pengindeksan awal, konektor akan terus melakukan polling untuk mencari perubahan pada repositori yang perlu ditampilkan dalam indeks Cloud Search.
Meninjau kode
Bagian selanjutnya akan membahas cara membuat konektor.
Memulai aplikasi
Titik entri ke konektor adalah class GithubConnector
. Metode
main
membuat instance IndexingApplication
SDK
dan memulainya.
ListingConnector
yang disediakan oleh SDK menerapkan strategi penelusuran
yang memanfaatkan antrean Cloud Search
untuk melacak status item dalam indeks. Metode ini didelegasikan ke GithubRepository
,
yang diimplementasikan oleh konektor contoh, untuk mengakses konten dari GitHub.
Menjelajahi repositori GitHub
Selama penelusuran penuh, metode getIds()
dipanggil untuk memasukkan item yang mungkin perlu diindeks ke dalam antrean.
Konektor dapat mengindeks beberapa repositori atau organisasi. Untuk meminimalkan
dampak kegagalan, satu repositori GitHub akan di-crawl dalam satu waktu. Titik pemeriksaan
ditampilkan dengan hasil penelusuran yang berisi daftar
repositori yang akan diindeks dalam panggilan berikutnya ke getIds()
. Jika terjadi error, pengindeksan dilanjutkan di repositori saat ini, bukan dimulai dari awal.
Metode collectRepositoryItems()
menangani penelusuran satu repositori GitHub. Metode ini menampilkan kumpulan ApiOperations
yang merepresentasikan item yang akan dimasukkan ke dalam antrean. Item didorong sebagai
nama resource dan nilai hash yang mewakili status item saat ini.
Nilai hash digunakan dalam penelusuran berikutnya di repositori GitHub. Nilai ini memberikan pemeriksaan ringan untuk menentukan apakah konten telah berubah tanpa harus mengupload konten tambahan. Konektor mengantrekan semua item secara membabi buta. Jika item baru atau nilai hash telah berubah, item tersebut akan tersedia untuk polling dalam antrean. Jika tidak, item dianggap tidak dimodifikasi.
Memproses antrean
Setelah traversal penuh selesai, konektor mulai melakukan polling pada
antrean untuk item yang perlu diindeks. Metode getDoc()
dipanggil untuk setiap item yang diambil dari antrean. Metode ini membaca
item dari GitHub dan mengonversinya menjadi representasi yang tepat
untuk pengindeksan.
Karena konektor berjalan terhadap data aktif yang dapat berubah kapan saja, getDoc()
juga memverifikasi bahwa item dalam antrean masih valid dan menghapus item apa pun dari indeks yang tidak ada lagi.
Untuk setiap objek GitHub yang diindeks konektor, metode
indexItem()
yang sesuai menangani pembuatan representasi item untuk
Cloud Search. Misalnya, untuk membuat representasi item konten:
Selanjutnya, deploy antarmuka penelusuran.