Package google.firestore.admin.v1

इंडेक्स

Firestoreएडमिन

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

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

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

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

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

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

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

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

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

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

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 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 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 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 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 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 GetIndex(GetIndexRequest) returns (Index)

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

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

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

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

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

rpc ImportDocuments(ImportDocumentsRequest) returns (Operation)

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

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

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

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

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

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

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

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

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

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

rpc ListIndexes(ListIndexesRequest) returns (ListIndexesResponse)

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

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

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

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

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

rpc 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 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

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

बैकअप

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

बैकअप को बनाने के समय की तुलना में, आने वाले समय में कितने समय तक बैकअप लिया जाएगा, उदाहरण के लिए सात दिनों तक बैकअप रखें.

ज़्यादा से ज़्यादा 14 हफ़्ते के लिए डेटा के रखरखाव का समय सेट किया जा सकता है.
यूनियन फ़ील्ड recurrence. बैकअप लेने का समय दिखाने के लिए एक फ़ील्ड. recurrence इनमें से सिर्फ़ एक हो सकता है:
daily_recurrence

DailyRecurrence

हर दिन चलने वाले शेड्यूल के लिए.
weekly_recurrence

WeeklyRecurrence

हर हफ़्ते किसी खास दिन पर चलने वाले शेड्यूल के लिए.

CreateBackupScheduleRequest

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

फ़ील्ड
parent

string

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

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

BackupSchedule

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

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

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

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

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}/ नहीं होना चाहिए.

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

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

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

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

क्या इस डेटाबेस पर पीआईटीआर सुविधा को चालू करना है.
app_engine_integration_mode

AppEngineIntegrationMode

इस डेटाबेस के लिए इस्तेमाल किया जाने वाला App Engine इंटिग्रेशन मोड.
key_prefix

string

सिर्फ़ आउटपुट के लिए. इस डेटाबेस के लिए key_prefix. प्रोजेक्ट आईडी ("~") के साथ इस key_prefix का इस्तेमाल करके, ऐप्लिकेशन आईडी बनाया जाता है. यह ऐप्लिकेशन आईडी, Google App Engine के फ़र्स्ट जनरेशन रनटाइम में Cloud Datastore एपीआई से दिखाया जाता है.

यह वैल्यू खाली हो सकती है. इस स्थिति में, यूआरएल के कोड में बदली गई कुंजियों के लिए इस्तेमाल किया जाने वाला appid, project_id है (उदाहरण: v~foo के बजाय foo).
delete_protection_state

DeleteProtectionState

डेटाबेस के लिए, मिटाने से जुड़ी सुरक्षा की स्थिति.
cmek_config

CmekConfig

ज़रूरी नहीं. मौजूदगी से पता चलता है कि सीएमईके इस डेटाबेस के लिए चालू है.
previous_id

string

सिर्फ़ आउटपुट के लिए. डेटाबेस संसाधन का पिछला डेटाबेस आईडी. यह फ़ील्ड सिर्फ़ मिटाए गए डेटाबेस के लिए भरा जाता है.
etag

string

इस चेकसम की गणना सर्वर के ज़रिए अन्य फ़ील्ड की वैल्यू के आधार पर की जाती है और इसे अपडेट करने और मिटाने के अनुरोध भेजे जा सकते हैं, ताकि यह पक्का किया जा सके कि आगे बढ़ने से पहले क्लाइंट के पास अप-टू-डेट वैल्यू है.

AppEngineइंटिग्रेशन मोड

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

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

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

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

CmekConfig

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

फ़ील्ड
kms_key_name

string

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

Firestore के nam5 एक से ज़्यादा क्षेत्र के लिए, यह अमेरिका के क्लाउड केएमएस मल्टी-क्षेत्र है. Firestore के eur3 मल्टी-रीजन के लिए, यह यूरोप के क्लाउड केएमएस (कई क्षेत्रों वाला इलाका) से मेल खाता है. 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} है.

कॉनcurrencyमोड

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

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

डिफ़ॉल्ट रूप से, एक साथ काम न करने वाले कंट्रोल का इस्तेमाल करें. यह मोड, Cloud Firestore डेटाबेस के लिए उपलब्ध है.

यह Cloud Firestore के लिए डिफ़ॉल्ट सेटिंग है.
OPTIMISTIC_WITH_ENTITY_GROUPS

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

