इस पेज का अनुवाद 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 (मैसेज)

FirestoreAdmin

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

CreateIndex

CreateIndex
`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

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

DeleteIndex

DeleteIndex
`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

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

ExportDocuments

ExportDocuments
`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

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

GetField

GetField
`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

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

GetIndex

GetIndex
`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

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

ImportDocuments

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

rpc ImportDocuments(ImportDocumentsRequest) returns (Operation)

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

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

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

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

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

ListFields

ListFields
`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

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

ListIndexes

ListIndexes
`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

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

UpdateField

UpdateField
`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

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

CreateIndexRequest

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

फ़ील्ड

parent

string

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

index

Index

वह कंपोज़िट इंडेक्स जिसे बनाना है.

DeleteIndexRequest

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} फ़ॉर्म का नाम

ExportDocumentsMetadata

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` जहां इकाइयों को एक्सपोर्ट किया जा रहा है.

ExportDocumentsRequest

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 सिंबल वाले वर्णों का इस्तेमाल करके कोट किया जा सकता है. उदाहरण: (ध्यान दें: यहां टिप्पणियां मार्कडाउन सिंटैक्स में लिखी गई हैं. इसलिए, कोड ब्लॉक को दिखाने के लिए बैकटिक में एक और लेयर जोड़ी गई है) `\`address.city``represents a field named`address.city`, not the map key`city`in the field`address`.````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 सिंबल वाले वर्णों का इस्तेमाल करके कोट किया जा सकता है.

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

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

index_config

IndexConfig

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

IndexConfig

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

फ़ील्ड
`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` होगा.

FieldOperationMetadata

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` इस कार्रवाई की प्रोग्रेस, बाइट में.

IndexConfigDelta

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

फ़ील्ड

change_type

ChangeType

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

index

Index

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

ChangeType

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

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

GetFieldRequest

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} फ़ॉर्म का नाम

GetIndexRequest

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} फ़ॉर्म का नाम

ImportDocumentsMetadata

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` इंपोर्ट किए जा रहे दस्तावेज़ों की जगह.

ImportDocumentsRequest

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

फ़ील्ड

फ़ील्ड
`name`	`string` डेटाबेस जिसमें इंपोर्ट किया जाना है. वह इस रूप में होना चाहिए: `projects/{project_id}/databases/{database_id}`.
`collection_ids[]`	`string` कौनसे संग्रह आईडी इंपोर्ट किए जाने हैं. कोई वैल्यू तय नहीं करने का मतलब है कि इंपोर्ट में शामिल सभी कलेक्शन शामिल हैं.
`input_uri_prefix`	`string` एक्सपोर्ट की गई फ़ाइलों की जगह. यह सही से पूरा हो चुके किसी एक्सपोर्ट से एक्सपोर्ट किए गए ExportDocumentsResponse के formula_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 के formula_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` सिर्फ़ आउटपुट के लिए. इंडेक्स की सेवा की स्थिति.

IndexField

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

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

ArrayConfig

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

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

क्रम

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

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

QueryScope

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

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

स्थिति

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

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

IndexOperationMetadata

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` इस कार्रवाई की प्रोग्रेस, बाइट में.

ListFieldsRequest

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

OperationState

कार्रवाई की स्थिति की जानकारी देता है.

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

प्रगति

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

फ़ील्ड

फ़ील्ड
`estimated_work`	`int64` अनुमानित काम की संख्या.
`completed_work`	`int64` कितना काम पूरा हो गया.

estimated_work

int64

अनुमानित काम की संख्या.

completed_work

int64

कितना काम पूरा हो गया.

UpdateFieldRequest

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

फ़ील्ड

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

field

Field

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

update_mask

FieldMask

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