Package google.firestore.admin.v1beta1

इंडेक्स

Firestoreएडमिन

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

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

कॉन्सेप्ट

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

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

सेवाएं

इंडेक्स

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

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

मेटाडेटा

यह Cloud Firestore में मौजूद डेटा के बारे में मेटाडेटा और आंकड़ों की जानकारी देता है. ऐसा हो सकता है कि इस एपीआई के हिस्से के तौर पर दिया गया डेटा पुराना हो.

कार्रवाई

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

जो कार्रवाई अभी तक पूरी नहीं की गई है उसे रद्द किया जा सकता है. रद्द करने का अनुरोध एसिंक्रोनस होता है और रद्द करने का अनुरोध किए जाने के बाद कुछ समय तक कार्रवाई जारी रह सकती है.

किया गया ऑपरेशन मिटाया जा सकता है ताकि वह अब ऑपरेशन संग्रह के भाग के रूप में सूचीबद्ध न रहे.

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

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

rpc CreateIndex(CreateIndexRequest) returns (Operation)

तय किया गया इंडेक्स बनाता है. नए इंडेक्स की शुरुआती स्थिति CREATING है. लौटाए गए google.longrunning.Operation के पूरा होने पर, READY की स्थिति दिखेगी. अगर इंडेक्स पहले से मौजूद है, तो कॉल ALREADY_EXISTS वाली स्थिति दिखाएगा.

बनाए जाने के दौरान, इस प्रोसेस की वजह से कोई गड़बड़ी हो सकती है. इस स्थिति में, इंडेक्स ERROR की स्थिति में चला जाएगा. गड़बड़ी की वजह डेटा को ठीक करके, इंडेक्स को delete से हटाकर, फिर create की मदद से इंडेक्स बनाकर इस प्रोसेस को वापस पाया जा सकता है.

एक फ़ील्ड वाले इंडेक्स नहीं बनाए जा सकते.

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

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

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

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

rpc DeleteIndex(DeleteIndexRequest) returns (Empty)

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

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

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

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

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

rpc ExportDocuments(ExportDocumentsRequest) returns (Operation)

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

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

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

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

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

rpc GetIndex(GetIndexRequest) returns (Index)

इंडेक्स मिलता है.

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

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

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

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

rpc ImportDocuments(ImportDocumentsRequest) returns (Operation)

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

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

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

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

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

rpc ListIndexes(ListIndexesRequest) returns (ListIndexesResponse)

ऐसे इंडेक्स की सूची बनाता है जो तय फ़िल्टर से मेल खाते हैं.

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

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

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

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

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

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

फ़ील्ड
parent

string

उस डेटाबेस का नाम जिस पर यह इंडेक्स लागू होगा. उदाहरण के लिए: projects/{project_id}/databases/{database_id}
index

Index

वह इंडेक्स जिसे बनाना है. नाम और स्थिति वाले फ़ील्ड सिर्फ़ आउटपुट के लिए हैं. इन्हें अनदेखा कर दिया जाएगा. कुछ सिंगल फ़ील्ड इंडेक्स बनाए या मिटाए नहीं जा सकते.

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

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

फ़ील्ड
name

string

इंडेक्स का नाम. उदाहरण के लिए: projects/{project_id}/databases/{database_id}/indexes/{index_id}

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

ExportDocuments की कार्रवाइयों का मेटाडेटा.

फ़ील्ड
start_time

Timestamp

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

Timestamp

कार्रवाई के खत्म होने का समय, चाहे वह सफलतापूर्वक हो या किसी और वजह से. अगर कार्रवाई अब भी चालू है, तो इसे अनसेट करें.
operation_state

OperationState

एक्सपोर्ट की स्थिति.
progress_documents

Progress

प्रोसेस किए गए दस्तावेज़ों की संख्या का अनुमान.
progress_bytes

Progress

प्रोसेस किए गए बाइट की संख्या का अनुमान.
collection_ids[]

string

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

string

जहां इकाइयों को एक्सपोर्ट किया जा रहा है.

ExportDocumentsअनुरोध

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

फ़ील्ड
name

string

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

string

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

string

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

ExportDocumentsResponse

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

फ़ील्ड
output_uri_prefix

string

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

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

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

फ़ील्ड
name

string

इंडेक्स का नाम. उदाहरण के लिए: projects/{project_id}/databases/{database_id}/indexes/{index_id}

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

ImportDocuments की कार्रवाइयों का मेटाडेटा.

फ़ील्ड
start_time

Timestamp

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

Timestamp

कार्रवाई के खत्म होने का समय, चाहे वह सफलतापूर्वक हो या किसी और वजह से. अगर कार्रवाई अब भी चालू है, तो इसे अनसेट करें.
operation_state

OperationState

इंपोर्ट करने की स्थिति.
progress_documents

