Google के दिए गए कॉन्फ़िगरेशन पैरामीटर

हर कनेक्टर के साथ एक कॉन्फ़िगरेशन फ़ाइल जुड़ी होती है, जिसमें कनेक्टर, इस्तेमाल किए गए पैरामीटर होते हैं. जैसे कि आपके डेटा स्टोर करने की जगह का आईडी. पैरामीटर को की-वैल्यू पेयर के तौर पर परिभाषित किया जाता है, जैसे api.sourceId=1234567890abcdef.

Google Cloud Search SDK टूल में, Google से दिए गए कई कॉन्फ़िगरेशन शामिल हैं अलग-अलग कनेक्टर में इस्तेमाल किए जाने वाले पैरामीटर. Google से मिलने वाले कॉन्फ़िगरेशन पैरामीटर में से, आपकी कॉन्फ़िगरेशन फ़ाइल है. आपको Google से दिए गए पैरामीटर को फिर से तय करने की ज़रूरत नहीं है आपकी कॉन्फ़िगरेशन फ़ाइल में जब तक कि आप उनकी डिफ़ॉल्ट वैल्यू को ओवरराइड न करना चाहें.

इस रेफ़रंस में, Google से मिलने वाले कॉन्फ़िगरेशन पैरामीटर के बारे में बताया गया है.

कॉन्फ़िगरेशन फ़ाइल का उदाहरण

इस उदाहरण में, पैरामीटर के की-वैल्यू पेयर के साथ एक आइडेंटिटी कॉन्फ़िगरेशन फ़ाइल दिखाई गई है.

#
# Configuration file sample
#
api.sourceId=1234567890abcdef
api.identitySourceId=0987654321lmnopq
api.serviceAccountPrivateKeyFile= ./PrivateKey.json

#
# Traversal schedules
#
schedule.traversalIntervalSecs=7200
schedule.incrementalTraversalIntervalSecs=600
#
# Default ACLs
#
defaultAcl.mode=fallback
defaultAcl.public=true

आम तौर पर सेट किए गए पैरामीटर

इस सेक्शन में, ज़रूरी और वैकल्पिक तौर पर सेट किए जाने वाले कॉन्फ़िगरेशन पैरामीटर की सूची दी गई है. अगर आपको वैकल्पिक पैरामीटर की वैल्यू बदलने पर, कनेक्टर डिफ़ॉल्ट वैल्यू का इस्तेमाल करता है SDK टूल उपलब्ध कराता है.

डेटा स्रोत की ऐक्सेस

नीचे दी गई टेबल में उन सभी पैरामीटर की सूची दी गई है जिन्हें कॉन्फ़िगरेशन में दिखाने के लिए ज़रूरी है फ़ाइल से लिए जाते हैं. आपके इस्तेमाल किए जाने वाले पैरामीटर, बनाए जा रहे कनेक्टर के टाइप (कॉन्टेंट कनेक्टर) पर निर्भर करते हैं या आइडेंटिटी कनेक्टर) की ज़रूरत होती है.

सेटिंग पैरामीटर
डेटा सोर्स का आईडी api.sourceId=1234567890abcdef

यह पैरामीटर किसी कनेक्टर को आपकी रिपॉज़िटरी की जगह की जानकारी. आपको यह वैल्यू तब मिलती है, जब खोज में डेटा सोर्स जोड़ा. यह पैरामीटर, कनेक्टर कॉन्फ़िगरेशन फ़ाइलों में होना चाहिए.
पहचान स्रोत आईडी api.identitySourceId=0987654321lmnopq

पहचान करने के लिए, यह पैरामीटर आइडेंटिटी कनेक्टर को होना ज़रूरी है किसी बाहरी आइडेंटिटी सोर्स की लोकेशन. आपको यह वैल्यू तब मिली थी, जब Cloud Search में उपयोगकर्ता की पहचान मैप करना. यह पैरामीटर सभी आइडेंटिटी कनेक्टर कॉन्फ़िगरेशन फ़ाइलों में होना चाहिए.
सेवा खाते की निजी कुंजी वाली फ़ाइल api.serviceAccountPrivateKeyFile=./PrivateKey.json

इस पैरामीटर में आवश्यक निजी कुंजी है डेटा स्टोर करने की जगह को ऐक्सेस करने के लिए. आपको यह वैल्यू तब मिली थी, जब Google Cloud Search REST का कॉन्फ़िगर किया गया ऐक्सेस एपीआई. यह पैरामीटर सभी कॉन्फ़िगरेशन फ़ाइलों में होना चाहिए.
सेवा खाता आईडी api.serviceAccountId=123abcdef4567890

इस पैरामीटर से सेवा खाते की जानकारी मिलती है आईडी. खाली स्ट्रिंग की डिफ़ॉल्ट वैल्यू सिर्फ़ तब डाली जा सकती है, जब कॉन्फ़िगरेशन फ़ाइल एक निजी कुंजी फ़ाइल पैरामीटर तय करता है. अगर आपकी निजी कुंजी फ़ाइल है, तो यह पैरामीटर ज़रूरी है JSON कुंजी नहीं है.

Google Workspace खाता आईडी api.customerId=123abcdef4567890

इस पैरामीटर से एंटरप्राइज़ के Google Workspace खाते का खाता आईडी पता चलता है. आपको मिला है जब आप उपयोगकर्ता को मैप करते हैं, तो यह मान Cloud Search में पहचान की पुष्टि करें. यह पैरामीटर तब ज़रूरी होता है, जब आइडेंटिटी कनेक्टर पर जाएं.
रूट यूआरएल api.rootUrl=baseURLPath