Cloud Datastore के लिए सिर्फ़ यही मोड उपलब्ध है.

यह मोड 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 सुरक्षा मिटाने की सुविधा चालू है

PointInTimeRecoveryEnabled

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

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

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

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

version_retention_period और earliest_version_time का इस्तेमाल करके, किन वर्शन का इस्तेमाल किया जा सकता है.
POINT_IN_TIME_RECOVERY_DISABLED पिछले एक घंटे के डेटा के किसी भी वर्शन के लिए रीड की सुविधा काम करती है.

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

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

फ़ील्ड
name

string

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

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

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

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

फ़ील्ड
name

string

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

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

Database मेटाडेटा मिटाएं

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

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

मिटाएँडेटाबेस अनुरोध

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

फ़ील्ड
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}

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

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

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

ExportDocumentsअनुरोध

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

फ़ील्ड
name

string

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

string

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

string

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

string

एक खाली सूची सभी नेमस्पेस को दिखाती है. यह उन डेटाबेस के लिए पसंदीदा इस्तेमाल है जो नेमस्पेस का इस्तेमाल नहीं करते.

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

Timestamp

एक्सपोर्ट किए जाने वाले डेटाबेस के वर्शन से जुड़ा टाइमस्टैंप. टाइमस्टैंप, पिछली तारीख का होना चाहिए. इसे मिनट में बदल दिया जाना चाहिए और earliestVersionTime से पहले का नहीं होना चाहिए. अगर इसके लिए तय किया गया है, तो एक्सपोर्ट किए गए दस्तावेज़ों में दिए गए समय पर, डेटाबेस का व्यू एक जैसा होगा. ऐसा न होने पर, एक्सपोर्ट किए गए दस्तावेज़ों के मेल खाने की कोई गारंटी नहीं है.

ExportDocumentsResponse

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

फ़ील्ड
output_uri_prefix

string

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

फ़ील्ड

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

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

फ़ील्ड
name

string

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

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

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

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

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

IndexConfig

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

राज्य

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

एनम्स
STATE_UNSPECIFIED स्थिति की जानकारी नहीं है या इसकी जानकारी नहीं है.
CREATING TTL लागू किया जा रहा है. बदलाव को ट्रैक करने के लिए, लंबे समय से चल रही कार्रवाई चालू है. लिखे गए नए दस्तावेज़ों में अनुरोध के मुताबिक TTL (टीटीएल) लागू किए जाएंगे. मौजूदा दस्तावेज़ों पर जिन TTLs का अनुरोध किया गया है उन्हें अब भी प्रोसेस किया जा रहा है. सभी मौजूदा दस्तावेज़ों के TTLs प्रोसेस हो जाने के बाद, स्थिति 'ACTIVE' हो जाएगी.
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 कॉन्फ़िगरेशन के डेल्टा के बारे में बताता है.

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

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

फ़ील्ड
change_type

ChangeType

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

Index

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

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

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

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

TtlConfigDelta

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

फ़ील्ड
change_type

ChangeType

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

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

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

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

GetBackupRequest

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

फ़ील्ड
name

string

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

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

GetBackupScheduleRequest

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

फ़ील्ड
name

string

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

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

'डेटाबेस अनुरोध पाएं'

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

कौनसे नेमस्पेस आईडी इंपोर्ट किए जा रहे हैं.

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

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

फ़ील्ड
name

string

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

string

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

string

एक्सपोर्ट की गई फ़ाइलों की जगह. यह किसी ऐसे एक्सपोर्ट में मौजूद ExportDocumentsResponse के आउटपुट_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

सिर्फ़ आउटपुट के लिए. इंडेक्स किए जाने की स्थिति.

एपीआई स्कोप

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

एनम्स
ANY_API इंडेक्स का इस्तेमाल सिर्फ़ Firestore नेटिव क्वेरी एपीआई से किया जा सकता है. यह डिफ़ॉल्ट विकल्प है.
DATASTORE_MODE_API इंडेक्स का इस्तेमाल सिर्फ़ Datastore मोड क्वेरी एपीआई में, 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.longदौड़.Operations API का इस्तेमाल करके पता लगाएं कि पिछली बार इस इंडेक्स को बनाने की कोशिश क्यों नहीं की गई थी. इसके बाद, इंडेक्स को फिर से बनाएं.

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

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

