REST Resource: projects.databases.collectionGroups.fields

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

string

Tên trường của biểu mẫu projects/{projectId}/databases/{databaseId}/collectionGroups/{collectionId}/fields/{fieldPath}

Đường dẫn trường có thể là một tên trường đơn giản, ví dụ: address hoặc đường dẫn đến các trường trong mapValue, ví dụ: address.city hoặc một đường dẫn trường đặc biệt. Trường đặc biệt hợp lệ duy nhất là *, đại diện cho bất kỳ trường nào.

Đường dẫn trường có thể được trích dẫn bằng cách sử dụng (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),[,]`, cũng như bất kỳ ký tự tượng trưng ascii nào.

Ví dụ: (Lưu ý: Phần ghi chú ở đây được viết theo cú pháp markdown, vì vậy sẽ có thêm một lớp dấu phẩy ngược đại diện cho một khối mã) \address.city`represents a field namedaddress.city, not the map key cityin the fieldaddress. `*`represents a field named*`, chứ không phải trường nào.

Field đặc biệt chứa chế độ cài đặt lập chỉ mục mặc định cho tất cả các trường. Tên tài nguyên của trường này là: projects/{projectId}/databases/{databaseId}/collectionGroups/__default__/fields/* Các chỉ mục được xác định trong Field này sẽ được áp dụng cho tất cả các trường không có cấu hình chỉ mục Field riêng.

object (IndexConfig)

Cấu hình chỉ mục của trường này. Nếu bạn không đặt chính sách này, thì hoạt động lập chỉ mục trường sẽ chuyển về cấu hình do ancestorField xác định. Để xoá tất cả chỉ mục cho trường này một cách rõ ràng, hãy chỉ định cấu hình chỉ mục có danh sách chỉ mục trống.

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

object (Index)

Chỉ mục được hỗ trợ cho trường này.

boolean

Chỉ có đầu ra. Nếu đúng, cấu hình chỉ mục của Field sẽ được đặt từ cấu hình do ancestorField chỉ định. Khi giá trị là false, cấu hình chỉ mục của Field sẽ được xác định một cách rõ ràng.

string

Chỉ có đầu ra. Chỉ định tên tài nguyên của Field dùng để đặt cấu hình chỉ mục của trường này (khi usesAncestorConfig là đúng) hoặc sẽ được đặt từ đó nếu trường này không có cấu hình chỉ mục (khi usesAncestorConfig là sai).

boolean

Chỉ xuất khi giá trị true (đúng), cấu hình chỉ mục của Field đang trong quá trình bị huỷ bỏ. Sau khi hoàn tất, cấu hình chỉ mục sẽ chuyển sang trạng thái giống như trường do ancestorField chỉ định, tại thời điểm đó, usesAncestorConfig sẽ là true và reverting sẽ là false.