यह पैरामीटर, इंडेक्स करने वाली सेवा के बेस यूआरएल पाथ के बारे में बताता है.

इस पैरामीटर के लिए डिफ़ॉल्ट मान एक खाली स्ट्रिंग है, जिसे इसमें बदला जाता है https://cloudsearch.googleapis.com.

ट्रैवर्सल शेड्यूल

शेड्यूल करने वाले पैरामीटर तय करते हैं कि कनेक्टर इनके बीच कितनी बार इंतज़ार करेगा ट्रैवर्सल.

सेटिंग पैरामीटर
कनेक्टर स्टार्टअप पर पूरा ट्रैवर्सल schedule.performTraversalOnStart=true|false

कनेक्टर स्टार्टअप पर पूरे ट्रेवर्सल पर परफ़ॉर्म करता है न कि पहला इंटरवल खत्म होने का इंतज़ार कर रहा है. डिफ़ॉल्ट वैल्यू true. है

एक इंटरवल के बाद पूरा ट्रैवर्सल schedule.traversalIntervalSecs=intervalInSeconds

कनेक्टर एक खास इंटरवल के बाद पूरा ट्रैवर्सल करता है. यह जानकारी दें ट्रैवर्सल के बीच सेकंड में का अंतराल है. डिफ़ॉल्ट वैल्यू 86400 है (एक दिन में सेकंड की संख्या).

एक ट्रैवर्सल के बाद बाहर निकलें connector.runOnce=true|false

कनेक्टर एक बार पूरा ट्रैवर्सल चलाता है, फिर बाहर निकल जाता है. इस पैरामीटर को सिर्फ़ अगर पूरे ट्रैवर्सल रणनीति का इस्तेमाल किया जा रहा है, तो इसे true पर सेट किया जाना चाहिए; लिस्टिंग और ग्राफ़ बदलावों का पता लगाने और कॉन्टेंट को इंडेक्स करने के लिए, रणनीतियों को कई ट्रैवर्सल की ज़रूरत होती है. डिफ़ॉल्ट मान false है (एक ट्रैवर्सल के बाद बाहर न निकलें).

इंटरवल के बाद इंक्रीमेंटल ट्रैवर्सल schedule.incrementalTraversalIntervalSecs=intervalInSeconds

कनेक्टर एक खास इंटरवल के बाद इंक्रीमेंटल ट्रैवर्सल परफ़ॉर्म करता है. ट्रैवर्सल के बीच के इंटरवल को सेकंड में तय करें. डिफ़ॉल्ट मान यह है 300 (5 मिनट में सेकंड की संख्या).

पोल की शेड्यूल की गई सूची के इंटरवल schedule.pollQueueIntervalSecs=interval_in_seconds

पोल की शेड्यूल की गई सूची के इंटरवल (सेकंड में) के बीच का समय. इसका इस्तेमाल किया गया को सिर्फ़ लिस्टिंग ट्रैवर्सल कनेक्टर से कनेक्ट किया जा सकता है. डिफ़ॉल्ट वैल्यू 10. है

ऐक्सेस कंट्रोल की सूचियां

कनेक्टर, एसीएल का इस्तेमाल करके आइटम के ऐक्सेस को कंट्रोल करता है. एक से ज़्यादा पैरामीटर की मदद से, ACL की मदद से इंडेक्स किए गए रिकॉर्ड का उपयोगकर्ता ऐक्सेस सुरक्षित किया जा सकता है.

अगर रिपॉज़िटरी में हर आइटम से जुड़ी अलग-अलग ACL जानकारी है, Cloud Search में आइटम का ऐक्सेस कंट्रोल करने के लिए, ACL की पूरी जानकारी अपलोड करें. अगर आपने आपका रिपॉज़िटरी (डेटा स्टोर करने की जगह) कभी-कभी या कोई ACL जानकारी नहीं देता है, तो आप डिफ़ॉल्ट नीचे दिए पैरामीटर में मौजूद ACL जानकारी, जिसे SDK टूल कनेक्टर.

सेटिंग पैरामीटर
ACL मोड defaultAcl.mode=mode

इससे तय होता है कि डिफ़ॉल्ट ACL को कब लागू करना है. मान्य मान:

  • none: डिफ़ॉल्ट ACL का उपयोग न करें (इस मोड में, रिकॉर्ड खोज के लिए कोई इस्तेमाल नहीं किया जा सकता, जब तक कि अलग-अलग एसीएल तय न किए गए हों)
  • fallback: अगर कोई ACL पहले से मौजूद नहीं है, तो डिफ़ॉल्ट ACL का उपयोग करें
  • append: मौजूदा ACL में डिफ़ॉल्ट ACL जोड़ें
  • override: मौजूदा ACL को डिफ़ॉल्ट ACL से बदलें

डिफ़ॉल्ट मोड none है.
डिफ़ॉल्ट सार्वजनिक ACL defaultAcl.public=true|false

डेटा स्टोर करने की पूरी जगह के लिए इस्तेमाल किया जाने वाला डिफ़ॉल्ट ACL, सार्वजनिक डोमेन ऐक्सेस पर सेट होता है. डिफ़ॉल्ट वैल्यू false. है