फ़ील्ड
start_time

Timestamp

यह कार्रवाई शुरू होने का समय.
end_time

Timestamp

इस कार्रवाई के पूरा होने का समय. अगर कार्रवाई अब भी जारी है, तो सेट नहीं की जाएगी.
index

string

वह इंडेक्स संसाधन जिस पर यह कार्रवाई की जा रही है. उदाहरण के लिए: projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}
state

OperationState

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

Progress

दस्तावेज़ों में इस कार्रवाई की प्रोग्रेस.
progress_bytes

Progress

इस कार्रवाई की प्रोग्रेस (बाइट में).

ListBackupSchedulesRequest

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

फ़ील्ड
parent

string

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

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

ListBackupSchedulesResponse

FirestoreAdmin.ListBackupSchedules का जवाब.

फ़ील्ड
backup_schedules[]

BackupSchedule

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

ListBackupsRequest

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

फ़ील्ड
parent

string

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

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

ListBackupsResponse

FirestoreAdmin.ListBackups का जवाब.

फ़ील्ड
backups[]

Backup

प्रोजेक्ट के सभी बैकअप की सूची.
unreachable[]

string

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

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

सूची डेटाबेस अनुरोध

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

फ़ील्ड
parent

string

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

bool

अगर सही है, तो मिटाए गए संसाधन भी दिखाता है.

ListDatabasesResponse

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

फ़ील्ड
databases[]

Database

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

string

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

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

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

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

फ़ील्ड
parent

string

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

string

सूची के नतीजों पर लागू करने के लिए फ़िल्टर. फ़िलहाल, FirestoreAdmin.ListFields सिर्फ़ उन लिस्टिंग फ़ील्ड के साथ काम करता है जिन्हें साफ़ तौर पर बदल दिया गया है. यह क्वेरी जारी करने के लिए, FirestoreAdmin.ListFields को ऐसे फ़िल्टर के साथ कॉल करें जिसमें indexConfig.usesAncestorConfig:false या ttlConfig:* शामिल हो.
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.longदौड़.Operations.CancelOperation को कॉल किया.
FINALIZING अनुरोध को प्रोसेस किया जा चुका है और यह आखिरी चरण में है.
SUCCESSFUL अनुरोध पूरा हो गया.
FAILED अनुरोध की प्रक्रिया पूरी हो चुकी है, लेकिन इसमें कोई गड़बड़ी हुई.
CANCELLED उपयोगकर्ता को google.longदौड़.Operations.CancelOperation नाम से कॉल करने के बाद अनुरोध को रद्द कर दिया गया.

प्रगति

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

फ़ील्ड
estimated_work

int64

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

int64

काम पूरा हुआ.

डेटा बेस मेटाडेटा को वापस लाएं

[ReturnDatabase][google.firestore.admin.v1.recoverDatabase] अनुरोध से मिला long-running operation का मेटाडेटा.

फ़ील्ड
start_time

Timestamp

डेटा वापस लाने की प्रोसेस शुरू होने का समय.
end_time

Timestamp

डेटा वापस लाने की प्रोसेस पूरी होने का समय, मौजूदा डेटा को पहले जैसा करने की सुविधा के लिए सेट नहीं किया गया.
operation_state

OperationState

डेटा वापस लाने की कार्रवाई की स्थिति.
database

string

डेटाबेस का नाम वापस लाया जा रहा है.
backup

string

उस बैकअप का नाम जिससे वापस लाया जा रहा है.
progress_percentage

Progress

बाकी बचे समय के अनुमानित प्रतिशत के हिसाब से, डेटा वापस लाने की प्रोसेस कितनी दूर है.

डेटा बेस को वापस लाने का अनुरोध

[FirestoreAdmin.चलते-फिरते डेटाबेस][google.firestore.admin.v1.replaceDatabase] के लिए अनुरोध का मैसेज.

फ़ील्ड
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

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

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

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

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

अपडेट डेटा बेस अनुरोध

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

फ़ील्ड
database

Database

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

FieldMask

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

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

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

फ़ील्ड
field

Field

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

FieldMask

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

साप्ताहिक दोहराव

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

टाइम ज़ोन UTC है.

फ़ील्ड
day

DayOfWeek

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

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