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

Package google.firestore.admin.v1

इंडेक्स

FirestoreAdmin (इंटरफ़ेस)
Backup (मैसेज)
Backup.State (enum)
BackupSchedule (मैसेज)
CreateBackupScheduleRequest (मैसेज)
CreateDatabaseMetadata (मैसेज)
CreateDatabaseRequest (मैसेज)
CreateIndexRequest (मैसेज)
DailyRecurrence (मैसेज)
Database (मैसेज)
Database.AppEngineIntegrationMode (enum)
Database.CmekConfig (मैसेज)
Database.ConcurrencyMode (enum)
Database.DatabaseType (enum)
Database.DeleteProtectionState (enum)
Database.PointInTimeRecoveryEnablement (enum)
DeleteBackupRequest (मैसेज)
DeleteBackupScheduleRequest (मैसेज)
DeleteDatabaseMetadata (मैसेज)
DeleteDatabaseRequest (मैसेज)
DeleteIndexRequest (मैसेज)
ExportDocumentsMetadata (मैसेज)
ExportDocumentsRequest (मैसेज)
ExportDocumentsResponse (मैसेज)
Field (मैसेज)
Field.IndexConfig (मैसेज)
Field.TtlConfig (मैसेज)
Field.TtlConfig.State (enum)
FieldOperationMetadata (मैसेज)
FieldOperationMetadata.IndexConfigDelta (मैसेज)
FieldOperationMetadata.IndexConfigDelta.ChangeType (enum)
FieldOperationMetadata.TtlConfigDelta (मैसेज)
FieldOperationMetadata.TtlConfigDelta.ChangeType (enum)
GetBackupRequest (मैसेज)
GetBackupScheduleRequest (मैसेज)
GetDatabaseRequest (मैसेज)
GetFieldRequest (मैसेज)
GetIndexRequest (मैसेज)
ImportDocumentsMetadata (मैसेज)
ImportDocumentsRequest (मैसेज)
Index (मैसेज)
Index.ApiScope (enum)
Index.IndexField (मैसेज)
Index.IndexField.ArrayConfig (enum)
Index.IndexField.Order (enum)
Index.IndexField.VectorConfig (मैसेज)
Index.IndexField.VectorConfig.FlatIndex (मैसेज)
Index.QueryScope (enum)
Index.State (enum)
IndexOperationMetadata (मैसेज)
ListBackupSchedulesRequest (मैसेज)
ListBackupSchedulesResponse (मैसेज)
ListBackupsRequest (मैसेज)
ListBackupsResponse (मैसेज)
ListDatabasesRequest (मैसेज)
ListDatabasesResponse (मैसेज)
ListFieldsRequest (मैसेज)
ListFieldsResponse (मैसेज)
ListIndexesRequest (मैसेज)
ListIndexesResponse (मैसेज)
LocationMetadata (मैसेज)
OperationState (enum)
Progress (मैसेज)
RestoreDatabaseMetadata (मैसेज)
RestoreDatabaseRequest (मैसेज)
UpdateBackupScheduleRequest (मैसेज)
UpdateDatabaseMetadata (मैसेज)
UpdateDatabaseRequest (मैसेज)
UpdateFieldRequest (मैसेज)
WeeklyRecurrence (मैसेज)

FirestoreAdmin

Cloud Firestore एडमिन एपीआई.

यह एपीआई, Cloud Firestore के लिए कई एडमिन सेवाएं उपलब्ध कराता है.

प्रोजेक्ट, डेटाबेस, नेमस्पेस, कलेक्शन, कलेक्शन ग्रुप, और दस्तावेज़ का इस्तेमाल, Google Cloud Firestore API में बताए गए तरीके से किया जाता है.

ऑपरेशन: एक ऑपरेशन बैकग्राउंड में किए जा रहे काम को दिखाता है.

इंडेक्स सेवा, Cloud Firestore इंडेक्स को मैनेज करती है.

इंडेक्स बनाने की प्रोसेस, एसिंक्रोनस तरीके से की जाती है. ऐसे हर एसिंक्रोनस ऑपरेशन के लिए एक ऑपरेशन संसाधन बनाया जाता है. ऑपरेशन की स्थिति (जिसमें किसी भी तरह की गड़बड़ी हुई है) के बारे में ऑपरेशन संसाधन से क्वेरी की जा सकती है.

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

पूरे हो चुके ऑपरेशन को मिटाया जा सकता है, ताकि उसे ऑपरेशन कलेक्शन के हिस्से के तौर पर सूची में न रखा जाए. ऑपरेशन में 30 दिनों के बाद इकट्ठा किया गया कचरा होता है. डिफ़ॉल्ट रूप से, ListOperations की वैल्यू सिर्फ़ जारी की जाती है और पूरी नहीं की जा सकी. पूरी हो चुकी कार्रवाई की सूची बनाने के लिए, done: true फ़िल्टर की मदद से ListOperations का अनुरोध करें.

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

Createबैकअप शेड्यूल

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

rpc CreateBackupSchedule(CreateBackupScheduleRequest) returns (BackupSchedule)

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

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

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

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

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

डेटाबेस बनाएं

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

rpc CreateDatabase(CreateDatabaseRequest) returns (Operation)

डेटाबेस बनाएं.

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

इनमें से किसी एक 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 CreateIndex(CreateIndexRequest) returns (Operation)

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

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

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

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

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

बैकअप मिटाएं

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

rpc DeleteBackup(DeleteBackupRequest) returns (Empty)

बैकअप को मिटाता है.

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

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

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

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

हटाएंबैकअप शेड्यूल

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

rpc DeleteBackupSchedule(DeleteBackupScheduleRequest) returns (Empty)

बैकअप शेड्यूल को मिटाता है.

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

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

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

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

डेटाबेस मिटाएं

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

rpc DeleteDatabase(DeleteDatabaseRequest) returns (Operation)

डेटाबेस को मिटाता है.

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

इनमें से किसी एक 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 में उसका कुछ डेटा सेव न हो. एक्सपोर्ट के व्यवहार और आउटपुट फ़ॉर्मैट के बारे में ज़्यादा जानकारी के लिए यहां जाएं: https://cloud.google.com/firestore/docs/manage-data/export-Import अनुमति के दायरे इनमें से किसी एक 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 में उसका कुछ डेटा सेव न हो.

