Package google.firestore.admin.v1beta2

الفهرس

مشرف في متجر Firestore

يتم إنشاء العمليات من خلال الخدمة FirestoreAdmin، ولكن يتم الوصول إليها عبر خدمة google.longrunning.Operations.

إنشاء فهرس

rpc CreateIndex(CreateIndexRequest) returns (Operation)

ينشئ فهرسًا مركبًا. يؤدي ذلك إلى عرض رمز google.longrunning.Operation الذي يمكن استخدامه لتتبّع حالة صناعة المحتوى. ستكون البيانات الوصفية للعملية من النوع IndexOperationMetadata.

نطاقات الأذونات

يتطلب هذا الإعداد أحد نطاقات OAuth التالية:

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

لمزيد من المعلومات، يُرجى الاطّلاع على نظرة عامة على المصادقة.
حذف الفهرس

rpc 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 GetField(GetFieldRequest) returns (Field)

الحصول على البيانات الوصفية والتهيئة للحقل.

نطاقات الأذونات

يتطلب هذا الإعداد أحد نطاقات OAuth التالية:

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

لمزيد من المعلومات، يُرجى الاطّلاع على نظرة عامة على المصادقة.
مؤشر GetIndex

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. يتم استبدال المستندات الحالية التي تحمل الاسم نفسه. يحدث الاستيراد في الخلفية ويمكن مراقبة مستوى تقدُّمه وإدارته من خلال مورد "العملية" الذي يتم إنشاؤه. في حال إلغاء عملية الاستيراد، من المحتمل أن تكون مجموعة فرعية من البيانات قد تم استيرادها من قبل إلى Cloud Firestore.

نطاقات الأذونات

يتطلب هذا الإعداد أحد نطاقات 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.

نطاقات الأذونات

يتطلب هذا الإعداد أحد نطاقات OAuth التالية:

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

لمزيد من المعلومات، يُرجى الاطّلاع على نظرة عامة على المصادقة.
فهارس القوائم

rpc ListIndexes(ListIndexesRequest) returns (ListIndexesResponse)

يسرد الفهارس المركّبة.

نطاقات الأذونات

يتطلب هذا الإعداد أحد نطاقات OAuth التالية:

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

لمزيد من المعلومات، يُرجى الاطّلاع على نظرة عامة على المصادقة.
حقل التحديث

rpc UpdateField(UpdateFieldRequest) returns (Operation)

يتم تعديل إعدادات الحقل. في الوقت الحالي، لا تنطبق تعديلات الحقول إلا على إعدادات فهرس الحقل الواحد. ومع ذلك، يجب أن توفر المكالمات الواردة إلى FirestoreAdmin.UpdateField قناع حقل لتجنُّب تغيير أي إعدادات لا يعرف المتصل بها. يجب تحديد قناع الحقل على النحو التالي: { paths: "index_config" }.

تعرض هذه المكالمة رمز google.longrunning.Operation الذي يمكن استخدامه لتتبُّع حالة تعديل الحقل. ستكون البيانات الوصفية للعملية من النوع FieldOperationMetadata.

