בדף הזה במדריך Cloud Search מוסבר איך להגדיר מקור נתונים ומחבר תוכן להוספת נתונים לאינדקס. כדי להתחיל מההתחלה של המדריך הזה, אפשר לעיין במדריך לתחילת העבודה עם Cloud Search
יצירת המחבר
משנים את ספריית העבודה לספרייה cloud-search-samples/end-to-end/connector
ומריצים את הפקודה הבאה:
mvn package -DskipTests
הפקודה מורידה את התלות הנדרשת לבניית מחבר התוכן ומקמפלת את הקוד.
יצירת פרטי כניסה לחשבון שירות
המחבר דורש פרטי כניסה של חשבון שירות כדי לקרוא ל-Cloud Search APIs. כדי ליצור את פרטי הכניסה:
- חוזרים אל מסוף Google Cloud.
- בחלונית הניווט הימנית, לוחצים על פרטי כניסה. יופיע הדף 'אישורים'.
- לוחצים על הרשימה הנפתחת + CREATE CREDENTIALS ובוחרים באפשרות Service account. מופיע הדף 'יצירת חשבון שירות'.
- בשדה Service account name (שם חשבון השירות), מזינים tutorial.
- שימו לב לערך של מזהה חשבון השירות (מימין לשם חשבון השירות). הערך הזה ישמש בהמשך.
- לוחצים על יצירה. מופיעה תיבת הדו-שיח 'הרשאות של חשבון שירות (אופציונלי)'.
- לוחצים על המשך. מופיעה תיבת הדו-שיח 'הענקת גישה למשתמשים לחשבון השירות הזה (אופציונלי)'.
- לוחצים על סיום. יופיע המסך 'פרטי כניסה'.
- בקטע Service Accounts (חשבונות שירות), לוחצים על כתובת האימייל של חשבון השירות. יופיע הדף 'פרטי חשבון השירות'.
- בקטע Keys (מפתחות), לוחצים על התפריט הנפתח ADD KEY (הוספת מפתח) ובוחרים באפשרות Create new key (יצירת מפתח חדש). מופיעה תיבת הדו-שיח 'יצירת מפתח פרטי'.
- לוחצים על יצירה.
- (אופציונלי) אם מופיע הדו-שיח 'האם ברצונך לאפשר הורדות ב-console.cloud.google.com?', לוחצים על אישור.
- קובץ המפתח הפרטי יישמר במחשב. רושמים או זוכרים את המיקום של הקובץ שהורד. הקובץ הזה משמש להגדרת מחבר התוכן, כדי שהוא יוכל לבצע אימות עצמי כשמתבצעות קריאות ל-Google Cloud Search APIs.
הפעלת תמיכה של צד שלישי
כדי לקרוא לממשקי Cloud Search API אחרים, צריך לאתחל תמיכה בצד שלישי ב-Google Cloud Search.
כדי לאתחל תמיכה בצד שלישי ב-Cloud Search:
פרויקט הפלטפורמה של Cloud Search מכיל פרטי כניסה של חשבון שירות. עם זאת, כדי להפעיל תמיכה בצד שלישי, צריך ליצור פרטי כניסה לאפליקציית אינטרנט. הוראות ליצירת פרטי כניסה לאפליקציות אינטרנט מפורטות במאמר יצירת פרטי כניסה. בסיום השלב הזה, אמור להיות לכם קובץ עם מזהה לקוח וסוד לקוח.
משתמשים ב-Google's OAuth 2 playground כדי לקבל אסימון גישה:
- לוחצים על סמל ההגדרות ומסמנים את התיבה שימוש בפרטי הכניסה שלכם לאימות.
- מזינים את מזהה הלקוח ואת הסוד של הלקוח משלב 1.
- לוחצים על סגירה.
- בשדה 'היקפים', מקלידים
https://www.googleapis.com/auth/cloud_search.settings
ולוחצים על הרשאה. מגרש המשחקים של OAuth 2 מחזיר קוד הרשאה. - לוחצים על Exchange authorization code for tokens (החלפת קוד הרשאה באסימונים). מוחזר טוקן.
כדי לאתחל תמיכה בצד שלישי ב-Cloud Search, משתמשים בפקודת curl הבאה. חשוב להחליף את
[YOUR_ACCESS_TOKEN]
באסימון שהתקבל בשלב 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
אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל מופע של
operation
. לדוגמה:{ name: "operations/customers/01b3fqdm/lro/AOIL6eBv7fEfiZ_hUSpm8KQDt1Mnd6dj5Ru3MXf-jri4xK6Pyb2-Lwfn8vQKg74pgxlxjrY" }
אם הניסיון לא מצליח, פנו לתמיכה של Cloud Search.
משתמשים ב-operations.get כדי לוודא שתמיכת הצד השלישי אותחלה:
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
כשהאתחול של הצד השלישי מסתיים, הוא מכיל את השדה
done
שמוגדר לערךtrue
. לדוגמה:{ name: "operations/customers/01b3fqdm/lro/AOIL6eBv7fEfiZ_hUSpm8KQDt1Mnd6dj5Ru3MXf-jri4xK6Pyb2-Lwfn8vQKg74pgxlxjrY" done: true }
יצירת מקור הנתונים
לאחר מכן, יוצרים מקור נתונים במסוף Admin. מקור הנתונים מספק מרחב שמות לאינדוקס של תוכן באמצעות המחבר.
- פותחים את מסוף Google Admin.
- לוחצים על סמל האפליקציות. יופיע הדף 'ניהול אפליקציות'.
- לוחצים על Google Workspace. מופיע הדף 'אפליקציות – ניהול Google Workspace'.
- גוללים למטה ולוחצים על Cloud Search. מופיע הדף 'הגדרות של Google Workspace'.
- לוחצים על מקורות נתונים של צד שלישי. יופיע הדף 'מקורות נתונים'.
- לוחצים על העיגול הצהוב עם +. מופיעה תיבת הדו-שיח 'הוספת מקור נתונים חדש'.
- בשדה השם המוצג מקלידים 'tutorial'.
- בשדה Service account email addresses, מזינים את כתובת האימייל של חשבון השירות שיצרתם בקטע הקודם. אם אתם לא יודעים מה כתובת האימייל של חשבון השירות, תוכלו לחפש את הערך בדף חשבונות שירות.
- לוחצים על ADD. מופיעה תיבת הדו-שיח 'יצירת מקור הנתונים הסתיימה'.
- לוחצים על *אישור. שימו לב למזהה המקור של מקור הנתונים החדש שיצרתם. מזהה המקור משמש להגדרת מחבר התוכן.
יצירת אסימון גישה אישי ל-GitHub API
כדי לקבל מכסת שימוש מספקת, המחבר דורש גישה מאומתת ל-GitHub API. כדי לפשט את התהליך, המחבר משתמש באסימוני גישה אישיים במקום ב-OAuth. טוקנים אישיים מאפשרים אימות כמשתמש עם מערך מוגבל של הרשאות, בדומה ל-OAuth.
- מתחברים ל-GitHub.
- בפינה השמאלית העליונה, לוחצים על תמונת הפרופיל. יופיע תפריט נפתח.
- לוחצים על הגדרות.
- לוחצים על הגדרות למפתחים.
- לוחצים על Personal access tokens (אסימוני גישה אישיים).
- לוחצים על יצירת אסימון גישה אישי.
- בשדה הערה, מזינים 'Cloud Search tutorial'.
- בודקים את ההיקף public_repo.
- לוחצים על יצירת אסימון.
- רושמים את הטוקן שנוצר. המחבר משתמש בו כדי לקרוא ל-API של GitHub, והוא מספק מכסת API לביצוע האינדוקס.
הגדרת המחבר
אחרי שיוצרים את פרטי הכניסה ואת מקור הנתונים, מעדכנים את הגדרות המחבר כך שיכללו את הערכים הבאים:
- משורת הפקודה, משנים את הספרייה ל-
cloud-search-samples/end-to-end/connector/
. - פותחים את הקובץ
sample-config.properties
בכלי לעריכת טקסט. - מגדירים את הפרמטר
api.serviceAccountPrivateKeyFile
לנתיב הקובץ של פרטי הכניסה לשירות שהורדתם קודם. - מגדירים את הפרמטר
api.sourceId
למזהה של מקור הנתונים שיצרתם קודם. - מגדירים את הפרמטר
github.user
לשם המשתמש שלכם ב-GitHub. - מגדירים את הפרמטר
github.token
לאסימון הגישה שיצרתם קודם. - שומרים את הקובץ.
עדכון הסכימה
המחבר יוצר אינדקסים של תוכן מובנה ושל תוכן לא מובנה. לפני שמבצעים אינדוקס לנתונים, צריך לעדכן את הסכימה של מקור הנתונים. מריצים את הפקודה הבאה כדי לעדכן את הסכימה:
mvn exec:java -Dexec.mainClass=com.google.cloudsearch.tutorial.SchemaTool \
-Dexec.args="-Dconfig=sample-config.properties"
הפעלת המחבר
כדי להריץ את המחבר ולהתחיל ליצור אינדקס, מריצים את הפקודה:
mvn exec:java -Dexec.mainClass=com.google.cloudsearch.tutorial.GithubConnector \
-Dexec.args="-Dconfig=sample-config.properties"
הגדרת ברירת המחדל של המחבר היא יצירת אינדקס של מאגר יחיד בארגון googleworkspace
. הוספת המאגר לאינדקס נמשכת כדקה.
אחרי האינדוקס הראשוני, המחבר ממשיך לבדוק אם יש שינויים במאגר שצריך לשקף באינדקס של Cloud Search.
בדיקת הקוד
בקטעים הבאים נבדוק איך בנוי המחבר.
הפעלת האפליקציה
נקודת הכניסה למחבר היא הכיתה GithubConnector
. ה-method main
יוצרת מופע של IndexingApplication
SDK ומפעילה אותו.
ListingConnector
שסופק על ידי ה-SDK מטמיע אסטרטגיית מעבר שמתבססת על תורים של Cloud Search למעקב אחרי מצב הפריטים באינדקס. הוא מבצע האצלה אל GithubRepository
, שמוטמע על ידי מחבר לדוגמה, כדי לגשת לתוכן מ-GitHub.
מעבר בין מאגרי GitHub
במהלך סריקות מלאות, מתבצעת קריאה לשיטה getIds()
כדי להעביר לתור פריטים שאולי צריך להוסיף לאינדקס.
המחבר יכול להוסיף לאינדקס כמה מאגרי מידע או ארגונים. כדי למזער את ההשפעה של כשל, כל מאגר GitHub נסרק בנפרד. נקודת ביקורת מוחזרת עם תוצאות המעבר, שמכילה את רשימת המאגרים שיש ליצור להם אינדקס בקריאות הבאות אל getIds()
. אם מתרחשת שגיאה, יצירת האינדקס מתחדשת במאגר הנוכחי במקום להתחיל מההתחלה.
השיטה collectRepositoryItems()
מטפלת במעבר על מאגר GitHub יחיד. השיטה מחזירה אוסף של ApiOperations
שמייצג את הפריטים שיועברו לתור. הפריטים נדחפים כשם משאב וכערך גיבוב (hash) שמייצג את המצב הנוכחי של הפריט.
ערך הגיבוב משמש למעברים הבאים במאגרי GitHub. הערך הזה מאפשר לבצע בדיקה קלה כדי לקבוע אם התוכן השתנה, בלי להעלות תוכן נוסף. המחבר מוסיף את כל הפריטים לתור בלי לבדוק אותם. אם הפריט חדש או שערך הגיבוב השתנה, הוא יהיה זמין לאחזור בתור. אחרת, הפריט ייחשב כפריט שלא עבר שינוי.
עיבוד התור
אחרי שהמעבר המלא מסתיים, המחבר מתחיל לבצע בדיקות חוזרות בתור כדי למצוא פריטים שצריך להוסיף לאינדקס. השיטה getDoc()
נקראת עבור כל פריט שנשלף מהתור. השיטה קוראת את הפריט מ-GitHub וממירה אותו לייצוג המתאים לאינדוקס.
מכיוון שהמחבר פועל על נתונים פעילים שעשויים להשתנות בכל רגע, getDoc()
גם מוודא שהפריט בתור עדיין תקף ומוחק מהאינדקס פריטים שכבר לא קיימים.
לכל אחד מאובייקטי GitHub שהמחבר מבצע עליהם אינדוקס, השיטה המתאימה indexItem()
מטפלת בבניית הייצוג של הפריט עבור Cloud Search. לדוגמה, כדי ליצור את הייצוג של פריטי תוכן:
לאחר מכן, פורסים את ממשק החיפוש.