एक्सपोर्ट के व्यवहार और आउटपुट फ़ॉर्मैट के बारे में ज़्यादा जानकारी के लिए यहां जाएं: https://cloud.google.com/firestore/docs/manage-data/export-Import

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

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

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

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

बैकअप पाएं

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

rpc GetBackup(GetBackupRequest) returns (Backup)

बैकअप के बारे में जानकारी मिलती है.

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

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

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

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

बैकअप शेड्यूल पाएं

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

rpc GetBackupSchedule(GetBackupScheduleRequest) returns (BackupSchedule)

बैकअप शेड्यूल के बारे में जानकारी दी जाती है.

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

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

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

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

डेटा बेस पाएं

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

rpc GetDatabase(GetDatabaseRequest) returns (Database)

डेटाबेस के बारे में जानकारी मिलती है.

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

इनमें से किसी एक 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 में दस्तावेज़ इंपोर्ट करता है. एक ही नाम वाले मौजूदा दस्तावेज़ों को ओवरराइट कर दिया जाता है. इंपोर्ट, बैकग्राउंड में होता है और इसकी प्रोग्रेस को, बनाए गए ऑपरेशन संसाधन से मॉनिटर और मैनेज किया जा सकता है. अगर 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

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

सूचीबैकअप शेड्यूल

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

rpc ListBackupSchedules(ListBackupSchedulesRequest) returns (ListBackupSchedulesResponse)

बैकअप शेड्यूल की सूची बनाएं.

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

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

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

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

सूची के बैकअप

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

rpc ListBackups(ListBackupsRequest) returns (ListBackupsResponse)

सभी बैकअप की सूची बनाता है.

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

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

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

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

सूची डेटाबेस

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

rpc ListDatabases(ListDatabasesRequest) returns (ListDatabasesResponse)

प्रोजेक्ट के सभी डेटाबेस की सूची बनाएं.

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

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

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

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

सूची फ़ील्ड

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

rpc ListFields(ListFieldsRequest) returns (ListFieldsResponse)

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

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

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

इनमें से किसी एक 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 RestoreDatabase(RestoreDatabaseRequest) returns (Operation)` मौजूदा बैकअप से डेटा वापस करके नया डेटाबेस बनाता है. नया डेटाबेस, मौजूदा बैकअप वाले क्लाउड क्षेत्र या कई क्षेत्रों वाली जगह पर ही होना चाहिए. यह [FirestoreAdmin.CreateDatabase][google.firestore.admin.v1.CreateDatabase] की तरह ही काम करता है. सिर्फ़ एक नया खाली डेटाबेस बनाने के बजाय, एक नया डेटाबेस बना दिया जाता है. इसमें मौजूदा बैकअप से डेटाबेस के प्रकार, इंडेक्स कॉन्फ़िगरेशन, और दस्तावेज़ों की मदद ली जाती है. `long-running operation` का इस्तेमाल, डेटा वापस लाने की प्रक्रिया को ट्रैक करने के लिए किया जा सकता है. साथ ही, कार्रवाई के `metadata` फ़ील्ड टाइप को `RestoreDatabaseMetadata` माना जाता है. अगर डेटा वापस लाने की प्रोसेस पूरी हो गई है, तो `response` टाइप `Database` है. एलआरओ के पूरा होने तक, नए डेटाबेस को न तो पढ़ा जा सकता है और न ही उसमें बदलाव किया जा सकता है. अनुमति के दायरे इनमें से किसी एक OAuth दायरों की ज़रूरत होती है: `https://www.googleapis.com/auth/datastore` `https://www.googleapis.com/auth/cloud-platform` ज़्यादा जानकारी के लिए, पुष्टि करने से जुड़ी खास जानकारी देखें.

rpc RestoreDatabase(RestoreDatabaseRequest) returns (Operation)

मौजूदा बैकअप से डेटा वापस करके नया डेटाबेस बनाता है.

नया डेटाबेस, मौजूदा बैकअप वाले क्लाउड क्षेत्र या कई क्षेत्रों वाली जगह पर ही होना चाहिए. यह [FirestoreAdmin.CreateDatabase][google.firestore.admin.v1.CreateDatabase] की तरह ही काम करता है. सिर्फ़ एक नया खाली डेटाबेस बनाने के बजाय, एक नया डेटाबेस बना दिया जाता है. इसमें मौजूदा बैकअप से डेटाबेस के प्रकार, इंडेक्स कॉन्फ़िगरेशन, और दस्तावेज़ों की मदद ली जाती है.

long-running operation का इस्तेमाल, डेटा वापस लाने की प्रक्रिया को ट्रैक करने के लिए किया जा सकता है. साथ ही, कार्रवाई के metadata फ़ील्ड टाइप को RestoreDatabaseMetadata माना जाता है. अगर डेटा वापस लाने की प्रोसेस पूरी हो गई है, तो response टाइप Database है. एलआरओ के पूरा होने तक, नए डेटाबेस को न तो पढ़ा जा सकता है और न ही उसमें बदलाव किया जा सकता है.

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

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

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

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

अपडेटबैकअप शेड्यूल

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

rpc UpdateBackupSchedule(UpdateBackupScheduleRequest) returns (BackupSchedule)

बैकअप शेड्यूल अपडेट करता है.

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

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

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

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

अपडेट डेटाबेस

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

rpc UpdateDatabase(UpdateDatabaseRequest) returns (Operation)

डेटाबेस को अपडेट करता है.

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

इनमें से किसी एक 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

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

बैकअप

Cloud Firestore डेटाबेस का बैकअप.

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

फ़ील्ड
`name`	`string` सिर्फ़ आउटपुट के लिए. बैकअप के यूनीक संसाधन का नाम. फ़ॉर्मैट `projects/{project}/locations/{location}/backups/{backup}` है.
`database`	`string` सिर्फ़ आउटपुट के लिए. उस Firestore डेटाबेस का नाम जिससे बैकअप लिया गया है. फ़ॉर्मैट `projects/{project}/databases/{database}` है.
`database_uid`	`string` सिर्फ़ आउटपुट के लिए. Firestore डेटाबेस के लिए सिस्टम से जनरेट किया गया UUID4, जिससे बैकअप लिया गया है.
`snapshot_time`	`Timestamp` सिर्फ़ आउटपुट के लिए. फ़िलहाल, बैकअप में डेटाबेस की बाहरी तौर पर एक जैसी कॉपी शामिल है.
`expire_time`	`Timestamp` सिर्फ़ आउटपुट के लिए. वह टाइमस्टैंप जब बैकअप की समयसीमा खत्म हो जाएगी.
`state`	`State` सिर्फ़ आउटपुट के लिए. बैकअप की मौजूदा स्थिति.