لضبط إعدادات الحقل التلقائية لقاعدة البيانات، استخدِم السمة Field الخاصة مع اسم المورد: projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/*.

نطاقات الأذونات

يتطلب هذا الإعداد أحد نطاقات OAuth التالية:

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

لمزيد من المعلومات، يُرجى الاطّلاع على نظرة عامة على المصادقة.

إنشاء طلب فهرس

طلب الحصول على FirestoreAdmin.CreateIndex

الحقول
parent

string

اسم أحد الوالدين للنموذج projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}
index

Index

الفهرس المركب المراد إنشاؤه.

طلب حذف الفهرس

طلب الحصول على FirestoreAdmin.DeleteIndex

الحقول
name

string

اسم النموذج projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}

ExportDocumentsMetadata

البيانات الوصفية لـ google.longrunning.Operation نتيجة من FirestoreAdmin.ExportDocuments

الحقول
start_time

Timestamp

وقت بدء هذه العملية.
end_time

Timestamp

وقت اكتمال هذه العملية. سيتم إلغاء التعيين في حال استمرار تنفيذ العملية.
operation_state

OperationState

حالة عملية التصدير.
progress_documents

Progress

التقدم في هذه العملية في المستندات.
progress_bytes

Progress

مستوى التقدّم في هذه العملية بالبايت.
collection_ids[]

string

أرقام تعريف المجموعات التي يتم تصديرها
output_uri_prefix

string

المكان الذي يتم تصدير العناصر إليه

طلب تصدير المستندات

طلب الحصول على FirestoreAdmin.ExportDocuments

الحقول
name

string

قاعدة البيانات المراد تصديرها. يجب أن يكون بالتنسيق: projects/{project_id}/databases/{database_id}.
collection_ids[]

string

معرّفات المجموعات المطلوب تصديرها. ويشير "غير محدّدة" إلى كل المجموعات.
output_uri_prefix

string

معرّف الموارد المنتظم (URI) الناتج. لا يتوافق هذا الإعداد حاليًا إلا مع معرّفات الموارد المنتظمة (URI) لخدمة Google Cloud Storage على النحو التالي: gs://BUCKET_NAME[/NAMESPACE_PATH]، حيث يكون BUCKET_NAME هو اسم حزمة Google Cloud Storage وNAMESPACE_PATH مسار اختياري لمساحة الاسم في Google Cloud Storage. عند اختيار اسم، احرص على مراعاة إرشادات التسمية في Google Cloud Storage: https://cloud.google.com/storage/docs/naming. إذا كان معرِّف الموارد المنتظم (URI) عبارة عن مجموعة بيانات (بدون مسار مساحة اسم)، سيتم إنشاء بادئة استنادًا إلى وقت البدء.

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.

أمثلة: (ملاحظة: تتم كتابة التعليقات هنا في بنية markdown، لذا توجد طبقة إضافية من الفواصل العليا المائلة لتمثيل مجموعة رموز) \address.city`represents a field namedaddress.city, not the map key cityin the fieldaddress. `*`represents a field named*`، وليس أي حقل.

تتضمّن قيمة Field الخاصة إعدادات الفهرسة التلقائية لجميع الحقول. اسم المورد لهذا الحقل هو: projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/* الفهارس المحدّدة في Field هذا سيتم تطبيقها على جميع الحقول التي ليس لها إعدادات فهرس Field الخاصة بها.
index_config

IndexConfig

إعدادات الفهرس لهذا الحقل. وفي حال ترك هذه السياسة بدون ضبط، ستتم إعادة فهرسة الحقول إلى الإعدادات المحدّدة من خلال سياسة ancestor_field. لإزالة جميع الفهارس الخاصة بهذا الحقل صراحةً، حدِّد إعدادات فهرس باستخدام قائمة فارغة من الفهارس.

إعدادات الفهرس

إعدادات الفهرس لهذا الحقل.

الحقول
indexes[]

Index

الفهارس المتوافقة مع هذا الحقل
uses_ancestor_config

bool

النتائج فقط. عندما تكون القيمة true، يتم ضبط إعدادات فهرس 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.

البيانات الوصفية للعمليات الحقلية

البيانات الوصفية لـ google.longrunning.Operation نتيجة من FirestoreAdmin.UpdateField

الحقول
start_time

Timestamp

وقت بدء هذه العملية.
end_time

Timestamp

وقت اكتمال هذه العملية. سيتم إلغاء التعيين في حال استمرار تنفيذ العملية.
field

string

تمثّل هذه السمة المورد الميداني الذي تعمل عليه هذه العملية. مثلاً: projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}
index_config_deltas[]

IndexConfigDelta

قائمة IndexConfigDelta التي تصف الغرض من هذه العملية.
state

OperationState

حالة العملية.
document_progress

Progress

التقدم في هذه العملية في المستندات.
bytes_progress

Progress

مستوى التقدّم في هذه العملية بالبايت.

أداة IndexConfigDelta

معلومات حول تغيير تهيئة الفهرس.

الحقول
change_type

ChangeType

لتحديد كيفية تغيير الفهرس.
index

Index

يتم تغيير الفهرس.

نوع التغيير

لتحديد كيفية تغيير الفهرس.

تعدادات
CHANGE_TYPE_UNSPECIFIED نوع التغيير غير محدد أو معروف.
ADD تتم إضافة فهرس الحقل الفردي.
REMOVE تتم إزالة فهرس الحقل الفردي.

طلب GetFieldRequest

طلب الحصول على FirestoreAdmin.GetField

الحقول
name

string

اسم النموذج projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_id}

طلب GetIndexRequest

طلب الحصول على FirestoreAdmin.GetIndex

الحقول
name

string

اسم النموذج projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}

ImportDocumentsMetadata

البيانات الوصفية لـ google.longrunning.Operation نتيجة من FirestoreAdmin.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

موقع الملفات التي تم تصديرها يجب أن يتطابق هذا الحقل مع معلَمة Export_uri_prefix الخاصة بـ ExportDocumentsResponse من عملية التصدير التي اكتملت بنجاح. يمكنك الاطّلاع على: google.firestore.admin.v1beta2.ExportDocumentsResponse.output_uri_prefix.

الفهرس

تتيح فهارس Cloud Firestore طلبات بحث بسيطة ومعقدة مقابل المستندات في قاعدة البيانات.

الحقول
name

string

النتائج فقط. اسم محدّد بواسطة الخادم لهذا الفهرس. سيكون شكل هذا الاسم للفهارس المركّبة: projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{composite_index_id} بالنسبة إلى فهارس الحقل الفردي، سيكون هذا الحقل فارغًا.
query_scope

QueryScope

تسمح الفهارس ذات نطاق طلب البحث في المجموعة المحددة بطلبات البحث في مقابل مجموعة تمثل عنصرًا فرعيًا لمستند معيّن، ويتم تحديدها في وقت طلب البحث، ولها نفس معرّف المجموعة.

تسمح الفهارس ذات نطاق طلب بحث مجموعة مجموعات محدد بطلبات البحث مقابل جميع المجموعات الناقصة من مستند معين، ويتم تحديدها في وقت طلب البحث، والتي لها معرّف المجموعة نفسه مثل هذا الفهرس.
fields[]

IndexField

الحقول التي يدعمها هذا الفهرس.

بالنسبة إلى الفهارس المركّبة، يكون هذا دائمًا حقلين أو أكثر. يكون إدخال الحقل الأخير دائمًا لمسار الحقل __name__. إذا لم يتم تحديد __name__ كحقل أخير عند الإنشاء، ستتم إضافته تلقائيًا باتجاه الحقل الأخير المحدّد. إذا لم يكن الحقل الأخير في الفهرس المركّب اتجاهًا، سيتم ترتيب __name__ بترتيب تصاعدي (ما لم يتم تحديده صراحةً).

بالنسبة إلى فهارس الحقل الفردي، سيكون هذا دائمًا إدخالاً واحدًا بالضبط مع مسار حقل مساوٍ لمسار الحقل المرتبط.
state

State

النتائج فقط. حالة عرض الفهرس.

حقل الفهرس

حقل في الفهرس. يصف field_path الحقل الذي تمت فهرسته، ويصف value_mode كيفية فهرسة قيمة الحقل.

الحقول
field_path

string

يمكن أن تكون القيمة name. بالنسبة إلى فهارس الحقل الفردي، يجب أن يتطابق هذا مع اسم الحقل أو قد يتم حذفه.
حقل الاتحاد value_mode. طريقة فهرسة قيمة الحقل يمكن أن يكون value_mode واحدًا فقط مما يلي:
order

Order

يشير إلى أنّ هذا الحقل يتيح الترتيب حسب الترتيب المحدد أو المقارنة باستخدام = أو < أو <= أو > أو >=.
array_config

ArrayConfig

يشير إلى أنّ هذا الحقل يتيح العمليات التي تتم على array_value.

إعدادات الصفيف

إعدادات قيم الصفيف المتوافقة

تعدادات
ARRAY_CONFIG_UNSPECIFIED لا يتيح الفهرس طلبات بحث صفيف إضافية.
CONTAINS يتيح الفهرس طلبات احتواء الصفيفة.

طلب

تمثّل هذه السمة الطلبات المتوافقة.

تعدادات
ORDER_UNSPECIFIED لم يتم تحديد الطلب. الخيار غير صالح.
ASCENDING يتم ترتيب الحقل تصاعديًا حسب قيمة الحقل.
DESCENDING يتم ترتيب الحقل تنازليًا حسب قيمة الحقل.

نطاق الاستعلام

يحدّد نطاق طلب البحث النطاق الذي يتم تنفيذ طلب البحث عليه. ويتم تحديد ذلك في حقل from في طلب البحث المنظَّمة.

تعدادات
QUERY_SCOPE_UNSPECIFIED نطاق طلب البحث غير محدد. الخيار غير صالح.
COLLECTION تسمح الفهارس ذات نطاق استعلام المجموعة المحدد بطلبات البحث مقابل مجموعة تمثل عنصرًا فرعيًا لمستند معين، ويتم تحديدها وقت طلب البحث، ولها معرف المجموعة المحدد من قبل الفهرس.
COLLECTION_GROUP تسمح الفهارس ذات نطاق طلب بحث مجموعة المجموعات المحدّد بطلبات البحث مقابل كل المجموعات التي لها معرّف المجموعة المحدّد من خلال الفهرس.

الولاية

حالة الفهرس. أثناء إنشاء الفهرس، سيكون الفهرس في حالة CREATING. إذا تم إنشاء الفهرس بنجاح، سينتقل إلى حالة READY. إذا واجهت أي مشكلة في إنشاء الفهرس، سينتقل الفهرس إلى حالة NEEDS_REPAIR.

تعدادات
STATE_UNSPECIFIED لم يتم تحديد الولاية.
CREATING يتم إنشاء الفهرس. هناك عملية نشطة طويلة الأمد للفهرس. يتم تعديل الفهرس عند كتابة مستند. قد تتوفّر بعض بيانات الفهرس.
READY الفهرس جاهز للاستخدام. يتم تعديل الفهرس عند كتابة مستند. تتم تعبئة الفهرس بالكامل من جميع المستندات المخزنة التي ينطبق عليها.
NEEDS_REPAIR كان يتم إنشاء الفهرس، ولكن حدث خطأ ما. ليس هناك عملية نشطة طويلة الأمد للفهرس، وتعذّر إتمام آخر عملية طويلة الأمد. لا يتم تعديل الفهرس عند كتابة مستند. قد تتوفّر بعض بيانات الفهرس. استخدم واجهة برمجة التطبيقات google.long running.Operations API لتحديد سبب فشل العملية الأخيرة التي حاولت إنشاء هذا الفهرس، ثم أعد إنشاء الفهرس.

البيانات الوصفية الخاصة بعملية الفهرسة

البيانات الوصفية لـ google.longrunning.Operation نتيجة من FirestoreAdmin.CreateIndex

الحقول
start_time

Timestamp

وقت بدء هذه العملية.
end_time

Timestamp

وقت اكتمال هذه العملية. سيتم إلغاء التعيين في حال استمرار تنفيذ العملية.
index

string

يشير إلى مورد الفهرس الذي يتم تطبيق هذه العملية عليه. مثلاً: projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}
state

OperationState

حالة العملية.
progress_documents

Progress

التقدم في هذه العملية في المستندات.
progress_bytes

Progress

مستوى التقدّم في هذه العملية بالبايت.

طلب حقول القائمة

طلب الحصول على FirestoreAdmin.ListFields

الحقول
parent

string

اسم أحد الوالدين للنموذج projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}
filter

string

الفلتر المطلوب تطبيقه على قائمة نتائج البحث. في الوقت الحالي، لا يتوافق FirestoreAdmin.ListFields إلا مع حقول البيانات التي تم إلغاؤها بشكل صريح. لإصدار طلب البحث هذا، يمكنك طلب 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

هو رمز مميّز للصفحة يمكن استخدامه لطلب صفحة أخرى من النتائج. إذا كان هذا الحقل فارغًا، تكون هذه هي الصفحة الأخيرة.

حالة العملية

تصف حالة العملية.

تعدادات
OPERATION_STATE_UNSPECIFIED غير محدَّد
INITIALIZING يتم إعداد الطلب للمعالجة.
PROCESSING تجري معالجة الطلب بشكل نشط.
CANCELLING يتم إلغاء الطلب بعد تفعيل المستخدم المسمى google.longrun.Operations.CancelOperation.
FINALIZING تمت معالجة الطلب وهو في مرحلة المعالجة النهائية.
SUCCESSFUL اكتمل الطلب بنجاح.
FAILED انتهت معالجة الطلب، ولكن حدث خطأ.
CANCELLED اكتمل إلغاء الطلب بعد أن يحمل المستخدم الاسم google.longrun.Operations.CancelOperation.

التقدم

يصف مستوى تقدم العملية. وحدة العمل عامة ويجب تفسيرها استنادًا إلى مكان استخدام Progress.

الحقول
estimated_work

int64

مقدار العمل المقدر.
completed_work

int64

حجم العمل المنجز.

طلب التحديث

طلب الحصول على FirestoreAdmin.UpdateField

الحقول
field

Field

الحقل المطلوب تعديله
update_mask

FieldMask

قناع، نسبةً إلى الحقل. في حال تحديد هذا الخيار، سيتم تعديل الإعدادات المحدّدة من خلال هذا الحقل (قناع الحقل) فقط في الحقل.