सामान्य ACL ग्रुप रीडर defaultAcl.readers.groups=google:group1@mydomain.com, group2
सामान्य ACL रीडर defaultAcl.readers.users=user1, user2, google:user3@mydomain.com
सामान्य ACL ने ग्रुप रीडर को अस्वीकार कर दिया defaultAcl.denied.groups=group3
Common Acl ने पाठकों को अस्वीकार किया defaultAcl.denied.users=user4, user5
पूरे डोमेन का ऐक्सेस यह बताने के लिए कि हर उपयोगकर्ता इंडेक्स किए गए रिकॉर्ड को सार्वजनिक तौर पर ऐक्सेस कर सकता है की मदद से, डोमेन में इन दोनों पैरामीटर को वैल्यू के साथ सेट करें:
  • defaultAcl.mode=override
  • defaultACL.public=true
सामान्य परिभाषित ACL डेटा रिपॉज़िटरी के हर रिकॉर्ड के लिए एक ACL तय करने के लिए, उन सभी को सेट करें पैरामीटर वैल्यू:
  • defaultAcl.mode=fallback
  • defaultAcl.public=false
  • defaultAcl.readers.groups=google:group1@mydomain.com, group2 code>
  • defaultAcl.readers.users=user1@mydomain.com, user2, google:user3@mydomain.com
  • defaultAcl.denied.groups=group3
  • defaultAcl.denied.users=user4, user5

    हर एक उपयोगकर्ता और ग्रुप को एक तय किया गया स्थानीय डोमेन माना जाता है जब तक "google:" न लगा हो, तब तक उपयोगकर्ता/ग्रुप (लिटरल कॉन्सटेंट).

    डिफ़ॉल्ट उपयोगकर्ता या ग्रुप, एक खाली स्ट्रिंग है. सिर्फ़ उपयोगकर्ता और ग्रुप पैरामीटर दें अगर defaultAcl.public को false पर सेट किया गया. सूची में कई आइटम जोड़ें और उपयोगकर्ताओं के लिए, कॉमा-डीलिमिटेड सूचियों का इस्तेमाल करें.

    अगर defaultAcl.mode को none पर सेट किया गया है, तो रिकॉर्ड व्यक्तिगत ACL के बारे में बताए बिना खोज योग्य नहीं.

मेटाडेटा कॉन्फ़िगरेशन पैरामीटर

कुछ आइटम के मेटाडेटा को कॉन्फ़िगर किया जा सकता है. कनेक्टर के दौरान कॉन्फ़िगर किए जा सकने वाले मेटाडेटा फ़ील्ड को सेट किया जा सकता है इंडेक्स करना. अगर कनेक्टर किसी फ़ील्ड को सेट नहीं करता है, तो आपकी कॉन्फ़िगरेशन फ़ाइल के पैरामीटर का इस्तेमाल किया जाता है फ़ील्ड सेट करने के लिए.

कॉन्फ़िगरेशन फ़ाइल में, नाम वाले मेटाडेटा कॉन्फ़िगरेशन पैरामीटर की एक सीरीज़ होती है. इन्हें .field सफ़िक्स, जैसे कि itemMetadata.title.field=movieTitle. अगर इन सभी शर्तों को पूरा करने के लिए कोई वैल्यू मौजूद हो, पैरामीटर हैं, तो इसका इस्तेमाल मेटाडेटा फ़ील्ड को कॉन्फ़िगर करने के लिए किया जाता है. अगर कोई मान नहीं है नाम वाला मेटाडेटा पैरामीटर है, तो मेटाडेटा को .defaultValue सफ़िक्स).

नीचे दी गई टेबल में, मेटाडेटा कॉन्फ़िगरेशन पैरामीटर दिखाए गए हैं.