राज्य

बैकअप की मौजूदा स्थिति बताएं.

एनम्स
`STATE_UNSPECIFIED`	राज्य की जानकारी नहीं दी गई है.
`CREATING`	लंबित बैकअप अब भी बनाया जा रहा है. इस स्थिति में, बैकअप पर की जाने वाली कार्रवाइयों को अस्वीकार कर दिया जाएगा.
`READY`	बैकअप पूरा हो गया है और इस्तेमाल के लिए तैयार है.
`NOT_AVAILABLE`	फ़िलहाल, बैकअप लेने की सुविधा उपलब्ध नहीं है.

बैकअप शेड्यूल

Cloud Firestore डेटाबेस के लिए बैकअप शेड्यूल.

इस संसाधन का मालिकाना हक उस डेटाबेस के पास है जिसका वह बैक अप ले रहा है. इसे डेटाबेस के साथ मिटा दिया जाता है. हालांकि, असल बैकअप ऐसा नहीं होता है.

फ़ील्ड
`name`	`string` सिर्फ़ आउटपुट के लिए. किसी प्रोजेक्ट के लिए, सभी जगहों और डेटाबेस में बैकअप शेड्यूल का यूनीक आइडेंटिफ़ायर. इसे अपने-आप असाइन हो जाएगा. फ़ॉर्मैट `projects/{project}/databases/{database}/backupSchedules/{backup_schedule}` है
`create_time`	`Timestamp` सिर्फ़ आउटपुट के लिए. वह टाइमस्टैंप जब से यह बैकअप शेड्यूल बनाया गया था और तब से लागू है. इस शेड्यूल के लिए, इस समय से पहले कोई बैकअप नहीं बनाया जाएगा.
`update_time`	`Timestamp` सिर्फ़ आउटपुट के लिए. वह टाइमस्टैंप जिस पर इस बैकअप शेड्यूल को हाल ही में अपडेट किया गया था. जब पहली बार बैकअप शेड्यूल बनाया जाता है, तो वह create_time की तरह होता है.
`retention`	`Duration` बैकअप बनाए जाने के समय की तुलना में, आपको आने वाले समय में किसी तय समय पर बैकअप मिटा देना चाहिए. उदाहरण के लिए, बैकअप को सात दिनों तक सेव करके रखना चाहिए.
यूनियन फ़ील्ड `recurrence`. यह दिखाने वाला फ़ील्ड कि बैकअप कब लिया जाएगा. `recurrence` इनमें से सिर्फ़ एक हो सकती है:
`daily_recurrence`	`DailyRecurrence` रोज़ चलने वाले शेड्यूल के लिए.
`weekly_recurrence`	`WeeklyRecurrence` ऐसे शेड्यूल के लिए जो हर हफ़्ते किसी खास दिन पर चलता है.

Createबैकअप शेड्यूल अनुरोध

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

फ़ील्ड

फ़ील्ड
`parent`	`string` ज़रूरी है. पैरंट डेटाबेस. `projects/{project}/databases/{database}` फ़ॉर्मैट करें
`backup_schedule`	`BackupSchedule` ज़रूरी है. बनाने के लिए बैकअप शेड्यूल.

parent

string

ज़रूरी है. पैरंट डेटाबेस.

projects/{project}/databases/{database} फ़ॉर्मैट करें

backup_schedule

BackupSchedule

ज़रूरी है. बनाने के लिए बैकअप शेड्यूल.

CreateDatabaseमेटाडेटा

इस टाइप के लिए कोई फ़ील्ड नहीं है.

डेटाबेस बनाने की कार्रवाई से जुड़ा मेटाडेटा.

CreateDatabaseRequest

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

फ़ील्ड

फ़ील्ड
`parent`	`string` ज़रूरी है. `projects/{project_id}` फ़ॉर्म के पैरंट का नाम
`database`	`Database` ज़रूरी है. बनाया जाने वाला डेटाबेस.
`database_id`	`string` ज़रूरी है. डेटाबेस के लिए इस्तेमाल किया जाने वाला आईडी, जो डेटाबेस के संसाधन नाम का फ़ाइनल कॉम्पोनेंट बन जाएगा. यह वैल्यू 4 से 63 वर्णों की होनी चाहिए. मान्य वर्ण /[a-z][0-9]-/ होते हैं, जिनमें पहला वर्ण एक अक्षर और आखिरी में कोई अक्षर या संख्या होती है. UUID-जैसा /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/ नहीं होना चाहिए. "(डिफ़ॉल्ट)" डेटाबेस आईडी भी मान्य है.

parent

string

ज़रूरी है. projects/{project_id} फ़ॉर्म के पैरंट का नाम

database

Database

ज़रूरी है. बनाया जाने वाला डेटाबेस.

database_id

string

ज़रूरी है. डेटाबेस के लिए इस्तेमाल किया जाने वाला आईडी, जो डेटाबेस के संसाधन नाम का फ़ाइनल कॉम्पोनेंट बन जाएगा.

यह वैल्यू 4 से 63 वर्णों की होनी चाहिए. मान्य वर्ण /[a-z][0-9]-/ होते हैं, जिनमें पहला वर्ण एक अक्षर और आखिरी में कोई अक्षर या संख्या होती है. UUID-जैसा /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/ नहीं होना चाहिए.

"(डिफ़ॉल्ट)" डेटाबेस आईडी भी मान्य है.

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

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

फ़ील्ड

parent

string

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

index

Index

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

हर दिन दोहराया जाएगा

इस टाइप के लिए कोई फ़ील्ड नहीं है.

रोज़ाना चलने वाले शेड्यूल के बारे में बताता है.

समय क्षेत्र UTC है.

डेटाबेस

Cloud Firestore डेटाबेस.

