Na tej stronie samouczka Cloud Search pokazujemy, jak skonfigurować źródło danych oraz łącznik treści na potrzeby indeksowania danych. Aby zacząć od początku tego samouczka, zapoznaj się z artykułem Samouczek dla początkujących w Cloud Search
Tworzenie oprogramowania sprzęgającego
Zmień katalog roboczy na cloud-search-samples/end-to-end/connector
i uruchom to polecenie:
mvn package -DskipTests
Polecenie pobiera zależności wymagane do utworzenia łącznik treści i kompiluje kod.
Utwórz dane logowania do konta usługi
Oprogramowanie sprzęgające wymaga danych logowania konta usługi do wywoływania Cloud Search API. Aby utworzyć dane logowania:
- Wróć do Konsola Google Cloud.
- W menu po lewej stronie kliknij Dane logowania. „Dane logowania”
- Kliknij listę + UTWÓRZ DANE LOGOWANIA i wybierz Konto usługi. „Utwórz konto usługi”
- W polu Nazwa konta usługi wpisz „tutorial”.
- Zapisz wartość identyfikatora konta usługi (zaraz po nazwie konta usługi). Zostanie ona użyta później.
- Kliknij UTWÓRZ. „Uprawnienia konta usługi (opcjonalne)” które się wyświetla.
- Kliknij DALEJ. Opcja „Przyznaj użytkownikom dostęp do tego konta usługi” (opcjonalnie)” które się wyświetla.
- Kliknij GOTOWE. Strona „Dane logowania” ekranu.
- W sekcji Konta usługi kliknij adres e-mail konta usługi. Usługa szczegóły konta” aplikacji na stronie.
- W sekcji Klucze kliknij listę DODAJ KLUCZ i wybierz Utwórz nowy klucz. Opcja „Utwórz klucz prywatny” które się wyświetla.
- Kliknij UTWÓRZ.
- (opcjonalnie) Jeśli w polu „Czy chcesz zezwolić na pobieranie Console.cloud.google.com?” kliknij Zezwól.
- Plik z kluczem prywatnym jest zapisywany na Twoim komputerze. Zapisz lokalizację pobranego pliku. Ten plik jest używany do konfigurowania łącznika treści, może uwierzytelnić się podczas wywoływania interfejsów Google Cloud Search API.
Inicjowanie pomocy zewnętrznej
Zanim będzie można wywołać inne interfejsy API Cloud Search, musisz zainicjować obsługę Google Cloud Search.
Aby zainicjować obsługę Cloud Search przez inną firmę:
Twój projekt platformy Cloud Search zawiera dane logowania do konta usługi. Aby jednak zainicjować pomoc zewnętrzną, musisz utworzyć dane logowania do aplikacji. Instrukcje tworzenia aplikacji internetowej dane logowania, zapoznaj się z artykułem Utwórz dane logowania. Po wykonaniu tej czynności powinien być już identyfikator klienta i plik z tajnym kluczem klienta.
Używaj Protokół Google OAuth 2 aby uzyskać token dostępu:
- Kliknij ustawienia i zaznacz Użyj własnych danych uwierzytelniających.
- Wpisz identyfikator klienta i tajny klucz klienta z kroku 1.
- Kliknij Zamknij.
- W polu zakresów wpisz
https://www.googleapis.com/auth/cloud_search.settings
i kliknij Autoryzuj. Narzędzie do testowania OAuth 2 zwraca kod autoryzacji. - Kliknij Exchange authorization code for token (Kod autoryzacji giełdy dla tokenów). Zwracany jest token.
Aby zainicjować obsługę Cloud Search przez inną firmę, użyj tego curl . Pamiętaj, aby zastąpić
[YOUR_ACCESS_TOKEN]
tokenem uzyskanym w kroku 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
Jeśli operacja się uda, treść odpowiedzi będzie zawierała wystąpienie obiektu
operation
. Przykład:{ name: "operations/customers/01b3fqdm/lro/AOIL6eBv7fEfiZ_hUSpm8KQDt1Mnd6dj5Ru3MXf-jri4xK6Pyb2-Lwfn8vQKg74pgxlxjrY" }
W przypadku niepowodzenia skontaktuj się z zespołem pomocy Cloud Search.
Użyj pliku operations.get, aby to sprawdzić. zostanie zainicjowana pomoc innych firm:
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
Po zakończeniu inicjowania usługi zewnętrznej zawiera pole
done
ustawiono na:true
. Na przykład:{ name: "operations/customers/01b3fqdm/lro/AOIL6eBv7fEfiZ_hUSpm8KQDt1Mnd6dj5Ru3MXf-jri4xK6Pyb2-Lwfn8vQKg74pgxlxjrY" done: true }
Tworzenie źródła danych
Następnie utwórz źródło danych w konsoli administracyjnej. Źródło danych zapewnia przestrzeń nazw do indeksowania treści przy użyciu oprogramowania sprzęgającego.
- Otwórz konsolę administracyjną Google.
- Kliknij ikonę Aplikacje. W sekcji „Administracja aplikacjami”
- Kliknij Google Workspace. Sekcja „Administracja aplikacjami Google Workspace”
- Przewiń w dół i kliknij Cloud Search. Ustawienia Google Workspace strona
- Kliknij Zewnętrzne źródła danych. „Źródła danych”
- Kliknij okrągły żółty symbol +. Opcja „Dodaj nowe źródło danych” które się wyświetla.
- W polu Wyświetlana nazwa wpisz „tutorial”.
- W polu Adresy e-mail konta usługi wpisz adres e-mail konto usługi utworzone w poprzedniej sekcji. Jeśli nie znasz adresu e-mail konta usługi, wyszukaj wartość w argumencie konta usługi stronę.
- Kliknij DODAJ. Informacja „Utworzono źródło danych” które się wyświetla.
- Kliknij *OK. Zapisz identyfikator źródła dla nowo utworzonego źródła danych. Identyfikator źródła jest używany do konfigurowania łącznika treści.
Generowanie osobistego tokena dostępu dla interfejsu GitHub API
Oprogramowanie sprzęgające wymaga uwierzytelnionego dostępu do interfejsu GitHub API, aby aby zapewnić odpowiedni limit. Dla uproszczenia oprogramowanie sprzęgające wykorzystuje tokeny dostępu zamiast OAuth. Tokeny osobiste umożliwiają uwierzytelnianie jako użytkownika z ograniczonym zestawem uprawnień podobnych do uprawnień OAuth.
- Zaloguj się w GitHubie.
- W prawym górnym rogu kliknij swoje zdjęcie profilowe. Menu
- Kliknij Ustawienia.
- Kliknij Ustawienia programisty.
- Kliknij Osobiste tokeny dostępu.
- Kliknij Generate personal access token (Wygeneruj osobisty token dostępu).
- W polu Notatka wpisz „Samouczek Cloud Search”.
- Sprawdź zakres public_repo.
- Kliknij Wygeneruj token.
- Zapisz wygenerowany token. Jest używany przez oprogramowanie sprzęgające do wywoływania GitHuba interfejsów API i udostępnia limit interfejsu API na potrzeby indeksowania.
Konfigurowanie oprogramowania sprzęgającego
Po utworzeniu danych logowania i źródła danych zaktualizuj oprogramowanie sprzęgające , aby uwzględnić te wartości:
- W wierszu poleceń zmień katalog na
cloud-search-samples/end-to-end/connector/
- Otwórz plik
sample-config.properties
w edytorze tekstu. - Ustaw parametr
api.serviceAccountPrivateKeyFile
na ścieżkę pliku komponentu dane logowania do usługi. - Ustaw parametr
api.sourceId
na identyfikator źródła danych utworzone wcześniej. - Ustaw parametr
github.user
na swoją nazwę użytkownika GitHub. - Ustaw parametr
github.token
na utworzony wcześniej token dostępu. - Zapisz plik.
Zaktualizuj schemat
Oprogramowanie sprzęgające indeksuje zarówno treści uporządkowane, jak i nieuporządkowane. Przed indeksowaniem , musisz zaktualizować schemat źródła danych. Uruchom to polecenie aby zaktualizować schemat:
mvn exec:java -Dexec.mainClass=com.google.cloudsearch.tutorial.SchemaTool \
-Dexec.args="-Dconfig=sample-config.properties"
Uruchamianie oprogramowania sprzęgającego
Aby uruchomić oprogramowanie sprzęgające i rozpocząć indeksowanie, uruchom polecenie:
mvn exec:java -Dexec.mainClass=com.google.cloudsearch.tutorial.GithubConnector \
-Dexec.args="-Dconfig=sample-config.properties"
Domyślną konfiguracją oprogramowania sprzęgającego jest indeksowanie pojedynczego repozytorium
w organizacji googleworkspace
. Indeksowanie repozytorium trwa około minuty.
Po wstępnym indeksowaniu oprogramowanie sprzęgające kontynuuje sondowanie w poszukiwaniu zmian
które musi być odzwierciedlone w indeksie Cloud Search.
Sprawdzanie kodu
W pozostałych sekcjach omawiamy sposób tworzenia oprogramowania sprzęgającego.
Uruchamianie aplikacji
Punktem wejścia oprogramowania sprzęgającego jest klasa GithubConnector
.
Metoda main
tworzy instancję pakietu SDK IndexingApplication
i ją uruchamia.
ListingConnector
udostępniana przez pakiet SDK implementuje strategię przemierzania
wykorzystujący kolejki Cloud Search.
do śledzenia stanu elementów w indeksie. Przekazuje dane do GithubRepository
,
implementowane przez przykładowe oprogramowanie sprzęgające, aby umożliwić dostęp do treści z GitHuba.
Przeglądanie repozytoriów GitHub
Podczas pełnych przemierzania adresów URL getIds()
jest wywoływana w celu przekazania do kolejki elementów, które być może trzeba zindeksować.
Oprogramowanie sprzęgające może indeksować wiele repozytoriów lub organizacji. Aby zminimalizować
skutków awarii, eksploatowane jest 1 repozytorium GitHub naraz. Punkt kontroli
jest zwracany z wynikami przemierzania zawierającymi listę
do zindeksowania w kolejnych wywołaniach getIds()
. Jeśli wystąpi błąd
gdy wystąpi, indeksowanie zostanie wznowione w bieżącym repozytorium, zamiast zacząć
od początku.
Metoda collectRepositoryItems()
obsługuje przemierzanie pojedynczego obiektu
repozytorium GitHub. Ta metoda zwraca kolekcję ApiOperations
oznacza elementy do przekazania do kolejki. Elementy są przekazywane jako
nazwę zasobu i wartość skrótu reprezentującą bieżący stan elementu.
Wartość skrótu jest używana podczas kolejnych prób przemierzania GitHuba repozytoriów. Ta wartość umożliwia sprawną kontrolę nad tym, czy treść zmienił się bez konieczności przesyłania dodatkowych treści. Łącznik na ślepo umieści wszystkie elementy w kolejce. Jeśli element jest nowy lub wartość skrótu uległa zmianie, zostaje utworzony do odpytywania w kolejce. W przeciwnym razie produkt zostanie uznany za niezmodyfikowany.
Przetwarzam kolejkę
Po zakończeniu pełnego przemierzania oprogramowanie sprzęgające rozpoczyna odpytywanie
w kolejce dla elementów wymagających indeksowania. getDoc()
dla każdego elementu pobranego z kolejki. Metoda odczytuje
wybiorę element z GitHuba
i przekształci on go w odpowiednią reprezentację,
do indeksowania.
Ponieważ oprogramowanie sprzęgające działa w przypadku danych bieżących, które mogą zostać zmienione w dowolnym momencie
getDoc()
sprawdza też, czy element w kolejce jest nadal prawidłowy
i usuwa z indeksu wszystkie elementy, które już nie istnieją.
Dla każdego obiektu GitHub indeksowane przez oprogramowanie sprzęgające jest odpowiedni parametr
Metoda indexItem()
obsługuje tworzenie reprezentacji elementu
Cloud Search. Aby na przykład utworzyć reprezentację elementów treści:
Następnie wdróż interfejs wyszukiwania.