Progress

प्रोसेस किए गए दस्तावेज़ों की संख्या का अनुमान.
progress_bytes

Progress

प्रोसेस किए गए बाइट की संख्या का अनुमान.
collection_ids[]

string

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

string

इंपोर्ट किए जा रहे दस्तावेज़ों की जगह की जानकारी.

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

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

फ़ील्ड
name

string

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

string

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

string

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

इंडेक्स

इंडेक्स की परिभाषा.

फ़ील्ड
name

string

इंडेक्स के संसाधन का नाम. सिर्फ़ आउटपुट के लिए.
collection_id

string

वह कलेक्शन आईडी जिस पर यह इंडेक्स लागू होता है. ज़रूरी है.
fields[]

IndexField

इंडेक्स किए जाने वाले फ़ील्ड.
state

State

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

राज्य

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

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

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

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

फ़ील्ड
field_path

string

फ़ील्ड का पाथ. यह [google.firestore.v1beta1.Document.fields][fields] में बताई गई फ़ील्ड पाथ की खास बातों से मेल खाना चाहिए. खास फ़ील्ड पाथ __name__ का इस्तेमाल खुद या पाथ के आखिर में किया जा सकता है. __type__ का इस्तेमाल सिर्फ़ पाथ के आखिर में किया जा सकता है.
mode

Mode

फ़ील्ड का मोड.

मोड

मोड से यह तय होता है कि किसी फ़ील्ड को कैसे इंडेक्स किया जाता है.

एनम्स
MODE_UNSPECIFIED मोड की जानकारी नहीं है.
ASCENDING फ़ील्ड की वैल्यू को इंडेक्स किया जाता है, ताकि वे बढ़ते क्रम में काम कर सकें. साथ ही, <, >, <=, >=, और = के हिसाब से क्वेरी भी की जा सकती है.
DESCENDING फ़ील्ड की वैल्यू को इंडेक्स किया जाता है, ताकि क्रम को घटते क्रम में चलाया जा सके और <, >, <=, >=, और = के हिसाब से क्वेरी भी की जा सके.
ARRAY_CONTAINS फ़ील्ड की अरे वैल्यू को इंडेक्स किया जाता है, ताकि ARRAY_CONTAINS क्वेरी का इस्तेमाल करके सदस्यता ली जा सके.

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

इंडेक्स करने की कार्रवाइयों का मेटाडेटा. यह मेटाडेटा, google.longrunning.Operation के मेटाडेटा फ़ील्ड में अपने-आप जानकारी भरता है.

फ़ील्ड
start_time

Timestamp

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

Timestamp

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

string

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

OperationType

इंडेक्स करने की कार्रवाई किस तरह की है.
cancelled

bool

अगर google.longrunning.Operation रद्द कर दिया गया था, तो वैल्यू 'सही' होगी. अगर रद्द किया जा रहा है, तो रद्द किया गया मान सही होगा, लेकिन google.longrunning.Operation.done गलत होगा.
document_progress

Progress

मौजूदा ऑपरेशन की प्रोग्रेस, जिसे दस्तावेज़ों की संख्या में मापा जाता है.

ऑपरेशन टाइप

इंडेक्स करने की कार्रवाई किस तरह की है.

एनम्स
OPERATION_TYPE_UNSPECIFIED बताया नहीं गया है. सर्वर कभी भी सेट नहीं करता.
CREATING_INDEX इस कार्रवाई से इंडेक्स बनाया जा रहा है. CreateIndex कॉल से शुरू किया गया.

ListIndexesRequest

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

फ़ील्ड
parent

string

डेटाबेस का नाम. उदाहरण के लिए: projects/{project_id}/databases/{database_id}
filter

string
page_size

int32

सूची पेज का स्टैंडर्ड साइज़.
page_token

string

स्टैंडर्ड 'सूची' पेज टोकन.

ListIndexesResponse

FirestoreAdmin.ListIndexes का जवाब.

फ़ील्ड
indexes[]

Index

इंडेक्स.
next_page_token

string

'अगले पेज की सूची' का स्टैंडर्ड टोकन.

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

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

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

ऑपरेशन स्टेट

चल रहे ऑपरेशन के लिए अलग-अलग संभावित स्थितियां.

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

प्रगति

किसी खास मेट्रिक की प्रोग्रेस को मेज़र करता है.

फ़ील्ड
work_completed

int64

इस बात का अनुमान कि कितना काम पूरा हो चुका है. ध्यान दें कि यह work_estimated से ज़्यादा हो सकता है.
work_estimated

int64

इस बात का अनुमान कि कितना काम करने की ज़रूरत है. काम का अनुमान उपलब्ध न होने पर, यह कार्रवाई नहीं की जाएगी. काम आगे बढ़ने के साथ-साथ बदल सकता है.