Package google.firestore.admin.v1beta1

الفهرس

FirestoreAdmin

واجهة برمجة تطبيقات المشرف في Cloud Firestore

توفّر واجهة برمجة التطبيقات هذه العديد من الخدمات الإدارية في Cloud Firestore.

المفاهيم

يتم استخدام المشروع وقاعدة البيانات ومساحة الاسم والتجميع والمستند على النحو المحدّد في واجهة برمجة تطبيقات Google Cloud Firestore.

العملية: تمثل العملية العمل الذي يتم تنفيذه في الخلفية.

الخدمات

الفهرس

تدير خدمة الفهرسة فهارس Cloud Firestore.

يتم إنشاء الفهرس بشكل غير متزامن. ويتم إنشاء مورد عملية لكل عملية غير متزامنة. يمكن الاستعلام عن حالة العملية (بما في ذلك أي أخطاء حدثت) عبر مورد العملية.

البيانات الوصفية

توفير بيانات وصفية ومعلومات إحصائية حول البيانات في Cloud Firestore. قد تكون البيانات المقدَّمة كجزء من واجهة برمجة التطبيقات هذه قديمة.

العملية

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

وقد يتم إلغاء عملية لم تتم بعد. يكون طلب الإلغاء غير متزامن، وقد يستمر تنفيذ العملية لبعض الوقت بعد تقديم طلب الإلغاء.

قد يتم حذف أي عملية مكتملة بحيث لا يتم إدراجها بعد ذلك كجزء من مجموعة "العملية".

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

CreateIndex

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

لمزيد من المعلومات، يُرجى الاطّلاع على نظرة عامة على المصادقة.
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

لمزيد من المعلومات، يُرجى الاطّلاع على نظرة عامة على المصادقة.
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

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

rpc ListIndexes(ListIndexesRequest) returns (ListIndexesResponse)

يسرد الفهارس التي تتطابق مع الفلاتر المحدّدة.

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

يتطلب استخدام أحد نطاقات 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}
index

Index

الفهرس المطلوب إنشاؤه. يتم إخراج حقلَي الاسم والحالة فقط وسيتم تجاهلهما. لا يمكن إنشاء أو حذف فهارس حقل فردي معيَّنة.

DeleteIndexRequest

طلب FirestoreAdmin.DeleteIndex.

الحقول
name

string

اسم الفهرس. مثال: projects/{project_id}/databases/{database_id}/indexes/{index_id}

ExportDocumentsMetadata

البيانات الوصفية لعمليات 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 (هذا المشروع أو مشروع آخر) بعد اكتمال العملية بنجاح.

GetIndexRequest

طلب FirestoreAdmin.GetIndex.

الحقول
name

string

اسم الفهرس. مثال: projects/{project_id}/databases/{database_id}/indexes/{index_id}

ImportDocumentsMetadata

البيانات الوصفية لعمليات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.v1beta1.ExportDocumentsResponse.output_uri_prefix.

الفهرس

تعريف الفهرس.

الحقول
name

string

اسم مورد الفهرس. النتائج فقط.
collection_id

string

معرّف المجموعة الذي ينطبق عليه هذا الفهرس. مطلوبة.
fields[]

IndexField

الحقول المطلوب فهرستها.
state

State

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

الحالة

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

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

IndexField

حقل فهرس.

الحقول
field_path

string

مسار الحقل. يجب أن تتطابق مع مواصفات مسار الحقل الموضحة في [google.firestore.v1beta1.Document.fields][fields]. يمكن استخدام مسار الحقل الخاص __name__ بمفرده أو في نهاية أي مسار. لا يمكن استخدام السمة __type__ إلا في نهاية المسار.
mode

Mode

وضع الحقل.

الوضع

يحدد الوضع كيفية فهرسة الحقل.

عمليات التعداد
MODE_UNSPECIFIED الوضع غير محدّد.
ASCENDING تتم فهرسة قيم الحقل لإتاحة التسلسل بترتيب تصاعدي وكذلك الاستعلام حسب < و> و<= و>= و =.
DESCENDING تتم فهرسة قيم الحقل لإتاحة التسلسل بترتيب تنازلي وكذلك الاستعلام حسب < و> و<= و>= و =.
ARRAY_CONTAINS تتم فهرسة قيم الصفيف في الحقل لإتاحة العضوية باستخدام طلبات البحث ARRAY_CONTAINS.

IndexOperationMetadata

بيانات التعريف الخاصة بعمليات الفهرس تعمل هذه البيانات الوصفية على تعبئة حقل البيانات الوصفية في 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

مستوى تقدُّم العملية الحالية، ويتم قياسه بعدد المستندات

OperationType

نوع عملية الفهرس.

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

الرمز المميز العادي للقائمة التالية.

LocationMetadata

لا يشتمل هذا النوع على أي حقول.

رسالة البيانات الوصفية للموقع الإلكتروني google.cloud.location.Location.metadata.

OperationState

الحالات المختلفة المحتملة لعملية جارية.

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

مدى التقدُّم

يقيس التقدم المحرز في مقياس معين.

الحقول
work_completed

int64

تقدير لمقدار العمل المنجز. لاحظ أن هذه القيمة قد تكون أكبر من work_estimated.
work_estimated

int64

تقدير لمقدار العمل الذي يجب القيام به. صفرًا إذا كان تقدير العمل غير متاح. قد يتغير مع تقدم العمل.