फ़ील्ड
`name`	`string` डेटाबेस के संसाधन का नाम. फ़ॉर्मैट: `projects/{project}/databases/{database}`
`uid`	`string` सिर्फ़ आउटपुट के लिए. इस डेटाबेस के लिए सिस्टम से जनरेट किया गया UUID4.
`create_time`	`Timestamp` सिर्फ़ आउटपुट के लिए. वह टाइमस्टैंप जिस पर इस डेटाबेस को बनाया गया था. साल 2016 से पहले बनाए गए डेटाबेस, create_time को पॉप्युलेट नहीं करते हैं.
`update_time`	`Timestamp` सिर्फ़ आउटपुट के लिए. वह टाइमस्टैंप जब इस डेटाबेस को हाल ही में अपडेट किया गया था. ध्यान दें कि इसमें सिर्फ़ डेटाबेस संसाधन के अपडेट शामिल हैं, न कि डेटाबेस में शामिल डेटा के.
`location_id`	`string` डेटाबेस की लोकेशन. जिन जगहों पर यह सुविधा उपलब्ध है उनकी सूची https://cloud.google.com/firestore/docs/locations पर दी गई है.
`type`	`DatabaseType` डेटाबेस का टाइप. चुनने का तरीका जानने के लिए, https://cloud.google.com/datastore/docs/firestore-or-datastore पर जाएं.
`concurrency_mode`	`ConcurrencyMode` इस डेटाबेस के लिए, एक साथ काम करने वाला कंट्रोल मोड का इस्तेमाल किया जाता है.
`version_retention_period`	`Duration` सिर्फ़ आउटपुट के लिए. वह अवधि जिसके दौरान डेटा के पिछले वर्शन, डेटाबेस में बनाए रखे जाते हैं. इस विंडो में कोई भी `read` या `query` `read_time` के बारे में बता सकता है और उस समय डेटाबेस की स्थिति की जानकारी देगा. अगर पीआईटीआर की सुविधा चालू है, तो डेटा के रखरखाव की समयसीमा सात दिनों की होती है. अगर ऐसा नहीं है, तो डेटा का रखरखाव एक घंटे तक किया जाएगा.
`earliest_version_time`	`Timestamp` सिर्फ़ आउटपुट के लिए. वह शुरुआती टाइमस्टैंप जब डेटा के पुराने वर्शन को डेटाबेस से पढ़ा जा सकता है. ऊपर [version_retention_period] देखें. इस फ़ील्ड में `now - version_retention_period` जानकारी अपने-आप भर जाती है. यह वैल्यू लगातार अपडेट होती रहती है और क्वेरी करते ही पुरानी हो जाती है. अगर डेटा को वापस पाने के लिए इस वैल्यू का इस्तेमाल किया जा रहा है, तो वैल्यू के लिए क्वेरी किए जाने के समय से लेकर डेटा वापस पाने की प्रक्रिया शुरू होने तक का समय ध्यान में रखें.
`point_in_time_recovery_enablement`	`PointInTimeRecoveryEnablement` इस डेटाबेस पर PITR की सुविधा चालू करनी है या नहीं.
`app_engine_integration_mode`	`AppEngineIntegrationMode` इस डेटाबेस के लिए App Engine इंटिग्रेशन मोड.
`key_prefix`	`string` सिर्फ़ आउटपुट के लिए. इस डेटाबेस के लिए key_prefix. इस key_prefix का इस्तेमाल प्रोजेक्ट आईडी ("~") के साथ किया जाता है. यह एक ऐसा ऐप्लिकेशन आईडी बनाता है जो Google App Engine की पहली पीढ़ी के रनटाइम में Cloud Datastore API से मिलता है. इस मामले में, यह वैल्यू खाली हो सकती है. इस स्थिति में, यूआरएल-एन्कोडेड कुंजी के लिए इस्तेमाल किया जाने वाला appid, project_id है. उदाहरण के लिए, v~foo के बजाय foo.
`delete_protection_state`	`DeleteProtectionState` डेटाबेस के लिए डेटा मिटाने से जुड़ी सुरक्षा की स्थिति.
`cmek_config`	`CmekConfig` ज़रूरी नहीं. मौजूदगी से पता चलता है कि इस डेटाबेस के लिए सीएमईके चालू है.
`etag`	`string` इस चेकसम का हिसाब, अन्य फ़ील्ड की वैल्यू के आधार पर सर्वर करता है. इसे अपडेट करने और मिटाने के अनुरोध पर भेजा जा सकता है. इससे यह पक्का होता है कि आगे बढ़ने से पहले, क्लाइंट के पास अप-टू-डेट वैल्यू है.

App घटनाओं के नमूने के तौर पर,

App Engine इंटिग्रेशन मोड का टाइप.

एनम्स

APP_ENGINE_INTEGRATION_MODE_UNSPECIFIED इस्तेमाल नहीं किया गया.

ENABLED अगर App Engine का ऐप्लिकेशन उसी क्षेत्र में है जिसमें यह डेटाबेस है, तो App Engine कॉन्फ़िगरेशन इस डेटाबेस पर असर डालेगा. इसमें ऐप्लिकेशन और डेटाबेस को बंद करने के साथ-साथ, डेटाबेस में लिखने की सुविधा को बंद करना भी शामिल है.

एनम्स
`APP_ENGINE_INTEGRATION_MODE_UNSPECIFIED`	इस्तेमाल नहीं किया गया.
`ENABLED`	अगर App Engine का ऐप्लिकेशन उसी क्षेत्र में है जिसमें यह डेटाबेस है, तो App Engine कॉन्फ़िगरेशन इस डेटाबेस पर असर डालेगा. इसमें ऐप्लिकेशन और डेटाबेस को बंद करने के साथ-साथ, डेटाबेस में लिखने की सुविधा को बंद करना भी शामिल है.
`DISABLED`	अनुरोध को पूरा करने के लिए, इस डेटाबेस की क्षमता पर App Engine का कोई असर नहीं पड़ता. यह Firestore API की मदद से बनाए गए डेटाबेस के लिए डिफ़ॉल्ट सेटिंग है.

DISABLED

अनुरोध को पूरा करने के लिए, इस डेटाबेस की क्षमता पर App Engine का कोई असर नहीं पड़ता.

