फ़ील्ड के कॉन्फ़िगरेशन को अपडेट करता है. फ़िलहाल, फ़ील्ड अपडेट सिर्फ़ सिंगल फ़ील्ड इंडेक्स कॉन्फ़िगरेशन पर लागू होते हैं. हालांकि, FirestoreAdmin.UpdateField
पर किए जाने वाले कॉल में फ़ील्ड मास्क देना चाहिए, ताकि ऐसे किसी भी कॉन्फ़िगरेशन में बदलाव न किया जा सके जिसके बारे में कॉलर को पता नहीं है. फ़ील्ड मास्क को इस तरह से तय किया जाना चाहिए: { paths: "indexConfig" }
.
इस कॉल से, google.longrunning.Operation
मिलता है. इसका इस्तेमाल, फ़ील्ड के अपडेट की स्थिति को ट्रैक करने के लिए किया जा सकता है. कार्रवाई के लिए मेटाडेटा, FieldOperationMetadata
का टाइप होगा.
इस डेटाबेस के लिए डिफ़ॉल्ट फ़ील्ड सेटिंग कॉन्फ़िगर करने के लिए, रिसॉर्स नाम वाले खास Field
का इस्तेमाल करें: projects/{projectId}/databases/{databaseId}/collectionGroups/__default__/fields/*
.
एचटीटीपी अनुरोध
PATCH https://firestore.googleapis.com/v1beta2/{field.name=projects/*/databases/*/collectionGroups/*/fields/*}
यह यूआरएल gRPC ट्रांसकोडिंग सिंटैक्स का इस्तेमाल करता है.
पाथ के पैरामीटर
पैरामीटर | |
---|---|
field.name |
फ़ील्ड पाथ, कोई सामान्य फ़ील्ड नाम हो सकता है , जैसे कि फ़ील्ड पाथ को उदाहरण: (ध्यान दें: यहां टिप्पणियां मार्कडाउन सिंटैक्स में लिखी गई हैं. इसलिए, कोड ब्लॉक को दिखाने के लिए बैकटिक में एक और लेयर जोड़ी गई है) एक खास |
क्वेरी पैरामीटर
पैरामीटर | |
---|---|
updateMask |
एक मास्क, जो फ़ील्ड के हिसाब से दिखाया जाता है. अगर कॉन्फ़िगरेशन तय किया गया है, तो सिर्फ़ इस फ़ील्ड_mask से तय किए गए कॉन्फ़िगरेशन को फ़ील्ड में अपडेट किया जाएगा. यह फ़ील्ड के पूरी तरह क्वालिफ़ाइड नामों की कॉमा-सेपरेटेड लिस्ट है. उदाहरण: |
अनुरोध का मुख्य भाग
अनुरोध के मुख्य भाग में Field
का उदाहरण है.
जवाब का मुख्य भाग
कामयाब रहने पर, जवाब के मुख्य हिस्से में Operation
का एक इंस्टेंस शामिल किया जाता है.
अनुमति के दायरे
इनमें से किसी एक OAuth दायरों की ज़रूरत होती है:
https://www.googleapis.com/auth/datastore
https://www.googleapis.com/auth/cloud-platform
ज़्यादा जानकारी के लिए, पुष्टि करने से जुड़ी खास जानकारी देखें.