REST Resource: projects.databases.collectionGroups.fields

Tài nguyên: Trường

Đại diện cho một trường duy nhất trong cơ sở dữ liệu.

Các trường được nhóm theo "Nhóm thu thập" đại diện cho tất cả các tập hợp trong cơ sở dữ liệu bằng cùng một mã nhận dạng.

Biểu diễn dưới dạng JSON 
{
  "name": string,
  "indexConfig": {
    object (IndexConfig)
  },
  "ttlConfig": {
    object (TtlConfig)
  }
}
Trường
name

string

Bắt buộc. 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.
indexConfig

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.
ttlConfig

object (TtlConfig)

Cấu hình TTL cho Field này. Đặt hoặc hủy thiết lập chế độ này sẽ bật hoặc tắt TTL cho các tài liệu có Field này.

IndexConfig

Cấu hình chỉ mục của trường này.

Biểu diễn dưới dạng JSON 
{
  "indexes": [
    {
      object (Index)
    }
  ],
  "usesAncestorConfig": boolean,
  "ancestorField": string,
  "reverting": boolean
}
Trường
indexes[]

object (Index)

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

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.
ancestorField

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).
reverting

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.

TtlConfig

Cấu hình TTL (thời gian tồn tại) cho các tài liệu đã đặt Field này.

Việc lưu trữ giá trị dấu thời gian vào trường có bật TTL sẽ được coi là thời gian hết hạn tuyệt đối của tài liệu. Giá trị dấu thời gian trong quá khứ cho biết tài liệu đủ điều kiện để hết hạn ngay lập tức. Việc sử dụng bất kỳ loại dữ liệu nào khác hoặc không có trường này sẽ vô hiệu hoá thời hạn cho từng tài liệu.

Biểu diễn dưới dạng JSON 
{
  "state": enum (State)
}
Trường
state

enum (State)

Chỉ có đầu ra. Trạng thái của cấu hình TTL.

Tiểu bang

Trạng thái áp dụng cấu hình TTL cho tất cả tài liệu.

Enum
STATE_UNSPECIFIED Trạng thái chưa được chỉ định hoặc không xác định.
CREATING Đang áp dụng TTL. Có một hoạt động đang diễn ra và hoạt động trong thời gian dài để theo dõi thay đổi. Tài liệu mới viết sẽ được áp dụng TTL theo yêu cầu. Các TTL được yêu cầu trên tài liệu hiện có vẫn đang được xử lý. Khi TTL trên tất cả tài liệu hiện có được xử lý, trạng thái sẽ chuyển sang trạng thái "ĐANG HOẠT ĐỘNG".
ACTIVE TTL đang hoạt động đối với tất cả tài liệu.
NEEDS_REPAIR Không thể bật cấu hình TTL cho tất cả các tài liệu hiện có. Các tài liệu mới viết sẽ tiếp tục được áp dụng TTL. LRO đã trả lại khi cố gắng bật TTL cho Field này lần gần đây nhất không thành công và có thể có thêm thông tin chi tiết.

Phương thức

get

 Lấy siêu dữ liệu và cấu hình cho một Trường.

list

 Liệt kê siêu dữ liệu và cấu hình của trường cho cơ sở dữ liệu này.

patch

 Cập nhật cấu hình trường.