इस पेज का अनुवाद Cloud Translation API से किया गया है.

Package google.firestore.admin.v1beta2

इंडेक्स

FirestoreAdmin (इंटरफ़ेस)
CreateIndexRequest (मैसेज)
DeleteIndexRequest (मैसेज)
ExportDocumentsMetadata (मैसेज)
ExportDocumentsRequest (मैसेज)
ExportDocumentsResponse (मैसेज)
Field (मैसेज)
Field.IndexConfig (मैसेज)
FieldOperationMetadata (मैसेज)
FieldOperationMetadata.IndexConfigDelta (मैसेज)
FieldOperationMetadata.IndexConfigDelta.ChangeType (enum)
GetFieldRequest (मैसेज)
GetIndexRequest (मैसेज)
ImportDocumentsMetadata (मैसेज)
ImportDocumentsRequest (मैसेज)
Index (मैसेज)
Index.IndexField (मैसेज)
Index.IndexField.ArrayConfig (enum)
Index.IndexField.Order (enum)
Index.QueryScope (enum)
Index.State (enum)
IndexOperationMetadata (मैसेज)
ListFieldsRequest (मैसेज)
ListFieldsResponse (मैसेज)
ListIndexesRequest (मैसेज)
ListIndexesResponse (मैसेज)
OperationState (enum)
Progress (मैसेज)
UpdateFieldRequest (मैसेज)

Firestoreएडमिन

कार्रवाइयां FirestoreAdmin सेवा से बनाई गई हैं, लेकिन google.longrunning.Operations सेवा से इन्हें ऐक्सेस किया जा सकता है.

इंडेक्स बनाएं

इंडेक्स बनाएं
`rpc CreateIndex(CreateIndexRequest) returns (Operation)` एक कंपोज़िट इंडेक्स बनाता है. यह एक `google.longrunning.Operation` देता है, जिसका इस्तेमाल निर्माण की स्थिति को ट्रैक करने के लिए किया जा सकता है. कार्रवाई का मेटाडेटा `IndexOperationMetadata` टाइप होगा. अनुमति के दायरे इनमें से किसी एक OAuth स्कोप की ज़रूरत होती है: `https://www.googleapis.com/auth/datastore` `https://www.googleapis.com/auth/cloud-platform` ज़्यादा जानकारी के लिए, पुष्टि करने से जुड़ी खास जानकारी देखें.

rpc CreateIndex(CreateIndexRequest) returns (Operation)

एक कंपोज़िट इंडेक्स बनाता है. यह एक google.longrunning.Operation देता है, जिसका इस्तेमाल निर्माण की स्थिति को ट्रैक करने के लिए किया जा सकता है. कार्रवाई का मेटाडेटा IndexOperationMetadata टाइप होगा.

अनुमति के दायरे

इनमें से किसी एक OAuth स्कोप की ज़रूरत होती है:

https://www.googleapis.com/auth/datastore
https://www.googleapis.com/auth/cloud-platform

ज़्यादा जानकारी के लिए, पुष्टि करने से जुड़ी खास जानकारी देखें.

इंडेक्स मिटाएं

इंडेक्स मिटाएं
`rpc DeleteIndex(DeleteIndexRequest) returns (Empty)` एक कंपोज़िट इंडेक्स को मिटाता है. अनुमति के दायरे इनमें से किसी एक OAuth स्कोप की ज़रूरत होती है: `https://www.googleapis.com/auth/datastore` `https://www.googleapis.com/auth/cloud-platform` ज़्यादा जानकारी के लिए, पुष्टि करने से जुड़ी खास जानकारी देखें.

rpc DeleteIndex(DeleteIndexRequest) returns (Empty)

एक कंपोज़िट इंडेक्स को मिटाता है.

अनुमति के दायरे

इनमें से किसी एक OAuth स्कोप की ज़रूरत होती है:

https://www.googleapis.com/auth/datastore
https://www.googleapis.com/auth/cloud-platform

ज़्यादा जानकारी के लिए, पुष्टि करने से जुड़ी खास जानकारी देखें.

निर्यात दस्तावेज़

निर्यात दस्तावेज़
`rpc ExportDocuments(ExportDocumentsRequest) returns (Operation)` दस्तावेज़ों के सभी या एक सबसेट को Google Cloud Firestore से किसी दूसरे स्टोरेज सिस्टम में एक्सपोर्ट करता है, जैसे कि Google Cloud Storage. ऐसा हो सकता है कि दस्तावेज़ों में हाल ही में किए गए अपडेट, एक्सपोर्ट में न दिखें. एक्सपोर्ट, बैकग्राउंड में होता है. एक्सपोर्ट की प्रोग्रेस को, बनाए गए ऑपरेशन संसाधन के ज़रिए मॉनिटर और मैनेज किया जा सकता है. संबंधित कार्रवाई पूरी होने के बाद ही, एक्सपोर्ट के आउटपुट का इस्तेमाल किया जा सकता है. अगर एक्सपोर्ट की प्रोसेस पूरी होने से पहले ही रद्द कर दी जाती है, तो हो सकता है कि डेटा का कुछ हिस्सा Google Cloud Storage में न रहे. अनुमति के दायरे इनमें से किसी एक OAuth स्कोप की ज़रूरत होती है: `https://www.googleapis.com/auth/datastore` `https://www.googleapis.com/auth/cloud-platform` ज़्यादा जानकारी के लिए, पुष्टि करने से जुड़ी खास जानकारी देखें.

rpc ExportDocuments(ExportDocumentsRequest) returns (Operation)