सेटिंग पैरामीटर
शीर्षक itemMetadata.title.field=movieTitle
itemMetadata.title.defaultValue=Gone with the Wind
आइटम का टाइटल. अगर title.field किसी मान पर सेट नहीं किया गया है, तो title.defaultValue का इस्तेमाल किया गया है.
डेटा स्टोर करने की जगह का यूआरएल itemMetadata.sourceRepositoryUrl.field=url
itemMetadata.sourceRepositoryUrl.defaultValue=https://www.imdb.com/title/tt0031381/
खोज के नतीजों में इस्तेमाल किया गया आइटम का यूआरएल. आप defaultValue को होल्ड करने के लिए सेट कर सकते हैं पूरे डेटा स्टोर करने की जगह का यूआरएल, जैसे कि अगर आपका प्रतिनिधि CSV फ़ाइल है और आपके पास सिर्फ़ एक हर आइटम के लिए यूआरएल. अगर sourceRepositoryUrl.field सेट नहीं हो वैल्यू डालने के लिए, sourceRepositoryUrl.defaultValue वैल्यू का इस्तेमाल किया जाता है.
कंटेनर का नाम itemMetadata.containerName.field=containerName
itemMetadata.containerName.defaultValue=myDefaultContainerName
आइटम के कंटेनर का नाम, जैसे कि फ़ाइल सिस्टम की डायरेक्ट्री या फ़ोल्डर का नाम. अगर आपने containerName.field किसी मान पर सेट नहीं है, containerName.defaultValue का इस्तेमाल किया गया है.
ऑब्जेक्ट का टाइप itemMetadata.objectType.field=type
itemMetadata.objectType.defaultValue=movie
कनेक्टर में इस्तेमाल किया गया ऑब्जेक्ट टाइप, जैसा कि स्कीमा. अगर इस प्रॉपर्टी के बारे में नहीं बताया गया है, तो कनेक्टर किसी भी स्ट्रक्चर्ड डेटा को इंडेक्स नहीं करेगा.
अगर objectType.field किसी मान पर सेट नहीं किया गया है, तो objectType.defaultValue का इस्तेमाल किया गया है.
खाता बनाने का समय itemMetadata.createTime.field=releaseDate
itemMetadata.createTime.defaultValue=1940-01-17
दस्तावेज़ बनाने का टाइमस्टैंप. अगर createTime.field को किसी वैल्यू पर सेट नहीं किया गया है, तो createTime.defaultValue के लिए वैल्यू का इस्तेमाल किया जाता है.
अपडेट का समय itemMetadata.updateTime.field=releaseDate
itemMetadata.updateTime.defaultValue=1940-01-17
आइटम में आखिरी बार बदलाव का टाइमस्टैंप. अगर updateTime.field को updateTime.defaultValue मान का इस्तेमाल किया जाता है.
सामग्री भाषा itemMetadata.contentLanguage.field=languageCode
itemMetadata.contentLanguage.defaultValue=en-US
इंडेक्स किए जा रहे दस्तावेज़ों के कॉन्टेंट की भाषा. अगर contentLanguage.field को किसी वैल्यू पर सेट नहीं किया गया है, तो contentLanguage.defaultValue वैल्यू का इस्तेमाल किया जाता है.
MIME टाइप itemMetadata.mimeType.field=mimeType
itemMetadata.mimeType.defaultValue=image/bmp
सोर्स रिपॉज़िटरी में itemContent.content का ओरिजनल माइम-टाइप. ज़्यादा से ज़्यादा लंबाई है 256 वर्ण. अगर mimeType.field किसी मान पर सेट नहीं किया गया है, तो mimeType.defaultValue का इस्तेमाल किया गया है.
Search की क्वालिटी का मेटाडेटा itemMetadata.searchQualityMetadata.quality.field=quality
itemMetadata.searchQualityMetadata.quality.defaultValue=1
आइटम की क्वालिटी का संकेत, जिसका इस्तेमाल खोज की क्वालिटी पर असर डालने के लिए किया जाता है. मान यह होना चाहिए 0.0 (सबसे कम क्वालिटी) और 1.0 (सबसे अच्छी क्वालिटी) के बीच का डेटा. डिफ़ॉल्ट वैल्यू 0.0 है. अगर quality.field किसी मान पर सेट नहीं है, quality.defaultValue का इस्तेमाल किया गया है.
हैश itemMetadata.hash.field=hash
itemMetadata.hash.defaultValue=f0fda58630310a6dd91a7d8f0a4ceda2
एपीआई कॉलर से मिली हैशिंग वैल्यू. इसका इस्तेमाल बदली गई स्थिति की गणना करने के लिए items.push तरीका. ज़्यादा से ज़्यादा 2048 वर्ण हो सकते हैं वर्ण अगर hash.field किसी मान पर सेट नहीं किया गया है, तो hash.defaultValue का इस्तेमाल किया गया है.

तारीख और समय के फ़ॉर्मैट

तारीख और समय के फ़ॉर्मैट, मेटाडेटा एट्रिब्यूट में शामिल होने वाले फ़ॉर्मैट के बारे में बताते हैं. अगर कॉन्फ़िगरेशन फ़ाइल इस पैरामीटर में यह पैरामीटर शामिल नहीं होता, इसलिए डिफ़ॉल्ट वैल्यू का इस्तेमाल किया जाता है. नीचे दी गई टेबल में यह पैरामीटर दिखाया गया है.

सेटिंग पैरामीटर
तारीख और समय के दूसरे फ़ॉर्मैट structuredData.dateTimePatterns=MM/dd/uuuu HH:mm:ssXXX
अतिरिक्त java.time.format.DateTimeFormatter की सेमीकोलन से अलग की गई सूची पैटर्न. इन पैटर्न का इस्तेमाल, किसी भी तारीख या तारीख और समय के फ़ील्ड की स्ट्रिंग की वैल्यू पार्स करते समय किया जाता है शामिल हैं. डिफ़ॉल्ट वैल्यू एक खाली सूची है, लेकिन आरएफ़सी 3339 और आरएफ़सी 1123 फ़ॉर्मैट हमेशा काम करते हैं.

स्ट्रक्चर्ड डेटा

Cloud Search इंडेक्स करने वाला एपीआई, स्कीमा सेवा उपलब्ध कराता है. इसका इस्तेमाल इन कामों के लिए किया जा सकता है Cloud Search आपके डेटा को इंडेक्स और दिखाने के तरीके को पसंद के मुताबिक बना सकता है. अगर आपको किसी लोकल रिपॉज़िटरी स्कीमा का इस्तेमाल कर रहे हैं, तो आपको स्ट्रक्चर्ड डेटा स्कीमा का नाम

सेटिंग पैरामीटर
लोकल स्कीमा का नाम structuredData.localSchema=mySchemaName

स्कीमा का नाम, डेटा सोर्स से पढ़ा जाता है और डेटा स्टोर करने के लिए इस्तेमाल किया जाता है वाला है.

डिफ़ॉल्ट तौर पर, यह एक खाली स्ट्रिंग होती है.

कॉन्टेंट और खोज की क्वालिटी

