तय किया गया इंडेक्स बनाता है. नए बनाए गए इंडेक्स की शुरुआती स्थिति CREATING
है. लौटाए गए google.longrunning.Operation
के पूरा होने पर, स्थिति READY
हो जाएगी. अगर इंडेक्स पहले से मौजूद है, तो कॉल ALREADY_EXISTS
स्थिति दिखाएगा.
लिंक बनाते समय, इस प्रोसेस में कोई गड़बड़ी हो सकती है. ऐसे में, इंडेक्स को ERROR
स्थिति में भेज दिया जाएगा. जिस डेटा की वजह से गड़बड़ी हुई थी उसे ठीक करके, delete
की मदद से इंडेक्स को हटाकर, फिर create
की मदद से इंडेक्स को फिर से बनाकर, इस प्रोसेस को वापस पाया जा सकता है.
एक ही फ़ील्ड वाले इंडेक्स नहीं बनाए जा सकते.
एचटीटीपी अनुरोध
POST https://firestore.googleapis.com/v1beta1/{parent=projects/*/databases/*}/indexes
यह यूआरएल gRPC ट्रांसकोडिंग सिंटैक्स का इस्तेमाल करता है.
पाथ के पैरामीटर
पैरामीटर | |
---|---|
parent |
उस डेटाबेस का नाम जिस पर यह इंडेक्स लागू होगा. उदाहरण के लिए: |
अनुरोध का मुख्य भाग
अनुरोध के मुख्य भाग में Index
का उदाहरण है.
जवाब का मुख्य भाग
कामयाब होने पर, जवाब के मुख्य हिस्से में Operation
का नया इंस्टेंस शामिल किया जाता है.
अनुमति के दायरे
इनमें से किसी एक OAuth दायरों की ज़रूरत होती है:
https://www.googleapis.com/auth/datastore
https://www.googleapis.com/auth/cloud-platform
ज़्यादा जानकारी के लिए, पुष्टि करने से जुड़ी खास जानकारी देखें.