Package google.firestore.admin.v1beta2

الفهرس

FirestoreAdmin

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

CreateIndex

rpc CreateIndex(CreateIndexRequest) returns (Operation)

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

نطاقات التفويض

يتطلب استخدام أحد نطاقات OAuth التالية:

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

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

rpc DeleteIndex(DeleteIndexRequest) returns (Empty)

حذف فهرس مركب.

نطاقات التفويض

يتطلب استخدام أحد نطاقات OAuth التالية:

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

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

rpc ExportDocuments(ExportDocumentsRequest) returns (Operation)

لتصدير نسخة من كل المستندات أو مجموعة فرعية من المستندات من Google Cloud Firestore إلى نظام تخزين آخر، مثل Google Cloud Storage. قد لا تظهر التعديلات الأخيرة التي تم إجراؤها على المستندات في عملية التصدير. تحدث عملية التصدير في الخلفية ويمكن مراقبة مستوى تقدُّمها وإدارته من خلال مورد "العملية" الذي يتم إنشاؤه. ولا يمكن استخدام ناتج عملية التصدير إلا بعد الانتهاء من العملية المرتبطة. في حال إلغاء عملية تصدير قبل اكتمالها، قد يتم الاحتفاظ ببيانات جزئية في Google Cloud Storage.

نطاقات التفويض

يتطلب استخدام أحد نطاقات OAuth التالية:

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

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

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

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

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

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

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

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

rpc ListIndexes(ListIndexesRequest) returns (ListIndexesResponse)

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

نطاقات التفويض

يتطلب استخدام أحد نطاقات OAuth التالية:

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

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

rpc UpdateField(UpdateFieldRequest) returns (Operation)

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

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

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

نطاقات التفويض

يتطلب استخدام أحد نطاقات OAuth التالية:

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

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

CreateIndexRequest

طلب FirestoreAdmin.CreateIndex.

الحقول
parent

string

اسم عنصر رئيسي بالنموذج projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}
index

Index

الفهرس المركّب المطلوب إنشاؤه.

DeleteIndexRequest

طلب FirestoreAdmin.DeleteIndex.

الحقول
name

string

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

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

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

ExportDocumentsRequest

طلب 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. لإزالة جميع الفهارس لهذا الحقل بشكل صريح، حدِّد إعداد فهرس مع قائمة فارغة من الفهارس.

IndexConfig

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

الحقول
indexes[]

Index

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

bool

النتائج فقط. عندما تكون القيمة "صحيح"، يتم ضبط إعدادات فهرس Field من الإعدادات التي تحدّدها ancestor_field. أمّا في حال ضبط السياسة على "خطأ"، فسيتم تحديد إعدادات فهرس Field بشكل صريح.
ancestor_field

string

النتائج فقط. يحدد اسم مورد Field الذي تم ضبط إعدادات الفهرس لهذا الحقل منه (عندما تكون قيمة uses_ancestor_config true)، أو الذي سيتم ضبطه إذا كان هذا الحقل لا يتضمن أي إعدادات فهرسة (عندما يكون uses_ancestor_config خطأ).
reverting

bool

النتائج فقط عندما تكون القيمة "صحيح"، يعني ذلك أنّ إعدادات فهرس Field قيد عملية التراجع. وبعد اكتمال العملية، ستنتقل إعدادات الفهرس إلى حالة الحقل نفسها المتوفّرة في الحقل ancestor_field، وبذلك سيكون uses_ancestor_config هو true وسيصبح reverting false.

FieldOperationMetadata

البيانات الوصفية لـ 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

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

ChangeType

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

عمليات التعداد
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

موقع المستندات التي يتم استيرادها.

ImportDocumentsRequest

طلب FirestoreAdmin.ImportDocuments.

الحقول
name

string

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

string

معرّفات المجموعات المطلوب استيرادها. الحالة "غير محدّد" تعني جميع المجموعات المضمّنة في عملية الاستيراد.
input_uri_prefix

string

موقع الملفات التي تم تصديرها يجب أن يتطابق هذا الأمر مع out_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

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

IndexField

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

الحقول
field_path

string

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

Order

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

ArrayConfig

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

ArrayConfig

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

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

طلب

الطلبات المتوافقة.

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

QueryScope

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

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

الحالة

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

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

IndexOperationMetadata

البيانات الوصفية لـ 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

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

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

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

OperationState

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

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

مدى التقدُّم

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

الحقول
estimated_work

int64

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

int64

مقدار العمل المنجز.

UpdateFieldRequest

طلب FirestoreAdmin.UpdateField.

الحقول
field

Field

الحقل الذي سيتم تعديله.
update_mask

FieldMask

قناع، مرتبط بالحقل. في حال تحديد هذه السمة، سيتم تعديل الإعدادات التي حدّدها هذا الحقل_mask فقط في الحقل.