डेटा स्टोर करने की उन जगहों के लिए जिनमें रिकॉर्ड या फ़ील्ड-आधारित कॉन्टेंट होता है (जैसे कि CRM, CVS, या डेटाबेस), तो SDK टूल, डेटा फ़ील्ड के लिए अपने-आप एचटीएमएल फ़ॉर्मैटिंग की अनुमति देता है. आपका कनेक्टर, कनेक्टर पर एक्ज़ीक्यूशन की शुरुआत में डेटा फ़ील्ड को तय करता है और इसके बाद, हर डेटा रिकॉर्ड को अपलोड करने से पहले उसे फ़ॉर्मैट करने के लिए कॉन्टेंट टेंप्लेट का इस्तेमाल करता है Cloud Search.

कॉन्टेंट टेंप्लेट, खोज के लिए हर फ़ील्ड वैल्यू की अहमियत के बारे में बताता है. एचटीएमएल <title> फ़ील्ड आवश्यक है और सबसे ज़्यादा प्राथमिकता के रूप में परिभाषित किया गया है. आप अन्य सभी सामग्री फ़ील्ड के लिए खोज गुणवत्ता के महत्व के स्तर तय करें: ज़्यादा, सामान्य या कम. ऐसा कोई भी कॉन्टेंट फ़ील्ड जिसे किसी कैटगरी में तय नहीं किया गया है डिफ़ॉल्ट रूप से, कम प्राथमिकता पर सेट हो जाता है.

सेटिंग पैरामीटर
कॉन्टेंट एचटीएमएल टाइटल contentTemplate.templateName.title=myTitleField

कॉन्टेंट एचटीएमएल टाइटल और सबसे ज़्यादा खोज क्वालिटी वाला फ़ील्ड. यह पैरामीटर ज़रूरी है तभी किया जा सकता है, जब आप एचटीएमएल कॉन्टेंट टेंप्लेट का इस्तेमाल कर रहे हों. डिफ़ॉल्ट वैल्यू एक खाली है स्ट्रिंग.

कॉन्टेंट फ़ील्ड के लिए, खोज की अच्छी क्वालिटी contentTemplate.templateName.quality.high=hField1,hField2

कॉन्टेंट फ़ील्ड को खोज के लिए ज़्यादा प्राथमिकता दी गई. डिफ़ॉल्ट तौर पर, यह एक खाली स्ट्रिंग होती है.

कॉन्टेंट फ़ील्ड के लिए खोज की मध्यम क्वालिटी contentTemplate.templateName.quality.medium=mField1,mField2

कॉन्टेंट फ़ील्ड को मीडियम खोज के लिए प्राथमिकता दी गई. डिफ़ॉल्ट तौर पर, यह एक खाली स्ट्रिंग होती है.

कॉन्टेंट फ़ील्ड के लिए, खोज की खराब क्वालिटी contentTemplate.templateName.quality.low=lField1,lField2

सामग्री फ़ील्ड को कम खोज प्राथमिकता दी गई. डिफ़ॉल्ट तौर पर, यह एक खाली स्ट्रिंग होती है.

कॉन्टेंट के ऐसे फ़ील्ड जिनके बारे में जानकारी नहीं दी गई है contentTemplate.templateName.unmappedColumnsMode=value

कनेक्टर अनिर्दिष्ट सामग्री फ़ील्ड को कैसे प्रबंधित करता है. मान्य मान हैं:

  • APPEND—टेंप्लेट में कॉन्टेंट के ऐसे फ़ील्ड जोड़ें जिनके बारे में जानकारी नहीं दी गई है
  • IGNORE—कॉन्टेंट के ऐसे फ़ील्ड को अनदेखा करें जिनके बारे में जानकारी नहीं दी गई है

    डिफ़ॉल्ट वैल्यू APPEND है.

एचटीएमएल टेंप्लेट में फ़ील्ड के नाम शामिल करें contentTemplate.templateName.includeFieldName=true|false

इससे पता चलता है कि एचटीएमएल में फ़ील्ड डेटा के साथ फ़ील्ड के नाम शामिल करने हैं या नहीं टेम्प्लेट. यह डिफ़ॉल्ट वैल्यू true होती है, जिसकी वजह से फ़ील्ड के नाम खोजे जा सकते हैं के हिस्से के तौर पर किया जा सकता है.

असामान्य रूप से सेट किए गए पैरामीटर

आपको इस सेक्शन में दिए गए पैरामीटर को सेट करने की ज़रूरत बहुत ही कम हो. पैरामीटर के डिफ़ॉल्ट ये हैं सबसे अच्छी परफ़ॉर्मेंस के लिए सेट किया गया है. Google इन पैरामीटर को इस पर सेट करने का सुझाव नहीं देता आपके URL में कोई विशिष्ट आवश्यकता शामिल नहीं है. डेटा स्टोर करने की जगह.

प्रॉक्सी कॉन्फ़िगरेशन

SDK टूल आपको अपने कनेक्टर को कॉन्फ़िगर करने की अनुमति देता है, ताकि आउटगोइंग कनेक्शन के लिए प्रॉक्सी का इस्तेमाल किया जा सके.

transport.proxy.hostname और transport.proxy.port पैरामीटर प्रॉक्सी के ज़रिए ट्रांसपोर्ट चालू करने के लिए ज़रूरी है. अन्य पैरामीटर की ज़रूरत पड़ सकती है अगर आपके प्रॉक्सी को पुष्टि करने की ज़रूरत है या वह एचटीटीपी के बजाय SOCKS प्रोटोकॉल पर काम करता है. अगर आपने transport.proxy.hostname सेट नहीं है, इसलिए SDK टूल प्रॉक्सी का इस्तेमाल नहीं करेगा.