दस्तावेज़ों के सभी या एक सबसेट को Google Cloud Firestore से किसी दूसरे स्टोरेज सिस्टम में एक्सपोर्ट करता है, जैसे कि Google Cloud Storage. ऐसा हो सकता है कि दस्तावेज़ों में हाल ही में किए गए अपडेट, एक्सपोर्ट में न दिखें. एक्सपोर्ट, बैकग्राउंड में होता है. एक्सपोर्ट की प्रोग्रेस को, बनाए गए ऑपरेशन संसाधन के ज़रिए मॉनिटर और मैनेज किया जा सकता है. संबंधित कार्रवाई पूरी होने के बाद ही, एक्सपोर्ट के आउटपुट का इस्तेमाल किया जा सकता है. अगर एक्सपोर्ट की प्रोसेस पूरी होने से पहले ही रद्द कर दी जाती है, तो हो सकता है कि डेटा का कुछ हिस्सा Google Cloud Storage में न रहे.

अनुमति के दायरे

इनमें से किसी एक OAuth स्कोप की ज़रूरत होती है:

https://www.googleapis.com/auth/datastore
https://www.googleapis.com/auth/cloud-platform

ज़्यादा जानकारी के लिए, पुष्टि करने से जुड़ी खास जानकारी देखें.

गेटफ़ील्ड

गेटफ़ील्ड
`rpc GetField(GetFieldRequest) returns (Field)` इसकी मदद से, फ़ील्ड के लिए मेटाडेटा और कॉन्फ़िगरेशन की जानकारी मिलती है. अनुमति के दायरे इनमें से किसी एक OAuth स्कोप की ज़रूरत होती है: `https://www.googleapis.com/auth/datastore` `https://www.googleapis.com/auth/cloud-platform` ज़्यादा जानकारी के लिए, पुष्टि करने से जुड़ी खास जानकारी देखें.

rpc GetField(GetFieldRequest) returns (Field)

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

अनुमति के दायरे

इनमें से किसी एक OAuth स्कोप की ज़रूरत होती है:

https://www.googleapis.com/auth/datastore
https://www.googleapis.com/auth/cloud-platform

ज़्यादा जानकारी के लिए, पुष्टि करने से जुड़ी खास जानकारी देखें.

इंडेक्स करें

इंडेक्स करें
`rpc GetIndex(GetIndexRequest) returns (Index)` एक कंपोज़िट इंडेक्स हासिल करता है. अनुमति के दायरे इनमें से किसी एक OAuth स्कोप की ज़रूरत होती है: `https://www.googleapis.com/auth/datastore` `https://www.googleapis.com/auth/cloud-platform` ज़्यादा जानकारी के लिए, पुष्टि करने से जुड़ी खास जानकारी देखें.

rpc GetIndex(GetIndexRequest) returns (Index)

एक कंपोज़िट इंडेक्स हासिल करता है.

अनुमति के दायरे

इनमें से किसी एक OAuth स्कोप की ज़रूरत होती है:

https://www.googleapis.com/auth/datastore
https://www.googleapis.com/auth/cloud-platform

ज़्यादा जानकारी के लिए, पुष्टि करने से जुड़ी खास जानकारी देखें.

दस्तावेज़ इंपोर्ट करें

दस्तावेज़ इंपोर्ट करें
`rpc ImportDocuments(ImportDocumentsRequest) returns (Operation)` Google Cloud Firestore में दस्तावेज़ इंपोर्ट करता है. समान नाम वाले मौजूदा दस्तावेज़ों को ओवरराइट कर दिया जाता है. इंपोर्ट बैकग्राउंड में होता है और उसकी प्रोग्रेस को, बनाए गए ऑपरेशन संसाधन के ज़रिए मॉनिटर और मैनेज किया जा सकता है. अगर ImportDocuments की कार्रवाई रद्द कर दी जाती है, तो हो सकता है कि डेटा के किसी सबसेट को पहले ही Cloud Firestore में इंपोर्ट कर लिया गया हो. अनुमति के दायरे इनमें से किसी एक OAuth स्कोप की ज़रूरत होती है: `https://www.googleapis.com/auth/datastore` `https://www.googleapis.com/auth/cloud-platform` ज़्यादा जानकारी के लिए, पुष्टि करने से जुड़ी खास जानकारी देखें.

rpc ImportDocuments(ImportDocumentsRequest) returns (Operation)

Google Cloud Firestore में दस्तावेज़ इंपोर्ट करता है. समान नाम वाले मौजूदा दस्तावेज़ों को ओवरराइट कर दिया जाता है. इंपोर्ट बैकग्राउंड में होता है और उसकी प्रोग्रेस को, बनाए गए ऑपरेशन संसाधन के ज़रिए मॉनिटर और मैनेज किया जा सकता है. अगर ImportDocuments की कार्रवाई रद्द कर दी जाती है, तो हो सकता है कि डेटा के किसी सबसेट को पहले ही Cloud Firestore में इंपोर्ट कर लिया गया हो.

अनुमति के दायरे

इनमें से किसी एक OAuth स्कोप की ज़रूरत होती है:

https://www.googleapis.com/auth/datastore
https://www.googleapis.com/auth/cloud-platform

ज़्यादा जानकारी के लिए, पुष्टि करने से जुड़ी खास जानकारी देखें.

सूची फ़ील्ड