यह Firestore API की मदद से बनाए गए डेटाबेस के लिए डिफ़ॉल्ट सेटिंग है.

CmekConfig

Firestore डेटाबेस के लिए CMEK (ग्राहक की ओर से मैनेज की जाने वाली एन्क्रिप्ट (सुरक्षित) करने की कुंजी) कॉन्फ़िगरेशन. अगर यह मौजूद नहीं है, तो डेटाबेस को डिफ़ॉल्ट Google एन्क्रिप्शन कुंजी से सुरक्षित किया जाता है.

फ़ील्ड

फ़ील्ड
`kms_key_name`	`string` ज़रूरी है. डेटा एन्क्रिप्ट (सुरक्षित) करने के लिए, सिर्फ़ उन कुंजियों का इस्तेमाल किया जा सकता है जो इस डेटाबेस की जगह पर हैं. Firestore के नाम5 एक से ज़्यादा इलाके के लिए, यह हमें क्लाउड केएमएस (एक से ज़्यादा इलाकों वाले) के हिसाब से तय करता है. Firestore के यूरो3 वाले कई इलाकों के लिए, यह क्लाउड केएमएस मल्टी-रीजनल यूरोप के बराबर है. https://cloud.google.com/kms/docs/locations पर जाएं. सही फ़ॉर्मैट `projects/{project_id}/locations/{kms_location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}` है.
`active_key_version[]`	`string` सिर्फ़ आउटपुट के लिए. फ़िलहाल, KMS के मुख्य वर्शन इस्तेमाल किए जा रहे हैं. डेटा सुरक्षित करने वाली कुंजी का नया वर्शन बनाने के दौरान, इस्तेमाल किए जाने वाले कई कुंजी वर्शन हो सकते हैं. सही फ़ॉर्मैट `projects/{project_id}/locations/{kms_location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{key_version}` है.

kms_key_name

string

ज़रूरी है. डेटा एन्क्रिप्ट (सुरक्षित) करने के लिए, सिर्फ़ उन कुंजियों का इस्तेमाल किया जा सकता है जो इस डेटाबेस की जगह पर हैं.

Firestore के नाम5 एक से ज़्यादा इलाके के लिए, यह हमें क्लाउड केएमएस (एक से ज़्यादा इलाकों वाले) के हिसाब से तय करता है. Firestore के यूरो3 वाले कई इलाकों के लिए, यह क्लाउड केएमएस मल्टी-रीजनल यूरोप के बराबर है. https://cloud.google.com/kms/docs/locations पर जाएं.

सही फ़ॉर्मैट projects/{project_id}/locations/{kms_location}/keyRings/{key_ring}/cryptoKeys/{crypto_key} है.

active_key_version[]

string

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