सेटिंग पैरामीटर
होस्टनेम transport.proxy.hostname=hostname

प्रॉक्सी सर्वर के लिए होस्टनेम. प्रॉक्सी का इस्तेमाल करते समय, यह पैरामीटर ज़रूरी है.

पोर्ट transport.proxy.port=port

प्रॉक्सी सर्वर का पोर्ट नंबर. प्रॉक्सी का इस्तेमाल करते समय, यह पैरामीटर ज़रूरी है.

प्रॉक्सी का प्रकार transport.proxy.type=type

प्रॉक्सी का टाइप. मान्य मान हैं:

  • HTTP—प्रॉक्सी, अनुरोधों को स्वीकार करता है और उन्हें एचटीटीपी पर फ़ॉरवर्ड करता है.
  • SOCKS—प्रॉक्सी, SOCKS प्रोटोकॉल पर पैकेट को स्वीकार और फ़ॉरवर्ड करता है.

डिफ़ॉल्ट वैल्यू HTTP है.
उपयोगकर्ता नाम transport.proxy.username=username

प्रॉक्सी ऑथराइज़ेशन टोकन बनाते समय, इस्तेमाल किया जाने वाला उपयोगकर्ता नाम. यह पैरामीटर ज़रूरी नहीं है. इसे सिर्फ़ तब सेट किया जाना चाहिए, जब आपकी प्रॉक्सी को पुष्टि करने की ज़रूरत हो.

पासवर्ड transport.proxy.password=password

प्रॉक्सी ऑथराइज़ेशन टोकन बनाते समय इस्तेमाल करने के लिए पासवर्ड. यह पैरामीटर ज़रूरी नहीं है. इसे सिर्फ़ तब सेट किया जाना चाहिए, जब आपकी प्रॉक्सी को पुष्टि करने की ज़रूरत हो.

ट्रैवर्सर

SDK टूल की मदद से, कई अलग-अलग ट्रैवर्सर तय किए जा सकते हैं, ताकि डेटा रिपॉज़िटरी के पैरलल ट्रैवर्सल. SDK टूल के टेंप्लेट कनेक्टर इसका इस्तेमाल करते हैं सुविधा.

सेटिंग पैरामीटर
थ्रेड पूल का साइज़ traverse.threadPoolSize=size

साथ-साथ प्रोसेस करने के लिए कनेक्टर के बनाए गए थ्रेड की संख्या. ऐप्लिकेशन एक इटरेटर क्रम के हिसाब से ऑपरेशन को फ़ेच करता है (आम तौर पर, RepositoryDoc ऑब्जेक्ट), हालांकि, एपीआई कॉल इतनी थ्रेड की संख्या के साथ-साथ प्रोसेस होते हैं.

डिफ़ॉल्ट वैल्यू 5 है.

विभाजन आकार traverse.partitionSize=batchSize

ApiOperation() की संख्या अतिरिक्त APIOperation फ़ेच करने से पहले, बैच में प्रोसेस करने की ज़रूरत होती है.

डिफ़ॉल्ट वैल्यू 50 है.

ट्रैवर्सर पोल के अनुरोध

Cloud Search इंडेक्स करने की सूची का मुख्य हिस्सा, प्राथमिकता वाली सूची है, जिसमें प्रविष्टि के रूप में फ़्लैग करें. लिस्टिंग कनेक्टर, पोल कराने का अनुरोध कर सकता है इंडेक्स करने वाले एपीआई से मिले आइटम. पोल के अनुरोध को सबसे ज़्यादा प्राथमिकता दी जाती है हटा दें.

SDK टूल की लिस्टिंग कनेक्टर टेंप्लेट, इन पैरामीटर का इस्तेमाल इन कामों के लिए करता है पोलिंग पैरामीटर तय करते हैं.

सेटिंग पैरामीटर
रिपॉज़िटरी ट्रैवर्सर repository.traversers=t1, t2, t3, ...

एक या उससे ज़्यादा व्यक्तिगत ट्रेवर्सर बनाता है, जहां t1, t2, t3, हर एक का यूनीक नाम ... है. नाम वाले हर ट्रैवर्सर के पास सेटिंग का अपना सेट होता है जिन्हें ट्रैवर्सर के यूनीक नाम का इस्तेमाल करके पहचाना जाता है, जैसे traversers.t1.hostload और traversers.t2.hostload.
पोल में शामिल होने के लिए सूची traverser.pollRequest.queue=mySpecialQueue

उन नामों की सूची बनाएं जिन्हें यह ट्रेवर्सर पोल करता है. डिफ़ॉल्ट खाली स्ट्रिंग है ( "डिफ़ॉल्ट").

traverser.t1.pollRequest.queue=mySpecialQueue

जब आपके पास एक से ज़्यादा ट्रेवर्सर हों, तो हर ट्रैवर्सर के लिए आइटम की स्थितियां सेट करें (जहां t1, किसी खास ट्रेवर्सर के बारे में बताता है).

पोल का व्यवहार traverser.pollRequest.limit=maxItems

पोलिंग अनुरोध में शामिल किए जाने वाले आइटम की ज़्यादा से ज़्यादा संख्या. डिफ़ॉल्ट वैल्यू 0 है (एपीआई की ज़्यादा से ज़्यादा वैल्यू लागू होती है).

traverser.t1.pollRequest.limit=limit

जब आपके पास एक से ज़्यादा ट्रेवर्सर हों, तो हर ट्रैवर्सर के लिए आइटम की स्थितियां सेट करें (जहां t1, किसी खास ट्रेवर्सर के बारे में बताता है).