सूची फ़ील्ड
`rpc ListFields(ListFieldsRequest) returns (ListFieldsResponse)` इस डेटाबेस के लिए फ़ील्ड कॉन्फ़िगरेशन और मेटाडेटा की जानकारी देता है. फ़िलहाल, `FirestoreAdmin.ListFields` सिर्फ़ उन लिस्टिंग फ़ील्ड के साथ काम करता है जिन्हें साफ़ तौर पर बदल दिया गया है. यह क्वेरी जारी करने के लिए, `indexConfig.usesAncestorConfig:false` पर सेट फ़िल्टर के साथ `FirestoreAdmin.ListFields` को कॉल करें. अनुमति के दायरे इनमें से किसी एक OAuth स्कोप की ज़रूरत होती है: `https://www.googleapis.com/auth/datastore` `https://www.googleapis.com/auth/cloud-platform` ज़्यादा जानकारी के लिए, पुष्टि करने से जुड़ी खास जानकारी देखें.

rpc ListFields(ListFieldsRequest) returns (ListFieldsResponse)

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

फ़िलहाल, FirestoreAdmin.ListFields सिर्फ़ उन लिस्टिंग फ़ील्ड के साथ काम करता है जिन्हें साफ़ तौर पर बदल दिया गया है. यह क्वेरी जारी करने के लिए, indexConfig.usesAncestorConfig:false पर सेट फ़िल्टर के साथ FirestoreAdmin.ListFields को कॉल करें.

अनुमति के दायरे

इनमें से किसी एक OAuth स्कोप की ज़रूरत होती है:

https://www.googleapis.com/auth/datastore
https://www.googleapis.com/auth/cloud-platform

ज़्यादा जानकारी के लिए, पुष्टि करने से जुड़ी खास जानकारी देखें.

सूची के इंडेक्स

सूची के इंडेक्स
`rpc ListIndexes(ListIndexesRequest) returns (ListIndexesResponse)` यह कंपोज़िट इंडेक्स की सूची बनाता है. अनुमति के दायरे इनमें से किसी एक OAuth स्कोप की ज़रूरत होती है: `https://www.googleapis.com/auth/datastore` `https://www.googleapis.com/auth/cloud-platform` ज़्यादा जानकारी के लिए, पुष्टि करने से जुड़ी खास जानकारी देखें.

rpc ListIndexes(ListIndexesRequest) returns (ListIndexesResponse)

यह कंपोज़िट इंडेक्स की सूची बनाता है.

अनुमति के दायरे

इनमें से किसी एक OAuth स्कोप की ज़रूरत होती है:

https://www.googleapis.com/auth/datastore
https://www.googleapis.com/auth/cloud-platform

ज़्यादा जानकारी के लिए, पुष्टि करने से जुड़ी खास जानकारी देखें.

फ़ील्ड अपडेट करें

फ़ील्ड अपडेट करें
`rpc UpdateField(UpdateFieldRequest) returns (Operation)` फ़ील्ड कॉन्फ़िगरेशन को अपडेट करता है. फ़िलहाल, फ़ील्ड अपडेट सिर्फ़ सिंगल फ़ील्ड इंडेक्स कॉन्फ़िगरेशन पर लागू होते हैं. हालांकि, `FirestoreAdmin.UpdateField` पर किए जाने वाले कॉल के लिए फ़ील्ड मास्क देना चाहिए. ऐसा करके, किसी ऐसे कॉन्फ़िगरेशन को बदलने से बचा जा सकता है जिसके बारे में कॉलर को पता न हो. फ़ील्ड मास्क को इस तरह से दिखाया जाना चाहिए: `{ paths: "index_config" }`. यह कॉल, `google.longrunning.Operation` दिखाता है, जिसका इस्तेमाल फ़ील्ड अपडेट की स्थिति को ट्रैक करने के लिए किया जा सकता है. कार्रवाई का मेटाडेटा `FieldOperationMetadata` टाइप होगा. डेटाबेस के लिए डिफ़ॉल्ट फ़ील्ड सेटिंग को कॉन्फ़िगर करने के लिए, रिसॉर्स नाम के साथ खास `Field` का इस्तेमाल करें: `projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/*`. अनुमति के दायरे इनमें से किसी एक OAuth स्कोप की ज़रूरत होती है: `https://www.googleapis.com/auth/datastore` `https://www.googleapis.com/auth/cloud-platform` ज़्यादा जानकारी के लिए, पुष्टि करने से जुड़ी खास जानकारी देखें.

rpc UpdateField(UpdateFieldRequest) returns (Operation)

फ़ील्ड कॉन्फ़िगरेशन को अपडेट करता है. फ़िलहाल, फ़ील्ड अपडेट सिर्फ़ सिंगल फ़ील्ड इंडेक्स कॉन्फ़िगरेशन पर लागू होते हैं. हालांकि, FirestoreAdmin.UpdateField पर किए जाने वाले कॉल के लिए फ़ील्ड मास्क देना चाहिए. ऐसा करके, किसी ऐसे कॉन्फ़िगरेशन को बदलने से बचा जा सकता है जिसके बारे में कॉलर को पता न हो. फ़ील्ड मास्क को इस तरह से दिखाया जाना चाहिए: { paths: "index_config" }.

यह कॉल, google.longrunning.Operation दिखाता है, जिसका इस्तेमाल फ़ील्ड अपडेट की स्थिति को ट्रैक करने के लिए किया जा सकता है. कार्रवाई का मेटाडेटा FieldOperationMetadata टाइप होगा.