सही फ़ॉर्मैट projects/{project_id}/locations/{kms_location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{key_version} है.

ConcurrencyMode

लेन-देन के लिए, एक साथ कई काम करने के कंट्रोल मोड का टाइप.

एनम्स
`CONCURRENCY_MODE_UNSPECIFIED`	इस्तेमाल नहीं किया गया.
`OPTIMISTIC`	डिफ़ॉल्ट रूप से, आशावादी एक साथ कई काम करने के तरीके को कंट्रोल करने वाली सुविधा का इस्तेमाल करें. यह मोड, Cloud Firestore डेटाबेस के लिए उपलब्ध है.
`PESSIMISTIC`	डिफ़ॉल्ट रूप से, निराशावादी कॉन्करंसी कंट्रोल का इस्तेमाल करें. यह मोड, Cloud Firestore डेटाबेस के लिए उपलब्ध है. यह Cloud Firestore के लिए डिफ़ॉल्ट सेटिंग है.
`OPTIMISTIC_WITH_ENTITY_GROUPS`	डिफ़ॉल्ट रूप से, इकाई ग्रुप के साथ ऑप्टिमिस्टिक कंकरंसी कंट्रोल का इस्तेमाल करें. Cloud Datastore के लिए सिर्फ़ यही मोड उपलब्ध है. यह मोड, डेटास्टोर मोड वाले Cloud Firestore के लिए भी उपलब्ध है. हालांकि, इसका सुझाव नहीं दिया जाता.

डेटाबेस प्रकार

डेटाबेस का टाइप. चुनने का तरीका जानने के लिए, https://cloud.google.com/datastore/docs/firestore-or-datastore पर जाएं.

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

एनम्स
`DATABASE_TYPE_UNSPECIFIED`	डिफ़ॉल्ट वैल्यू. इस वैल्यू का इस्तेमाल तब किया जाता है, जब डेटाबेस का टाइप शामिल नहीं किया जाता है.
`FIRESTORE_NATIVE`	Firestore नेटिव मोड
`DATASTORE_MODE`	डेटास्टोर मोड में Firestore.

DeleteProtectionState

डेटाबेस की सुरक्षा को मिटाने की स्थिति.

एनम्स
`DELETE_PROTECTION_STATE_UNSPECIFIED`	डिफ़ॉल्ट वैल्यू. सुरक्षा के किस टाइप को मिटाया जाएगा, इसकी जानकारी नहीं दी गई
`DELETE_PROTECTION_DISABLED`	सुरक्षा मिटाने की सुविधा बंद है
`DELETE_PROTECTION_ENABLED`	सुरक्षा मिटाने की सुविधा चालू है

PointInTimeRecoveryEnabledment

पॉइंट इन टाइम रिकवरी की सुविधा को चालू करना.

एनम्स

POINT_IN_TIME_RECOVERY_ENABLEMENT_UNSPECIFIED इस्तेमाल नहीं किया गया.

एनम्स
`POINT_IN_TIME_RECOVERY_ENABLEMENT_UNSPECIFIED`	इस्तेमाल नहीं किया गया.
`POINT_IN_TIME_RECOVERY_ENABLED`	पिछले सात दिनों के डेटा के चुनिंदा वर्शन पर रीड की सुविधा काम करती है: पिछले घंटे के किसी भी टाइमस्टैंप के हिसाब से पढ़ता है एक घंटे के स्नैपशॉट के आधार पर, एक घंटे के अंदर और सात दिन में पढ़ता है कौनसे वर्शन काम करते हैं, यह तय करने के लिए `version_retention_period` और `earliest_version_time` का इस्तेमाल किया जा सकता है.
`POINT_IN_TIME_RECOVERY_DISABLED`	पिछले एक घंटे के डेटा के किसी भी वर्शन पर रीड की सुविधा मौजूद है.

POINT_IN_TIME_RECOVERY_ENABLED

पिछले सात दिनों के डेटा के चुनिंदा वर्शन पर रीड की सुविधा काम करती है:

पिछले घंटे के किसी भी टाइमस्टैंप के हिसाब से पढ़ता है
एक घंटे के स्नैपशॉट के आधार पर, एक घंटे के अंदर और सात दिन में पढ़ता है

कौनसे वर्शन काम करते हैं, यह तय करने के लिए version_retention_period और earliest_version_time का इस्तेमाल किया जा सकता है.

POINT_IN_TIME_RECOVERY_DISABLED पिछले एक घंटे के डेटा के किसी भी वर्शन पर रीड की सुविधा मौजूद है.

हटाएंबैकअप का अनुरोध

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

फ़ील्ड

फ़ील्ड
`name`	`string` ज़रूरी है. मिटाने के लिए बैकअप का नाम. फ़ॉर्मैट `projects/{project}/locations/{location}/backups/{backup}` है.

name

string

ज़रूरी है. मिटाने के लिए बैकअप का नाम.

फ़ॉर्मैट projects/{project}/locations/{location}/backups/{backup} है.

हटाएंबैकअप शेड्यूल अनुरोध

[FirestoreAdmin.DeleteBackupSchedules][] के लिए अनुरोध.

फ़ील्ड

फ़ील्ड
`name`	`string` ज़रूरी है. बैकअप शेड्यूल का नाम. `projects/{project}/databases/{database}/backupSchedules/{backup_schedule}` फ़ॉर्मैट करें

name

string

ज़रूरी है. बैकअप शेड्यूल का नाम.

projects/{project}/databases/{database}/backupSchedules/{backup_schedule} फ़ॉर्मैट करें

डेटा बेस मेटाडेटा मिटाएं

इस टाइप के लिए कोई फ़ील्ड नहीं है.

डेटाबेस मिटाने की कार्रवाई से जुड़ा मेटाडेटा.

DeleteDatabaseRequest

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

फ़ील्ड

फ़ील्ड
`name`	`string` ज़रूरी है. `projects/{project_id}/databases/{database_id}` फ़ॉर्म का नाम
`etag`	`string` डेटाबेस का मौजूदा ईटैग. अगर कोई ईटैग दिया गया है और वह डेटाबेस के मौजूदा ईटैग से मेल नहीं खाता है, तो डेटा मिटाने पर रोक लगा दी जाएगी और FAILED_PREcondition की गड़बड़ी दिखेगी.

name

string

ज़रूरी है. projects/{project_id}/databases/{database_id} फ़ॉर्म का नाम

etag

string

डेटाबेस का मौजूदा ईटैग. अगर कोई ईटैग दिया गया है और वह डेटाबेस के मौजूदा ईटैग से मेल नहीं खाता है, तो डेटा मिटाने पर रोक लगा दी जाएगी और FAILED_PREcondition की गड़बड़ी दिखेगी.

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

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` दस्तावेज़ों को कहां एक्सपोर्ट किया जा रहा है.
`namespace_ids[]`	`string` कौनसे नेमस्पेस आईडी एक्सपोर्ट किए जा रहे हैं.
`snapshot_time`	`Timestamp` एक्सपोर्ट किए जा रहे डेटाबेस के वर्शन से जुड़ा टाइमस्टैंप. अगर इसकी जानकारी नहीं दी गई है, तो एक्सपोर्ट किए जा रहे दस्तावेज़ों के सही होने की कोई गारंटी नहीं होती.

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. अगर यूआरआई एक बकेट (बिना नेमस्पेस पाथ के) है, तो शुरुआत के समय के आधार पर प्रीफ़िक्स जनरेट किया जाएगा.
`namespace_ids[]`	`string` एक खाली सूची सभी नेमस्पेस को दिखाती है. यह उन डेटाबेस के लिए इस्तेमाल करने का पसंदीदा तरीका है जो नेमस्पेस का इस्तेमाल नहीं करते. खाली स्ट्रिंग एलिमेंट से डिफ़ॉल्ट नेमस्पेस दिखाया जाता है. इसका इस्तेमाल तब किया जाना चाहिए, जब डेटाबेस में डेटा, नॉन-डिफ़ॉल्ट नेमस्पेस में है, लेकिन उसे शामिल नहीं करना है. इस सूची में हर नेमस्पेस यूनीक होना चाहिए.
`snapshot_time`	`Timestamp` एक्सपोर्ट किए जाने वाले डेटाबेस के वर्शन से जुड़ा टाइमस्टैंप. टाइमस्टैंप अतीत में होना चाहिए, मिनट के हिसाब से पूर्णांक होना चाहिए और `earliestVersionTime` से पहले का नहीं होना चाहिए. अगर इसके बारे में बताया गया है, तो एक्सपोर्ट किए गए दस्तावेज़ में, दिए गए समय पर डेटाबेस का एक जैसा व्यू दिखेगा. ऐसा न होने पर, एक्सपोर्ट किए गए दस्तावेज़ों के मेल खाने की कोई गारंटी नहीं है.

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` के बताए गए कॉन्फ़िगरेशन का इस्तेमाल किया जाएगा. अगर आपको इस फ़ील्ड के लिए सभी इंडेक्स को साफ़ तौर पर हटाना है, तो इंडेक्स की खाली सूची के साथ इंडेक्स कॉन्फ़िगरेशन की जानकारी दें.
`ttl_config`	`TtlConfig` इस `Field` के लिए TTL कॉन्फ़िगरेशन. इसे सेट करने या सेट करने से, उन दस्तावेज़ों के लिए TTL चालू या बंद हो जाएगा जिनमें यह `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 के बताए गए कॉन्फ़िगरेशन का इस्तेमाल किया जाएगा. अगर आपको इस फ़ील्ड के लिए सभी इंडेक्स को साफ़ तौर पर हटाना है, तो इंडेक्स की खाली सूची के साथ इंडेक्स कॉन्फ़िगरेशन की जानकारी दें.

ttl_config

TtlConfig

इस Field के लिए TTL कॉन्फ़िगरेशन. इसे सेट करने या सेट करने से, उन दस्तावेज़ों के लिए TTL चालू या बंद हो जाएगा जिनमें यह 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` होगा.

TtlConfig

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

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

फ़ील्ड

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

state

State

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

राज्य

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

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

फ़ील्डऑपरेशन मेटाडेटा

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` कार्रवाई की स्थिति.
`progress_documents`	`Progress` दस्तावेज़ों में इस कार्रवाई की प्रोग्रेस.
`progress_bytes`	`Progress` इस कार्रवाई की प्रोग्रेस, बाइट में.
`ttl_config_delta`	`TtlConfigDelta` TTL कॉन्फ़िगरेशन के डेल्टा के बारे में बताता है.

IndexConfigDelta

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

फ़ील्ड

change_type

ChangeType

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

index

Index

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

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

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

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

TtlConfigDelta

TTL (टीटीएल) कॉन्फ़िगरेशन में हुए बदलाव के बारे में जानकारी.

फ़ील्ड

change_type

ChangeType

इससे पता चलता है कि TTL (टीटीएल) कॉन्फ़िगरेशन कैसे बदल रहा है.

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

इससे पता चलता है कि TTL कॉन्फ़िगरेशन कैसे बदल रहा है.

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

बैकअप पाने के लिए अनुरोध

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

फ़ील्ड

name

string

ज़रूरी है. फ़ेच किए जाने वाले बैकअप का नाम.

फ़ॉर्मैट projects/{project}/locations/{location}/backups/{backup} है.

बैकअप शेड्यूल अनुरोध

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

फ़ील्ड

name

string

ज़रूरी है. बैकअप शेड्यूल का नाम.

projects/{project}/databases/{database}/backupSchedules/{backup_schedule} फ़ॉर्मैट करें

GetDatabaseRequest

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

फ़ील्ड

name

string

ज़रूरी है. projects/{project_id}/databases/{database_id} फ़ॉर्म का नाम

अनुरोध फ़ील्ड पाएं

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

फ़ील्ड

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

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

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` इंपोर्ट किए जा रहे दस्तावेज़ों की जगह.
`namespace_ids[]`	`string` कौनसे नेमस्पेस आईडी इंपोर्ट किए जा रहे हैं.

ExportDocumentsRequest

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

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

इंडेक्स

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

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

Apiस्कोप

एपीआई स्कोप उन एपीआई के बारे में बताता है जो क्वेरी के लिए काम करते हैं. ये एपीआई (डेटास्टोर मोड में Firestore नेटिव या Firestore) हैं.

एनम्स
`ANY_API`	इंडेक्स का इस्तेमाल सिर्फ़ Firestore नेटिव क्वेरी एपीआई की मदद से किया जा सकता है. यह डिफ़ॉल्ट विकल्प है.
`DATASTORE_MODE_API`	इंडेक्स का इस्तेमाल, Datastore Mode क्वेरी एपीआई में सिर्फ़ Firestore के ज़रिए किया जा सकता है.

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

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

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

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

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

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

क्रम

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

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

वेक्टर कॉन्फ़िगरेशन

वेक्टर सर्च ऑपरेशंस की सुविधा देने के लिए इंडेक्स कॉन्फ़िगरेशन

फ़ील्ड

dimension

int32

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

मिलने वाले इंडेक्स में सिर्फ़ इस डाइमेंशन के वेक्टर शामिल होंगे और उसी डाइमेंशन वाले वेक्टर सर्च के लिए उनका इस्तेमाल किया जा सकता है.

यूनियन फ़ील्ड type. इस्तेमाल किए गए इंडेक्स का टाइप. type इनमें से सिर्फ़ एक हो सकती है:

flat

FlatIndex

यह बताता है कि वेक्टर इंडेक्स एक फ़्लैट इंडेक्स है.

फ़्लैट इंडेक्स

इस टाइप के लिए कोई फ़ील्ड नहीं है.

ऐसा इंडेक्स जो वेक्टर को फ़्लैट डेटा स्ट्रक्चर में सेव करता है और पूरी जानकारी खोजने की सुविधा देता है.

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

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

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

राज्य

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

एनम्स
`STATE_UNSPECIFIED`	राज्य की जानकारी नहीं दी गई है.
`CREATING`	इंडेक्स बनाया जा रहा है. इंडेक्स के लिए एक लंबे समय तक चलने वाली कार्रवाई चल रही है. दस्तावेज़ लिखते समय इंडेक्स को अपडेट किया जाता है. कुछ इंडेक्स डेटा मौजूद हो सकता है.
`READY`	इंडेक्स इस्तेमाल के लिए तैयार है. दस्तावेज़ लिखते समय इंडेक्स को अपडेट किया जाता है. इंडेक्स, सेव किए गए उन सभी दस्तावेज़ों से पूरी तरह भर जाता है जिन पर यह लागू होता है.
`NEEDS_REPAIR`	इंडेक्स बनाया जा रहा था, लेकिन कोई गड़बड़ी हुई. इंडेक्स के लिए, लंबे समय तक चलने वाली कोई कार्रवाई नहीं है और सबसे हाल ही में पूरी हुई कार्रवाई पूरी नहीं हुई. दस्तावेज़ लिखते समय इंडेक्स को अपडेट नहीं किया जाता. कुछ इंडेक्स डेटा मौजूद हो सकता है. google.longrunning.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` इस कार्रवाई की प्रोग्रेस, बाइट में.

Listबैकअप शेड्यूल्स अनुरोध

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

फ़ील्ड

parent

string

ज़रूरी है. पैरंट डेटाबेस.

फ़ॉर्मैट projects/{project}/databases/{database} है.

ListBACKUPSchedulesResponse

FirestoreAdmin.ListBackupSchedules के लिए रिस्पॉन्स.

फ़ील्ड

backup_schedules[]

BackupSchedule

बैकअप के सभी शेड्यूल की सूची.

Listबैकअप अनुरोध

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

फ़ील्ड

parent

string

ज़रूरी है. वह जगह जहां से बैकअप लेना है.

फ़ॉर्मैट projects/{project}/locations/{location} है. दिए गए प्रोजेक्ट के लिए, सभी जगहों के बैकअप की सूची बनाने के लिए, {location} = '-' का इस्तेमाल करें. इससे किसी एक जगह या सभी जगहों से स्टोर पेज का बैकअप लिया जा सकता है.

ListBACKUPsResponse

FirestoreAdmin.ListBackups के लिए रिस्पॉन्स.

फ़ील्ड

backups[]

Backup

प्रोजेक्ट के लिए सभी बैकअप की सूची.

unreachable[]

string

उन जगहों की सूची जहां से मौजूदा बैकअप फ़ेच नहीं किए जा सके.

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

ListDatabasesRequest

किसी प्रोजेक्ट के लिए, सभी जगहों के Firestore डेटाबेस की सूची बनाने का अनुरोध.

फ़ील्ड

parent

string

ज़रूरी है. projects/{project_id} फ़ॉर्म के पैरंट का नाम

ListDatabasesResponse

किसी प्रोजेक्ट के लिए डेटाबेस की सूची.

फ़ील्ड

databases[]

Database

प्रोजेक्ट में मौजूद डेटाबेस.

unreachable[]

string

अगर अलग-अलग डेटाबेस का डेटा सूची में नहीं जोड़ा जा सकता, तो उसे यहां रिकॉर्ड किया जाएगा.

एंट्री का एक उदाहरण यह हो सकता है: प्रोजेक्ट/some_project/locations/some_location. ऐसा तब हो सकता है, जब डेटाबेस मौजूद क्लाउड रीजन फ़िलहाल उपलब्ध न हो. इस मामले में, हम डेटाबेस की पूरी जानकारी नहीं हासिल कर सकते. आपको संसाधन के लिए 'पाएं' अनुरोध या खास जगह के लिए 'सूची' अनुरोध भेजकर, गड़बड़ी के बारे में ज़्यादा जानकारी वाला मैसेज (या संसाधन को फ़ेच किया जा सकता है) मिल सकता है.

ListFieldsRequest

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

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

ListFieldsResponse

FirestoreAdmin.ListFields के लिए रिस्पॉन्स.

फ़ील्ड

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

जगह की जानकारी का मेटाडेटा

इस टाइप के लिए कोई फ़ील्ड नहीं है.

google.cloud.location.Location.metadata के लिए मेटाडेटा मैसेज.

कार्रवाई की स्थिति

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

एनम्स
`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

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

डेटाबेस मेटाडेटा को पहले जैसा करें

[InsertDatabase][google.firestore.admin.v1.इसेरॉ डेटाबेस] अनुरोध से, long-running operation के लिए मेटाडेटा.

फ़ील्ड
`start_time`	`Timestamp` डेटा वापस लाने की प्रोसेस शुरू होने का समय.
`end_time`	`Timestamp` डेटा वापस लाने की प्रोसेस पूरी होने का समय, पहले से मौजूद डेटा को वापस लाने के लिए इसे सेट नहीं किया गया है.
`operation_state`	`OperationState` वापस लाने की कार्रवाई की स्थिति.
`database`	`string` डेटाबेस का नाम जिसे वापस लाया जा रहा है.
`backup`	`string` जिस बैकअप से डेटा वापस लाया जा रहा है उसका नाम.
`progress_percentage`	`Progress` डेटा को वापस लाने में लगे समय का अनुमान, बचे हुए समय के अनुमानित प्रतिशत के तौर पर लगाया जाता है.

DatabaseRequest को वापस लाएं

[FirestoreAdmin.RecoveryDatabase][google.firestore.admin.v1.RecoveryDatabase] के लिए अनुरोध मैसेज.

फ़ील्ड
`parent`	`string` ज़रूरी है. वह प्रोजेक्ट जिसमें डेटाबेस को वापस लाना है. फ़ॉर्मैट `projects/{project_id}` है.
`database_id`	`string` ज़रूरी है. डेटाबेस के लिए इस्तेमाल किया जाने वाला आईडी, जो डेटाबेस के संसाधन नाम का फ़ाइनल कॉम्पोनेंट बन जाएगा. यह डेटाबेस आईडी, किसी मौजूदा डेटाबेस से नहीं जुड़ा होना चाहिए. यह वैल्यू 4 से 63 वर्णों की होनी चाहिए. मान्य वर्ण /[a-z][0-9]-/ होते हैं, जिनमें पहला वर्ण एक अक्षर और आखिरी में कोई अक्षर या संख्या होती है. UUID-जैसा /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/ नहीं होना चाहिए. "(डिफ़ॉल्ट)" डेटाबेस आईडी भी मान्य है.
यूनियन फ़ील्ड `source`. `source` इनमें से सिर्फ़ एक हो सकती है:
`backup`	`string` बैकअप लिया जा सकता है. उसी प्रोजेक्ट से होना चाहिए जिससे माता-पिता वाला प्रोजेक्ट जुड़ा है. फ़ॉर्मैट है: `projects/{project_id}/locations/{location}/backups/{backup}`

अपडेटबैकअप शेड्यूल अनुरोध

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

फ़ील्ड

backup_schedule

BackupSchedule

ज़रूरी है. अपडेट करने के लिए बैकअप शेड्यूल.

update_mask

FieldMask

अपडेट किए जाने वाले फ़ील्ड की सूची.

अपडेटडेटाबेस मेटाडेटा

इस टाइप के लिए कोई फ़ील्ड नहीं है.

डेटाबेस को अपडेट करने की कार्रवाई से जुड़ा मेटाडेटा.

UpdateDatabaseRequest

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

फ़ील्ड

database

Database

ज़रूरी है. अपडेट किया जाने वाला डेटाबेस.

update_mask

FieldMask

अपडेट किए जाने वाले फ़ील्ड की सूची.

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

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

फ़ील्ड

field

Field

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

update_mask

FieldMask

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

हर हफ़्ते होने वाला दोहराव

हफ़्ते के किसी खास दिन पर बार-बार लागू होने वाला शेड्यूल दिखाता है.

समय क्षेत्र UTC है.

फ़ील्ड

day

DayOfWeek

दौड़ने के लिए हफ़्ते का दिन.

DAY_OF_WEEK_UNSPECIFIED की अनुमति नहीं है.