REST Resource: projects.databases.collectionGroups.fields

संसाधन: फ़ील्ड

डेटाबेस में एक फ़ील्ड को दिखाता है.

फ़ील्ड को उनके "कलेक्शन ग्रुप" के हिसाब से ग्रुप में बांटा जाता है, जो डेटाबेस में एक ही आईडी वाले सभी कलेक्शन को दिखाते हैं.

JSON के काेड में दिखाना 
{
  "name": string,
  "indexConfig": {
    object (IndexConfig)
  }
}
फ़ील्ड
name

string

projects/{projectId}/databases/{databaseId}/collectionGroups/{collectionId}/fields/{fieldPath} फ़ॉर्म का फ़ील्ड नाम

फ़ील्ड पाथ, कोई आसान फ़ील्ड नाम हो सकता है, उदाहरण के लिए address या MapValue में मौजूद फ़ील्ड का पाथ , जैसे कि address.city या कोई खास फ़ील्ड पाथ. सिर्फ़ * खास फ़ील्ड ही मान्य है. यह किसी भी फ़ील्ड के बारे में बताता है.

फ़ील्ड पाथ को (backtick). The only character that needs to be escaped within a quoted field path is the backtick character itself, escaped using a backslash. Special characters in field paths that must be quoted include:*,., ``` (backtick),[,]` और किसी ASCII (ASCII) सिम्बॉलिक वर्णों का इस्तेमाल करके कोट किया जा सकता है.

उदाहरण: (ध्यान दें: यहां टिप्पणियां मार्कडाउन सिंटैक्स में लिखी जाती हैं, इसलिए कोड ब्लॉक को दिखाने के लिए बैकटिक की एक अतिरिक्त लेयर होती है) \address.city`represents a field namedaddress.city, not the map key शहरin the fieldपता. `*`represents a field named*`, इसमें कोई फ़ील्ड नहीं होता.

खास Field में, सभी फ़ील्ड को इंडेक्स करने की डिफ़ॉल्ट सेटिंग होती हैं. इस फ़ील्ड के संसाधन का नाम यह है: projects/{projectId}/databases/{databaseId}/collectionGroups/__default__/fields/* इस Field में तय किए गए इंडेक्स, उन सभी फ़ील्ड पर लागू किए जाएंगे जिनमें अपना Field इंडेक्स कॉन्फ़िगरेशन नहीं है.
indexConfig

object (IndexConfig)

इस फ़ील्ड के लिए इंडेक्स कॉन्फ़िगरेशन. अगर नीति को सेट नहीं किया जाता है, तो फ़ील्ड इंडेक्स करने की सुविधा, ancestorField के तय किए गए कॉन्फ़िगरेशन पर वापस लागू हो जाएगी. इस फ़ील्ड के सभी इंडेक्स साफ़ तौर पर हटाने के लिए, इंडेक्स की खाली सूची के साथ कोई इंडेक्स कॉन्फ़िगरेशन तय करें.

इंडेक्स कॉन्फ़िगरेशन

इस फ़ील्ड के लिए इंडेक्स कॉन्फ़िगरेशन.

JSON के काेड में दिखाना 
{
  "indexes": [
    {
      object (Index)
    }
  ],
  "usesAncestorConfig": boolean,
  "ancestorField": string,
  "reverting": boolean
}
फ़ील्ड
indexes[]

object (Index)

इस फ़ील्ड के लिए इस्तेमाल किए जा सकने वाले इंडेक्स.
usesAncestorConfig

boolean

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

string

सिर्फ़ आउटपुट के लिए. यह नीति उस Field के संसाधन का नाम बताती है जिससे इस फ़ील्ड का इंडेक्स कॉन्फ़िगरेशन सेट किया गया है (जब usesAncestorConfig सही हो). इसके अलावा, अगर इस फ़ील्ड में कोई इंडेक्स कॉन्फ़िगरेशन नहीं था (जब usesAncestorConfig गलत है), तो इस फ़ील्ड में इसे सेट किया जाएगा.
reverting

boolean

सही होने पर सिर्फ़ आउटपुट दिखाता है, लेकिन Field का इंडेक्स कॉन्फ़िगरेशन पहले जैसा किया जा रहा है. प्रोसेस पूरी होने के बाद, इंडेक्स कॉन्फ़िगरेशन उसी स्थिति में बदल जाएगा जिसमें ancestorField के बताए गए फ़ील्ड की स्थिति बदल जाएगी. इस अपडेट में, usesAncestorConfig true हो जाएगा और reverting, false हो जाएगा.

तरीके

get

 इसकी मदद से, फ़ील्ड के लिए मेटाडेटा और कॉन्फ़िगरेशन की जानकारी मिलती है.

list

 इस डेटाबेस के लिए फ़ील्ड कॉन्फ़िगरेशन और मेटाडेटा की जानकारी देता है.

patch

 फ़ील्ड कॉन्फ़िगरेशन को अपडेट करता है.