आइटम की स्थिति traverser.pollRequest.statuses=statuses

उस खास आइटम के स्टेटस जिन्हें यह ट्रैवर्सर पोल करता है, जहां statuses हो सकता है MODIFIED, NEW_ITEM (कॉमा से अलग किए गए) का कोई भी संयोजन, डिफ़ॉल्ट रूप से खाली स्ट्रिंग (स्थिति की सभी वैल्यू लागू होती हैं).

traverser.t1.pollRequest.statuses=statusesForThisTraverser

अगर आपके पास एक से ज़्यादा ट्रेवर्सर हों, तो हर ट्रैवर्सर के लिए आइटम की स्थितियां सेट करें (जहां t1, विशिष्ट ट्रैवर्सर दिखाता है).

होस्ट लोड traverser.hostload=threads

पोलिंग के लिए उपलब्ध, पैरलल थ्रेड की ज़्यादा से ज़्यादा संख्या. डिफ़ॉल्ट वैल्यू 5. है

traverser.t1.hostload=threadsForThisTraverser

अगर आपके पास एक से ज़्यादा ट्रेवर्सर हों, तो हर ट्रैवर्सर के लिए आइटम की स्थितियां सेट करें (जहां t1, विशिष्ट ट्रैवर्सर दिखाता है).
टाइम आउट की संख्या traverser.timeout=timeout

इस ट्रैवर्सर पोल की कोशिश को रोकने के लिए टाइम आउट वैल्यू.

डिफ़ॉल्ट वैल्यू 60 है.

traverser.t1.timeout=timeoutForThisTraverser

अगर आपके पास एक से ज़्यादा ट्रेवर्सर हों, तो हर ट्रैवर्सर के लिए आइटम की स्थितियां सेट करें (जहां t1, विशिष्ट ट्रैवर्सर दिखाता है).
traverser.timeunit=timeoutUunit

टाइम आउट यूनिट. मान्य वैल्यू SECONDS, MINUTES, हैं

traverser.t1.timeunit=timeoutUnit

अगर आपके पास एक से ज़्यादा ट्रेवर्सर हों, तो हर ट्रैवर्सर के लिए आइटम की स्थितियां सेट करें (जहां t1, विशिष्ट ट्रैवर्सर दिखाता है).

ज़्यादातर मामलों में, सिर्फ़ SDK टूल की लिस्टिंग कनेक्टर वाले टेंप्लेट का इस्तेमाल करने वाला कनेक्टर पोलिंग के लिए पैरामीटर के एक सेट की ज़रूरत होती है. कुछ मामलों में आपको इन चीज़ों की ज़रूरत पड़ सकती है अगर आपके ट्रैवर्सल एल्गोरिदम के लिए ज़रूरी है कि आइटम को प्रोसेस करने के लिए, अलग-अलग सूची का इस्तेमाल करें.

इस मामले में, आपके पास पोलिंग के अलग-अलग सेट तय करने का विकल्प है पैरामीटर का इस्तेमाल करें. पैरामीटर सेट के नाम तय करके शुरुआत करने के लिए, इनका इस्तेमाल करें: repository.traversers. हर तय ट्रैवर्सर नाम के लिए, एक कॉन्फ़िगरेशन फ़ाइल है, जिसमें ऊपर दी गई टेबल में पैरामीटर की जगह ट्रैवर्सर नाम के साथ t1. इससे पोलिंग का एक सेट बनता है पैरामीटर सेट करें.

चेकपॉइंट

चेकपॉइंट की मदद से, इंक्रीमेंटल ट्रैवर्सल की स्थिति को ट्रैक किया जा सकता है.

सेटिंग पैरामीटर
Checkpoint की डायरेक्ट्री connector.checkpointDirectory=/path/to/checkpoint

इंक्रीमेंटल और पूरे ट्रेवर्सल चेकपॉइंट के लिए, लोकल डायरेक्ट्री का पाथ इस्तेमाल करता है.

अपलोड किया गया कॉन्टेंट

आइटम की सामग्री को आइटम के साथ Cloud Search में तब अपलोड किया जाता है, जब कॉन्टेंट का साइज़, तय की गई थ्रेशोल्ड से ज़्यादा नहीं है. अगर कॉन्टेंट का साइज़ सीमा से ज़्यादा हो जाने पर, सामग्री आइटम के मेटाडेटा और स्ट्रक्चर्ड डेटा.

सेटिंग पैरामीटर
कॉन्टेंट थ्रेशोल्ड api.contentUploadThresholdBytes=bytes

कॉन्टेंट के लिए थ्रेशोल्ड, जिससे यह तय होता है कि वीडियो "इन-लाइन" अपलोड किया गया है या नहीं के साथ आइटम पर क्लिक करने से अलग होता है.

डिफ़ॉल्ट वैल्यू 100000 (~100 केबी) है.

कंटेनर

पूरा कनेक्टर टेंप्लेट, एक ऐसे एल्गोरिदम का इस्तेमाल करता है जिसमें डेटाबेस में मिटाए गए रिकॉर्ड का पता लगाने के लिए, डेटा सोर्स की अस्थायी सूची वाला टॉगल. इसका मतलब है कि हर पूरे ट्रैवर्सल पर, फ़ेच किए गए रिकॉर्ड, जो नई सूची, Search Console से इंडेक्स किए गए सभी मौजूदा Cloud Search रिकॉर्ड बदल दें पिछला ट्रैवर्सल, जो एक पुरानी सूची में है.