डेटाबेस के लिए डिफ़ॉल्ट फ़ील्ड सेटिंग को कॉन्फ़िगर करने के लिए, रिसॉर्स नाम के साथ खास Field का इस्तेमाल करें: projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/*.

अनुमति के दायरे

इनमें से किसी एक OAuth स्कोप की ज़रूरत होती है:

https://www.googleapis.com/auth/datastore
https://www.googleapis.com/auth/cloud-platform

ज़्यादा जानकारी के लिए, पुष्टि करने से जुड़ी खास जानकारी देखें.

इंडेक्स करने के लिए अनुरोध करें

FirestoreAdmin.CreateIndex का अनुरोध.

फ़ील्ड

parent

string

projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id} फ़ॉर्म का पैरंट नाम

index

Index

बनाने के लिए कंपोज़िट इंडेक्स.

इंडेक्स करने का अनुरोध मिटाएं

FirestoreAdmin.DeleteIndex का अनुरोध.

फ़ील्ड

फ़ील्ड
`name`	`string` फ़ॉर्म का नाम `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}`

name

string

फ़ॉर्म का नाम projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}

निर्यात दस्तावेज़ मेटाडेटा

FirestoreAdmin.ExportDocuments से मिले google.longrunning.Operation नतीजों का मेटाडेटा.

फ़ील्ड
`start_time`	`Timestamp` यह कार्रवाई शुरू होने का समय.
`end_time`	`Timestamp` इस कार्रवाई के पूरा होने का समय. अगर कार्रवाई अब भी जारी है, तो सेट नहीं की जाएगी.
`operation_state`	`OperationState` एक्सपोर्ट की स्थिति.
`progress_documents`	`Progress` दस्तावेज़ों में इस कार्रवाई की प्रोग्रेस.
`progress_bytes`	`Progress` इस कार्रवाई की प्रोग्रेस (बाइट में).
`collection_ids[]`	`string` कौनसे कलेक्शन आईडी एक्सपोर्ट किए जा रहे हैं.
`output_uri_prefix`	`string` जहां इकाइयों को एक्सपोर्ट किया जा रहा है.

ExportDocumentsअनुरोध

FirestoreAdmin.ExportDocuments का अनुरोध.

फ़ील्ड

फ़ील्ड
`name`	`string` एक्सपोर्ट किया जाने वाला डेटाबेस. इसका फ़ॉर्मैट ऐसा होना चाहिए: `projects/{project_id}/databases/{database_id}`.
`collection_ids[]`	`string` कौनसे कलेक्शन आईडी एक्सपोर्ट करने हैं. जिस कलेक्शन की जानकारी नहीं दी गई है उसका मतलब है कि सभी कलेक्शन.
`output_uri_prefix`	`string` आउटपुट यूआरआई. फ़िलहाल, यह फ़ॉर्म `gs://BUCKET_NAME[/NAMESPACE_PATH]` के Google Cloud Storage के यूआरआई के साथ ही काम करता है. इसमें `BUCKET_NAME`, Google Cloud Storage बकेट का नाम है और `NAMESPACE_PATH`, Google Cloud Storage नेमस्पेस का पाथ है. हालांकि, इसका इस्तेमाल करना ज़रूरी नहीं है. कोई नाम चुनते समय, Google Cloud Storage के नाम रखने के दिशा-निर्देशों को ध्यान में रखें: https://cloud.google.com/storage/docs/naming. अगर यूआरआई एक बकेट (बिना नेमस्पेस पाथ के) है, तो शुरुआत के समय के आधार पर एक प्रीफ़िक्स जनरेट किया जाएगा.

name

string

एक्सपोर्ट किया जाने वाला डेटाबेस. इसका फ़ॉर्मैट ऐसा होना चाहिए: projects/{project_id}/databases/{database_id}.

collection_ids[]

string

कौनसे कलेक्शन आईडी एक्सपोर्ट करने हैं. जिस कलेक्शन की जानकारी नहीं दी गई है उसका मतलब है कि सभी कलेक्शन.

output_uri_prefix

string

आउटपुट यूआरआई. फ़िलहाल, यह फ़ॉर्म gs://BUCKET_NAME[/NAMESPACE_PATH] के Google Cloud Storage के यूआरआई के साथ ही काम करता है. इसमें BUCKET_NAME, Google Cloud Storage बकेट का नाम है और NAMESPACE_PATH, Google Cloud Storage नेमस्पेस का पाथ है. हालांकि, इसका इस्तेमाल करना ज़रूरी नहीं है. कोई नाम चुनते समय, Google Cloud Storage के नाम रखने के दिशा-निर्देशों को ध्यान में रखें: https://cloud.google.com/storage/docs/naming. अगर यूआरआई एक बकेट (बिना नेमस्पेस पाथ के) है, तो शुरुआत के समय के आधार पर एक प्रीफ़िक्स जनरेट किया जाएगा.

ExportDocumentsResponse

google.longrunning.Operation के रिस्पॉन्स फ़ील्ड में दिखाया गया.

फ़ील्ड

फ़ील्ड
`output_uri_prefix`	`string` आउटपुट फ़ाइलों की जगह. कार्रवाई पूरी होने के बाद, Cloud Firestore (यह प्रोजेक्ट या कोई दूसरा प्रोजेक्ट) में इंपोर्ट शुरू करने के लिए, इसका इस्तेमाल किया जा सकता है.

output_uri_prefix

string

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

फ़ील्ड

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

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

फ़ील्ड

फ़ील्ड
`name`	`string` `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}` फ़ॉर्म का फ़ील्ड नाम फ़ील्ड पाथ, कोई आसान फ़ील्ड नाम हो सकता है, उदाहरण के लिए `address` या Map_value में फ़ील्ड के लिए पाथ , जैसे कि `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 named`address.city`, not the map key`शहर`in the field`पता`.````represents a field named``, इसमें कोई फ़ील्ड नहीं होता. खास `Field` में, सभी फ़ील्ड को इंडेक्स करने की डिफ़ॉल्ट सेटिंग होती हैं. इस फ़ील्ड के संसाधन का नाम यह है: `projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/*` इस `Field` में तय किए गए इंडेक्स, उन सभी फ़ील्ड पर लागू किए जाएंगे जिनमें अपना `Field` इंडेक्स कॉन्फ़िगरेशन नहीं है.
`index_config`	`IndexConfig` इस फ़ील्ड के लिए इंडेक्स कॉन्फ़िगरेशन. अगर नीति को सेट नहीं किया जाता है, तो फ़ील्ड इंडेक्स करने की सुविधा, `ancestor_field` के तय किए गए कॉन्फ़िगरेशन पर वापस लागू हो जाएगी. इस फ़ील्ड के सभी इंडेक्स साफ़ तौर पर हटाने के लिए, इंडेक्स की खाली सूची के साथ कोई इंडेक्स कॉन्फ़िगरेशन तय करें.

name

string

projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path} फ़ॉर्म का फ़ील्ड नाम

फ़ील्ड पाथ, कोई आसान फ़ील्ड नाम हो सकता है, उदाहरण के लिए address या Map_value में फ़ील्ड के लिए पाथ , जैसे कि 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/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/* इस Field में तय किए गए इंडेक्स, उन सभी फ़ील्ड पर लागू किए जाएंगे जिनमें अपना Field इंडेक्स कॉन्फ़िगरेशन नहीं है.

index_config

IndexConfig

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

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

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

फ़ील्ड
`indexes[]`	`Index` इस फ़ील्ड के लिए इस्तेमाल किए जा सकने वाले इंडेक्स.
`uses_ancestor_config`	`bool` सिर्फ़ आउटपुट के लिए. सही होने पर, `Field` के इंडेक्स कॉन्फ़िगरेशन को `ancestor_field` में बताए गए कॉन्फ़िगरेशन से सेट किया जाता है. गलत होने पर, `Field` के इंडेक्स कॉन्फ़िगरेशन को साफ़ तौर पर बताया जाता है.
`ancestor_field`	`string` सिर्फ़ आउटपुट के लिए. यह नीति उस `Field` के संसाधन का नाम बताती है जिससे इस फ़ील्ड का इंडेक्स कॉन्फ़िगरेशन सेट किया गया है (जब `uses_ancestor_config` सही हो). इसके अलावा, अगर इस फ़ील्ड में कोई इंडेक्स कॉन्फ़िगरेशन नहीं था (जब `uses_ancestor_config` गलत है), तो इस फ़ील्ड में इसे सेट किया जाएगा.
`reverting`	`bool` सही होने पर सिर्फ़ आउटपुट दिखाता है, लेकिन `Field` का इंडेक्स कॉन्फ़िगरेशन पहले जैसा किया जा रहा है. प्रोसेस पूरी होने के बाद, इंडेक्स कॉन्फ़िगरेशन उसी स्थिति में बदल जाएगा जिसमें `ancestor_field` के बताए गए फ़ील्ड की स्थिति बदल जाएगी. इस अपडेट में, `uses_ancestor_config` `true` हो जाएगा और `reverting`, `false` हो जाएगा.

फ़ील्ड कार्रवाई मेटाडेटा

FirestoreAdmin.UpdateField से मिले google.longrunning.Operation नतीजों का मेटाडेटा.

फ़ील्ड
`start_time`	`Timestamp` यह कार्रवाई शुरू होने का समय.
`end_time`	`Timestamp` इस कार्रवाई के पूरा होने का समय. अगर कार्रवाई अब भी जारी है, तो सेट नहीं की जाएगी.
`field`	`string` वह फ़ील्ड संसाधन जिस पर यह कार्रवाई की जा रही है. उदाहरण के लिए: `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}`
`index_config_deltas[]`	`IndexConfigDelta` `IndexConfigDelta` की सूची, जो इस कार्रवाई के मकसद के बारे में बताती है.
`state`	`OperationState` कार्रवाई की स्थिति.
`document_progress`	`Progress` दस्तावेज़ों में इस कार्रवाई की प्रोग्रेस.
`bytes_progress`	`Progress` इस कार्रवाई की प्रोग्रेस (बाइट में).

इंडेक्स कॉन्फ़िगडेल्टा

इंडेक्स कॉन्फ़िगरेशन में बदलाव के बारे में जानकारी.

फ़ील्ड

change_type

ChangeType

इससे पता चलता है कि इंडेक्स कैसे बदल रहा है.

index

Index

इंडेक्स में बदलाव किया जा रहा है.

परिवर्तन प्रकार

इससे पता चलता है कि इंडेक्स कैसे बदल रहा है.

एनम्स
`CHANGE_TYPE_UNSPECIFIED`	बदलाव किस तरह का है इसकी जानकारी नहीं है या वह तय नहीं है.
`ADD`	सिंगल फ़ील्ड इंडेक्स जोड़ा जा रहा है.
`REMOVE`	सिंगल फ़ील्ड इंडेक्स हटाया जा रहा है.

गेटफ़ील्डअनुरोध

FirestoreAdmin.GetField का अनुरोध.

फ़ील्ड

फ़ील्ड
`name`	`string` फ़ॉर्म का नाम `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_id}`

name

string

फ़ॉर्म का नाम projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_id}

इंडेक्स करें अनुरोध

FirestoreAdmin.GetIndex का अनुरोध.

फ़ील्ड

फ़ील्ड
`name`	`string` फ़ॉर्म का नाम `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}`

name

string

फ़ॉर्म का नाम projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}

आयात दस्तावेज़ मेटाडेटा

FirestoreAdmin.ImportDocuments से मिले google.longrunning.Operation नतीजों का मेटाडेटा.

फ़ील्ड
`start_time`	`Timestamp` यह कार्रवाई शुरू होने का समय.
`end_time`	`Timestamp` इस कार्रवाई के पूरा होने का समय. अगर कार्रवाई अब भी जारी है, तो सेट नहीं की जाएगी.
`operation_state`	`OperationState` इंपोर्ट करने की स्थिति.
`progress_documents`	`Progress` दस्तावेज़ों में इस कार्रवाई की प्रोग्रेस.
`progress_bytes`	`Progress` इस कार्रवाई की प्रोग्रेस (बाइट में).
`collection_ids[]`	`string` कौनसे कलेक्शन आईडी इंपोर्ट किए जा रहे हैं.
`input_uri_prefix`	`string` इंपोर्ट किए जा रहे दस्तावेज़ों की जगह की जानकारी.

आयात दस्तावेज़ अनुरोध

FirestoreAdmin.ImportDocuments का अनुरोध.

फ़ील्ड

फ़ील्ड
`name`	`string` डेटाबेस जिसमें इंपोर्ट करना है. इसका फ़ॉर्मैट ऐसा होना चाहिए: `projects/{project_id}/databases/{database_id}`.
`collection_ids[]`	`string` कौनसे कलेक्शन आईडी इंपोर्ट करने हैं. वैल्यू सेट न होने का मतलब है कि इंपोर्ट में शामिल सभी कलेक्शन.
`input_uri_prefix`	`string` एक्सपोर्ट की गई फ़ाइलों की जगह. यह किसी ऐसे एक्सपोर्ट के ExportDocumentsResponse के आउटपुट_uri_prefix से मेल खाना चाहिए, जो पूरा हो चुका है. देखें: `google.firestore.admin.v1beta2.ExportDocumentsResponse.output_uri_prefix`.

name

string

डेटाबेस जिसमें इंपोर्ट करना है. इसका फ़ॉर्मैट ऐसा होना चाहिए: projects/{project_id}/databases/{database_id}.

collection_ids[]

string

कौनसे कलेक्शन आईडी इंपोर्ट करने हैं. वैल्यू सेट न होने का मतलब है कि इंपोर्ट में शामिल सभी कलेक्शन.

input_uri_prefix

string

एक्सपोर्ट की गई फ़ाइलों की जगह. यह किसी ऐसे एक्सपोर्ट के ExportDocumentsResponse के आउटपुट_uri_prefix से मेल खाना चाहिए, जो पूरा हो चुका है. देखें: google.firestore.admin.v1beta2.ExportDocumentsResponse.output_uri_prefix.

इंडेक्स

Cloud Firestore इंडेक्स, डेटाबेस में मौजूद दस्तावेज़ों के लिए आसान और मुश्किल क्वेरी को चालू करते हैं.

फ़ील्ड
`name`	`string` सिर्फ़ आउटपुट के लिए. इस इंडेक्स के लिए सर्वर का तय किया गया नाम. कंपोज़िट इंडेक्स के लिए इस नाम का नाम यह होगा: `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{composite_index_id}` सिंगल फ़ील्ड इंडेक्स के लिए, यह फ़ील्ड खाली होगा.
`query_scope`	`QueryScope` जिन इंडेक्स में कलेक्शन क्वेरी के स्कोप की जानकारी होती है उनमें ऐसे कलेक्शन के लिए क्वेरी की जा सकती है जो किसी खास दस्तावेज़ का चाइल्ड कलेक्शन है. साथ ही, क्वेरी के समय तय किया जाता है और कलेक्शन आईडी एक ही होता है. जिन इंडेक्स में कलेक्शन ग्रुप के क्वेरी के दायरे की जानकारी होती है उनमें ऐसे सभी कलेक्शन के लिए क्वेरी करने की अनुमति होती है जो किसी खास दस्तावेज़ से लिए गए हैं. इन कलेक्शन को क्वेरी के समय तय किया जाता है और जिनके कलेक्शन आईडी का कलेक्शन आईडी इस इंडेक्स के जैसा ही होता है.
`fields[]`	`IndexField` इस इंडेक्स में इस्तेमाल किए जाने वाले फ़ील्ड. कंपोज़िट इंडेक्स के लिए, इसमें हमेशा दो या उससे ज़्यादा फ़ील्ड होते हैं. आखिरी फ़ील्ड एंट्री हमेशा फ़ील्ड पाथ `__name__` के लिए होती है. अगर फ़ील्ड बनाते समय, `__name__` को आखिरी फ़ील्ड के तौर पर नहीं बताया गया था, तो इसे अपने-आप ठीक उसी दिशा में जोड़ दिया जाएगा जिस दिशा में आखिरी फ़ील्ड में दिया गया था. अगर किसी कंपोज़िट इंडेक्स में आखिरी फ़ील्ड दिशात्मक नहीं है, तो `__name__` को ASCENDING के लिए क्रम में लगाया जाएगा (जब तक कि साफ़ तौर पर बताया न गया हो). सिंगल फ़ील्ड इंडेक्स के लिए, यह हमेशा सिर्फ़ एक एंट्री होगी. इसमें फ़ील्ड पाथ, उससे जुड़े फ़ील्ड के फ़ील्ड पाथ के बराबर होगा.
`state`	`State` सिर्फ़ आउटपुट के लिए. इंडेक्स किए जाने की स्थिति.

इंडेक्सफ़ील्ड

इंडेक्स में मौजूद फ़ील्ड. फ़ील्ड_पाथ से यह पता चलता है कि किस फ़ील्ड को इंडेक्स किया गया है. वहीं, value_mode से यह पता चलता है कि फ़ील्ड की वैल्यू को कैसे इंडेक्स किया गया है.

फ़ील्ड
`field_path`	`string` इसके लिए, name का इस्तेमाल किया जा सकता है. सिंगल फ़ील्ड इंडेक्स के लिए, इसका नाम फ़ील्ड के नाम से मेल खाना चाहिए या इसे हटाया जा सकता है.
यूनियन फ़ील्ड `value_mode`. फ़ील्ड वैल्यू को इंडेक्स करने का तरीका. `value_mode` इनमें से सिर्फ़ एक हो सकता है:
`order`	`Order` इससे पता चलता है कि इस फ़ील्ड में, तय किए गए क्रम के हिसाब से क्रम तय किया जा सकता है या फिर =, <, <=, >, >= का इस्तेमाल करके तुलना की जा सकती है.
`array_config`	`ArrayConfig` इससे पता चलता है कि इस फ़ील्ड पर `array_value` पर कार्रवाइयां की जा सकती हैं.

अरे कॉन्फ़िगरेशन

इस्तेमाल किए जा सकने वाले अरे वैल्यू के कॉन्फ़िगरेशन.

एनम्स
`ARRAY_CONFIG_UNSPECIFIED`	इस इंडेक्स में, अतिरिक्त अरे क्वेरी इस्तेमाल नहीं की जा सकतीं.
`CONTAINS`	इस इंडेक्स में, अरे कंटेनमेंट क्वेरी का इस्तेमाल किया जा सकता है.

क्रम

इस्तेमाल किए जा सकने वाले क्रम.

एनम्स
`ORDER_UNSPECIFIED`	ऑर्डर की जानकारी नहीं है. यह विकल्प मान्य नहीं है.
`ASCENDING`	फ़ील्ड को बढ़ते क्रम में फ़ील्ड वैल्यू के हिसाब से क्रम में लगाया जाता है.
`DESCENDING`	फ़ील्ड को घटते क्रम में फ़ील्ड की वैल्यू के हिसाब से क्रम में लगाया जाता है.

क्वेरी का दायरा

क्वेरी का स्कोप उस स्कोप के बारे में बताता है जिस पर क्वेरी चलाई जाती है. यह जानकारी, स्ट्रक्चर्ड क्वेरी के from फ़ील्ड में दी जाती है.

एनम्स
`QUERY_SCOPE_UNSPECIFIED`	क्वेरी का दायरा नहीं बताया गया है. यह विकल्प मान्य नहीं है.
`COLLECTION`	जिन इंडेक्स में कलेक्शन क्वेरी के स्कोप की जानकारी होती है उनमें ऐसे कलेक्शन के लिए क्वेरी शामिल की जा सकती हैं जो किसी खास दस्तावेज़ का चाइल्ड कलेक्शन है. साथ ही, क्वेरी के समय तय किया जाता है और जिसमें इंडेक्स से तय किया गया कलेक्शन आईडी होता है.
`COLLECTION_GROUP`	जिन इंडेक्स में कलेक्शन ग्रुप क्वेरी के स्कोप की जानकारी होती है उनमें उन सभी कलेक्शन के लिए क्वेरी का इस्तेमाल करने की अनुमति होती है जिनमें इंडेक्स से तय किया गया कलेक्शन आईडी होता है.

राज्य

इंडेक्स की स्थिति. इंडेक्स बनाने के दौरान, इंडेक्स CREATING की स्थिति में होगा. अगर इंडेक्स बन जाता है, तो इसका स्टेटस READY में बदल जाएगा. अगर इंडेक्स बनाने में कोई समस्या आती है, तो इंडेक्स NEEDS_REPAIR की स्थिति में बदल जाएगा.

एनम्स
`STATE_UNSPECIFIED`	राज्य की जानकारी नहीं है.
`CREATING`	इंडेक्स बनाया जा रहा है. इंडेक्स करने के लिए, लंबे समय से एक प्रोसेस चल रही है. कोई दस्तावेज़ लिखते समय इंडेक्स को अपडेट किया जाता है. इंडेक्स किया गया कुछ डेटा मौजूद हो सकता है.
`READY`	इंडेक्स इस्तेमाल के लिए तैयार है. कोई दस्तावेज़ लिखते समय इंडेक्स को अपडेट किया जाता है. इंडेक्स में, सेव किए गए उन सभी दस्तावेज़ों से अपने-आप जानकारी भर जाती है जिन पर यह लागू होता है.
`NEEDS_REPAIR`	इंडेक्स बनाया जा रहा था, लेकिन कोई गड़बड़ी हुई. इंडेक्स के लिए, लंबे समय तक चलने वाली कोई कार्रवाई नहीं है. साथ ही, हाल ही में खत्म हुई, लंबे समय तक चलने वाली कार्रवाई नहीं हो सकी. दस्तावेज़ लिखते समय इंडेक्स को अपडेट नहीं किया जाता. इंडेक्स किया गया कुछ डेटा मौजूद हो सकता है. google.longदौड़.Operations API का इस्तेमाल करके पता लगाएं कि पिछली बार इस इंडेक्स को बनाने की कोशिश क्यों नहीं की गई थी. इसके बाद, इंडेक्स को फिर से बनाएं.

इंडेक्सऑपरेशन मेटाडेटा

FirestoreAdmin.CreateIndex से मिले google.longrunning.Operation नतीजों का मेटाडेटा.

फ़ील्ड
`start_time`	`Timestamp` यह कार्रवाई शुरू होने का समय.
`end_time`	`Timestamp` इस कार्रवाई के पूरा होने का समय. अगर कार्रवाई अब भी जारी है, तो सेट नहीं की जाएगी.
`index`	`string` वह इंडेक्स संसाधन जिस पर यह कार्रवाई की जा रही है. उदाहरण के लिए: `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}`
`state`	`OperationState` कार्रवाई की स्थिति.
`progress_documents`	`Progress` दस्तावेज़ों में इस कार्रवाई की प्रोग्रेस.
`progress_bytes`	`Progress` इस कार्रवाई की प्रोग्रेस (बाइट में).

सूची फ़ील्ड का अनुरोध

FirestoreAdmin.ListFields का अनुरोध.

फ़ील्ड
`parent`	`string` `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}` फ़ॉर्म का पैरंट नाम
`filter`	`string` सूची के नतीजों पर लागू करने के लिए फ़िल्टर. फ़िलहाल, `FirestoreAdmin.ListFields` सिर्फ़ उन लिस्टिंग फ़ील्ड के साथ काम करता है जिन्हें साफ़ तौर पर बदल दिया गया है. यह क्वेरी जारी करने के लिए, `indexConfig.usesAncestorConfig:false` पर सेट फ़िल्टर के साथ `FirestoreAdmin.ListFields` को कॉल करें.
`page_size`	`int32` दिए जाने वाले नतीजों की संख्या.
`page_token`	`string` यह पेज टोकन, `FirestoreAdmin.ListFields` को किए गए पिछले कॉल के ज़रिए दिखाया जाता है. इसका इस्तेमाल, नतीजों का अगला पेज दिखाने के लिए किया जा सकता है.

ListFieldsResponse

FirestoreAdmin.ListFields का जवाब.

फ़ील्ड

फ़ील्ड
`fields[]`	`Field` अनुरोध किए गए फ़ील्ड.
`next_page_token`	`string` पेज टोकन, जिसका इस्तेमाल नतीजों के किसी दूसरे पेज के लिए अनुरोध करने के लिए किया जा सकता है. अगर खाली है, तो यह आखिरी पेज है.

fields[]

Field

अनुरोध किए गए फ़ील्ड.

next_page_token

string

पेज टोकन, जिसका इस्तेमाल नतीजों के किसी दूसरे पेज के लिए अनुरोध करने के लिए किया जा सकता है. अगर खाली है, तो यह आखिरी पेज है.

ListIndexesRequest

FirestoreAdmin.ListIndexes का अनुरोध.

फ़ील्ड
`parent`	`string` `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}` फ़ॉर्म का पैरंट नाम
`filter`	`string` सूची के नतीजों पर लागू करने के लिए फ़िल्टर.
`page_size`	`int32` दिए जाने वाले नतीजों की संख्या.
`page_token`	`string` यह पेज टोकन, `FirestoreAdmin.ListIndexes` को किए गए पिछले कॉल के ज़रिए दिखाया जाता है. इसका इस्तेमाल, नतीजों का अगला पेज दिखाने के लिए किया जा सकता है.

ListIndexesResponse

FirestoreAdmin.ListIndexes का जवाब.

फ़ील्ड

फ़ील्ड
`indexes[]`	`Index` अनुरोध किए गए इंडेक्स.
`next_page_token`	`string` पेज टोकन, जिसका इस्तेमाल नतीजों के किसी दूसरे पेज के लिए अनुरोध करने के लिए किया जा सकता है. अगर खाली है, तो यह आखिरी पेज है.

indexes[]

Index

अनुरोध किए गए इंडेक्स.

next_page_token

string

ऑपरेशन स्टेट

कार्रवाई की स्थिति के बारे में बताता है.

एनम्स
`OPERATION_STATE_UNSPECIFIED`	बताया नहीं गया है.
`INITIALIZING`	अनुरोध को प्रोसेस करने के लिए तैयार किया जा रहा है.
`PROCESSING`	अनुरोध को प्रोसेस किया जा रहा है.
`CANCELLING`	अनुरोध को तब रद्द किया जा रहा है, जब उपयोगकर्ता ने कार्रवाई पर google.longदौड़.Operations.CancelOperation को कॉल किया.
`FINALIZING`	अनुरोध को प्रोसेस किया जा चुका है और यह आखिरी चरण में है.
`SUCCESSFUL`	अनुरोध पूरा हो गया.
`FAILED`	अनुरोध की प्रक्रिया पूरी हो चुकी है, लेकिन इसमें कोई गड़बड़ी हुई.
`CANCELLED`	उपयोगकर्ता को google.longदौड़.Operations.CancelOperation नाम से कॉल करने के बाद अनुरोध को रद्द कर दिया गया.

प्रगति

कार्रवाई की प्रोग्रेस के बारे में बताता है. काम की इकाई सामान्य है और Progress का इस्तेमाल कहां किया गया है, इसके हिसाब से इसे लिखा जाना चाहिए.

फ़ील्ड

फ़ील्ड
`estimated_work`	`int64` अनुमानित काम.
`completed_work`	`int64` काम पूरा हुआ.

estimated_work

int64

अनुमानित काम.

completed_work

int64

काम पूरा हुआ.

अपडेट फ़ील्ड अनुरोध

FirestoreAdmin.UpdateField का अनुरोध.

फ़ील्ड

फ़ील्ड
`field`	`Field` अपडेट किया जाने वाला फ़ील्ड.
`update_mask`	`FieldMask` फ़ील्ड के हिसाब से मास्क. अगर तय किया गया है, तो फ़ील्ड में सिर्फ़ इस फ़ील्ड_मास्क से तय किए गए कॉन्फ़िगरेशन को अपडेट किया जाएगा.

field

Field

अपडेट किया जाने वाला फ़ील्ड.

update_mask

FieldMask

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