Cập nhật cấu hình trường. Hiện tại, việc cập nhật trường chỉ áp dụng cho cấu hình chỉ mục trường đơn. Tuy nhiên, các lệnh gọi đến FirestoreAdmin.UpdateField
phải cung cấp mặt nạ trường (field mask) để tránh thay đổi cấu hình mà phương thức gọi không biết. Mặt nạ cho trường (field mask) phải được chỉ định là: { paths: "indexConfig" }
.
Lệnh gọi này trả về một google.longrunning.Operation
có thể được dùng để theo dõi trạng thái cập nhật trường. Siêu dữ liệu của thao tác này sẽ thuộc loại FieldOperationMetadata
.
Để định cấu hình chế độ cài đặt trường mặc định cho cơ sở dữ liệu, hãy sử dụng Field
đặc biệt có tên tài nguyên: projects/{projectId}/databases/{databaseId}/collectionGroups/__default__/fields/*
.
Yêu cầu HTTP
PATCH https://firestore.googleapis.com/v1/{field.name=projects/*/databases/*/collectionGroups/*/fields/*}
URL sử dụng cú pháp Chuyển mã gRPC.
Tham số đường dẫn
Tham số | |
---|---|
field.name |
Bắt buộc. Tên trường của biểu mẫu Đường dẫn trường có thể là một tên trường đơn giản, ví dụ: Đường dẫn trường có thể được trích dẫn bằng cách sử dụng 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ã)
|
Tham số truy vấn
Tham số | |
---|---|
updateMask |
Một mặt nạ, so với trường. Nếu được chỉ định, chỉ cấu hình do trường_mặt nạ (field_mask) chỉ định mới được cập nhật trong trường này. Đây là danh sách các tên trường đủ điều kiện được phân tách bằng dấu phẩy. Ví dụ: |
Nội dung yêu cầu
Nội dung yêu cầu chứa một bản sao của Field
.
Nội dung phản hồi
Nếu thành công, nội dung phản hồi sẽ chứa một phiên bản của Operation
.
Phạm vi uỷ quyền
Yêu cầu một trong các phạm vi OAuth sau đây:
https://www.googleapis.com/auth/datastore
https://www.googleapis.com/auth/cloud-platform
Để biết thêm thông tin, hãy xem bài viết Tổng quan về hoạt động xác thực.