सेटिंग पैरामीटर
कंटेनर के नाम का टैग traverse.queueTag=instance

किसी सामान्य डेटा को इंडेक्स करने के साथ-साथ कनेक्टर के कई इंस्टेंस चलाने के लिए रिपॉज़िटरी (चाहे अलग-अलग डेटा रिपॉज़िटरी पर हो या किसी सामान्य डेटा के अलग-अलग हिस्सों पर डेटा स्टोर करने की जगह) के लिए, एक-दूसरे के साथ रुकावट डाले बिना, एक यूनीक कंटेनर असाइन करें नाम टैग की सहायता से उन्हें कस्टमाइज़ किया जा सकता है. यूनीक नाम टैग, कनेक्टर को रोकता है को किसी दूसरे के रिकॉर्ड को मिटाने से रोकने के लिए.

नाम टैग, फ़ुल ट्रैवर्सल कनेक्टर के टॉगल सूची आईडी में जोड़ा जाता है.
मिटाने का पता चलने की सुविधा बंद करें traverse.useQueues=true|false

इससे पता चलता है कि कनेक्टर, डिटेक्ट करने के लिए क्यू टॉगल लॉजिक का इस्तेमाल करता है या नहीं.

इसका डिफ़ॉल्ट मान true है. इससे पता चलता है कि क्यू इस्तेमाल किया गया.

ध्यान दें: यह कॉन्फ़िगरेशन पैरामीटर सिर्फ़ कनेक्टर पर लागू होता है FullTraversalConnector टेंप्लेट लागू किया जा रहा है.

बैच नीति

SDK टूल, बैच नीति के साथ काम करता है. इसकी मदद से, ये काम किए जा सकते हैं कार्रवाइयां:

  • बैच रिक्वेस्ट
  • बैच की सूची में अनुरोधों की संख्या बताएं
  • एक साथ लागू किए जाने वाले बैच मैनेज करें
  • बैच में किए गए अनुरोधों को फ़्लश करें

SDK टूल, कनेक्टर के अनुरोधों को बैच बनाकर भेज देता है, ताकि ऐप्लिकेशन को अपलोड. अनुरोधों के बैच को अपलोड करने के लिए, SDK टूल का ट्रिगर अनुरोधों की संख्या या टाइम आउट की संख्या में से जो भी पहले हो. उदाहरण के लिए, अगर बैच का साइज़ पूरा हुए बिना, बैच में देरी की समयसीमा खत्म हो गई है या देरी होने से पहले, आइटम के बैच का साइज़ पूरा हो जाता है. इसके बाद, बैच अपलोड ट्रिगर हो जाता है.

सेटिंग पैरामीटर
बैच रिक्वेस्ट batch.batchSize=batchSize

अनुरोधों को एक साथ बैच में भेजें. डिफ़ॉल्ट वैल्यू 10 है.
बैच की सूची में अनुरोधों की संख्या batch.maxQueueLength=maxQueueLength

निष्पादन के लिए एक बैच सूची में अनुरोधों की अधिकतम संख्या. डिफ़ॉल्ट वैल्यू 1000. है

साथ में बैच एक्ज़ीक्यूट किए जा रहे हैं batch.maxActiveBatches=maxActiveBatches

एक साथ लागू किए जा सकने वाले बैच की संख्या. डिफ़ॉल्ट वैल्यू 20 है.

बैच में किए गए अनुरोधों को अपने-आप फ़्लश करें batch.maxBatchDelaySeconds=maxBatchDelay

बैच में भेजे गए अनुरोधों के लिए इंतज़ार करने में लगने वाले सेकंड अपने-आप फ़्लश हो जाता है. कॉन्टेंट बनाने डिफ़ॉल्ट वैल्यू 5 है.

शटडाउन पर बैच में किए गए अनुरोध फ़्लश करें batch.flushOnShutdown=true|false

सेवा बंद होने के दौरान बैच में किए गए अनुरोधों को फ़्लश करें. डिफ़ॉल्ट वैल्यू true है

अपवाद हैंडलर

अपवाद हैंडलर पैरामीटर तय करते हैं कि ट्रैवर्सर इसके बाद कैसे आगे बढ़ता है को किसी अपवाद का सामना करना पड़ता है.

सेटिंग पैरामीटर
गड़बड़ी होने पर ट्रैवर्सर के लिए निर्देश traverse.exceptionHandler=exceptions

कोई अपवाद होने के बाद ट्रैवर्सर को कैसे आगे बढ़ना चाहिए. मान्य वैल्यू हैं:

  • 0--हमेशा अपवाद का सामना करने के बाद ट्रैवर्सल को रद्द कर दें
  • num_exceptions (उदाहरण के लिए, 10)--ट्रैवर्सर के बाद गर्भपात बताए गए num_exceptions का सामना करता है.

    इसकी डिफ़ॉल्ट वैल्यू 0 है (हमेशा गड़बड़ी होने पर रद्द करती है).

  • ignore--गड़बड़ी को अनदेखा करें
अपवादों के बीच इंतज़ार का समय abortExceptionHander.backoffMilliSeconds=backoff

पता लगाए गए हैंडलर अपवादों के बीच इंतज़ार करने के लिए मिलीसेकंड में बैकऑफ़ समय (आम तौर पर, डेटा स्टोर करने की जगह को ट्रैक करते समय इस्तेमाल किया जाता है). डिफ़ॉल्ट वैल्यू 10 है.