REST Resource: projects.databases.collectionGroups.fields

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

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

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

जेएसओएन के काेड में दिखाना
{
  "name": string,
  "indexConfig": {
    object (IndexConfig)
  },
  "ttlConfig": {
    object (TtlConfig)
  }
}
फ़ील्ड
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 सिंबल वाले वर्णों का इस्तेमाल करके कोट किया जा सकता है.

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

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

indexConfig

object (IndexConfig)

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

ttlConfig

object (TtlConfig)

इस Field के लिए TTL कॉन्फ़िगरेशन. इसे सेट करने या सेट करने से, उन दस्तावेज़ों के लिए TTL चालू या बंद हो जाएगा जिनमें यह Field है.

IndexConfig

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

जेएसओएन के काेड में दिखाना
{
  "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 होगा.

TtlConfig

उन दस्तावेज़ों के लिए TTL (टाइम-टू-लाइव) कॉन्फ़िगरेशन होता है जिनमें यह Field सेट होता है.

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

जेएसओएन के काेड में दिखाना
{
  "state": enum (State)
}
फ़ील्ड
state

enum (State)

सिर्फ़ आउटपुट के लिए. TTL (टीटीएल) कॉन्फ़िगरेशन की स्थिति.

स्थिति

सभी दस्तावेज़ों पर TTL कॉन्फ़िगरेशन लागू करने की स्थिति.

Enums
STATE_UNSPECIFIED स्थिति की जानकारी नहीं दी गई है या मौजूद नहीं है.
CREATING TTL लागू किया जा रहा है. बदलाव को ट्रैक करने के लिए, एक कार्रवाई लंबे समय से चल रही है. नए लिखे गए दस्तावेज़ों में अनुरोध के हिसाब से TTL (टीटीएल) लागू होंगे. मौजूदा दस्तावेज़ों पर मांगे गए TTL (टीटीएल) अब भी प्रोसेस हो रहे हैं. सभी मौजूदा दस्तावेज़ों के TTL (टीटीएल) प्रोसेस हो जाने पर, इसका स्टेटस 'चालू है' में चला जाएगा.
ACTIVE TTL (टीटीएल) सभी दस्तावेज़ों के लिए चालू है.
NEEDS_REPAIR सभी मौजूदा दस्तावेज़ों के लिए TTL कॉन्फ़िगरेशन चालू नहीं किया जा सका. हाल ही में लिखे गए दस्तावेज़ों का TTL (टीटीएल) लागू रहेगा. जब पिछली बार इस Field के लिए TTL (टीटीएल) चालू करने की कोशिश की गई थी, तब LRO दिखाया गया है. हालांकि, इसमें ज़्यादा जानकारी हो सकती है.

तरीके

get

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

list

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

patch

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