REST Resource: projects.databases.collectionGroups.fields

{
  "name": string,
  "indexConfig": {
    object (IndexConfig)
  }
}

string

اسم حقل للنموذج projects/{projectId}/databases/{databaseId}/collectionGroups/{collectionId}/fields/{fieldPath}

قد يكون مسار الحقل اسم حقل بسيطًا، على سبيل المثال address، أو مسارًا إلى حقول ضمن قيمة mapValue، مثل: 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/{projectId}/databases/{databaseId}/collectionGroups/__default__/fields/* الفهارس التي تم تحديدها في Field هذا سيتم تطبيقها على جميع الحقول التي ليس لها إعدادات فهرس Field الخاصة بها.

object (IndexConfig)

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

{
  "indexes": [
    {
      object (Index)
    }
  ],
  "usesAncestorConfig": boolean,
  "ancestorField": string,
  "reverting": boolean
}

object (Index)

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

boolean

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

string

النتائج فقط. تحدّد هذه السياسة اسم مورد Field الذي تم ضبط إعدادات الفهرس لهذا الحقل منه (عندما يكون الحقل "usesAncestorConfig" صحيحًا)، أو الذي يتم ضبطه إذا لم يتم ضبط فهرس هذا الحقل (عندما تكون قيمة "usesAncestorConfig" خاطئة).

boolean

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