REST Resource: projects.databases.collectionGroups.fields

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

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

object (TtlConfig)

إعدادات مدة البقاء (TTL) الخاصة بجهاز Field هذا. سيؤدي ضبط هذا الإعداد أو إلغاء ضبطه إلى تفعيل مدة البقاء (TTL) أو إيقافها للمستندات التي تحتوي على Field هذه.

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

object (Index)

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

boolean

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

string

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

boolean

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

{
  "state": enum (State)
}

enum (State)

النتائج فقط. حالة تهيئة مدة البقاء.