Chỉ mục
FirestoreAdmin
(giao diện)Backup
(tin nhắn)Backup.State
(enum)BackupSchedule
(tin nhắn)CreateBackupScheduleRequest
(tin nhắn)CreateDatabaseMetadata
(tin nhắn)CreateDatabaseRequest
(tin nhắn)CreateIndexRequest
(tin nhắn)DailyRecurrence
(tin nhắn)Database
(tin nhắn)Database.AppEngineIntegrationMode
(enum)Database.CmekConfig
(tin nhắn)Database.ConcurrencyMode
(enum)Database.DatabaseType
(enum)Database.DeleteProtectionState
(enum)Database.PointInTimeRecoveryEnablement
(enum)DeleteBackupRequest
(tin nhắn)DeleteBackupScheduleRequest
(tin nhắn)DeleteDatabaseMetadata
(tin nhắn)DeleteDatabaseRequest
(tin nhắn)DeleteIndexRequest
(tin nhắn)ExportDocumentsMetadata
(tin nhắn)ExportDocumentsRequest
(tin nhắn)ExportDocumentsResponse
(tin nhắn)Field
(tin nhắn)Field.IndexConfig
(tin nhắn)Field.TtlConfig
(tin nhắn)Field.TtlConfig.State
(enum)FieldOperationMetadata
(tin nhắn)FieldOperationMetadata.IndexConfigDelta
(tin nhắn)FieldOperationMetadata.IndexConfigDelta.ChangeType
(enum)FieldOperationMetadata.TtlConfigDelta
(tin nhắn)FieldOperationMetadata.TtlConfigDelta.ChangeType
(enum)GetBackupRequest
(tin nhắn)GetBackupScheduleRequest
(tin nhắn)GetDatabaseRequest
(tin nhắn)GetFieldRequest
(tin nhắn)GetIndexRequest
(tin nhắn)ImportDocumentsMetadata
(tin nhắn)ImportDocumentsRequest
(tin nhắn)Index
(tin nhắn)Index.ApiScope
(enum)Index.IndexField
(tin nhắn)Index.IndexField.ArrayConfig
(enum)Index.IndexField.Order
(enum)Index.IndexField.VectorConfig
(tin nhắn)Index.IndexField.VectorConfig.FlatIndex
(tin nhắn)Index.QueryScope
(enum)Index.State
(enum)IndexOperationMetadata
(tin nhắn)ListBackupSchedulesRequest
(tin nhắn)ListBackupSchedulesResponse
(tin nhắn)ListBackupsRequest
(tin nhắn)ListBackupsResponse
(tin nhắn)ListDatabasesRequest
(tin nhắn)ListDatabasesResponse
(tin nhắn)ListFieldsRequest
(tin nhắn)ListFieldsResponse
(tin nhắn)ListIndexesRequest
(tin nhắn)ListIndexesResponse
(tin nhắn)LocationMetadata
(tin nhắn)OperationState
(enum)Progress
(tin nhắn)RestoreDatabaseMetadata
(tin nhắn)RestoreDatabaseRequest
(tin nhắn)UpdateBackupScheduleRequest
(tin nhắn)UpdateDatabaseMetadata
(tin nhắn)UpdateDatabaseRequest
(tin nhắn)UpdateFieldRequest
(tin nhắn)WeeklyRecurrence
(tin nhắn)
Quản trị viên trên Firestore
API Quản trị của Cloud Firestore.
API này cung cấp một số dịch vụ quản trị cho Cloud Firestore.
Dự án, Cơ sở dữ liệu, Không gian tên, Bộ sưu tập, Nhóm thu thập và Tài liệu được sử dụng theo định nghĩa trong API Google Cloud Firestore.
Thao tác: Một thao tác thể hiện công việc đang được thực hiện ở chế độ nền.
Dịch vụ chỉ mục quản lý các chỉ mục của Cloud Firestore.
Quá trình tạo chỉ mục được thực hiện không đồng bộ. Một tài nguyên Hoạt động được tạo cho mỗi hoạt động không đồng bộ như vậy. Trạng thái của hoạt động (bao gồm mọi lỗi đã gặp phải) có thể được truy vấn thông qua tài nguyên Hoạt động.
Tập hợp Hoạt động cung cấp bản ghi các thao tác được thực hiện cho Dự án được chỉ định (bao gồm mọi Hoạt động đang diễn ra). Các thao tác không được tạo trực tiếp mà thông qua các lệnh gọi trên các tập hợp hoặc tài nguyên khác.
Hoạt động đã được thực hiện có thể bị xoá để không còn được liệt kê trong tập hợp Hoạt động nữa. Hoạt động sẽ được thu gom rác sau 30 ngày. Theo mặc định, ListOperations sẽ chỉ trở về những hoạt động đang diễn ra và không thành công. Để liệt kê thao tác đã hoàn tất, hãy tạo một yêu cầu ListOperations bằng bộ lọc done: true
.
Các hoạt động do dịch vụ FirestoreAdmin
tạo nhưng được truy cập thông qua dịch vụ google.longrunning.Operations
.
Tạo lịch biểu sao lưu |
---|
Tạo lịch sao lưu trên cơ sở dữ liệu. Bạn có thể định cấu hình tối đa hai lịch sao lưu trên cơ sở dữ liệu, một lịch biểu sao lưu hằng ngày và một lịch biểu sao lưu hằng tuần.
|
CreateDatabase |
---|
Tạo cơ sở dữ liệu.
|
Chỉ mục Tạo |
---|
Tạo chỉ mục tổng hợp. Thao tác này sẽ trả về một
|
Xoá dữ liệu sao lưu |
---|
Xoá một bản sao lưu.
|
Xoá lịch biểu sao lưu |
---|
Xoá lịch biểu sao lưu.
|
Xoá cơ sở dữ liệu |
---|
Xoá cơ sở dữ liệu.
|
XoáChỉ mục |
---|
Xoá chỉ mục tổng hợp.
|
Xuất tài liệu |
---|
Xuất bản sao của tất cả hoặc một nhóm nhỏ tài liệu từ Google Cloud Firestore sang một hệ thống lưu trữ khác, chẳng hạn như Google Cloud Storage. Nội dung cập nhật gần đây đối với tài liệu có thể không được phản ánh trong quá trình xuất. Quá trình xuất diễn ra trong nền và tiến trình xuất có thể được theo dõi và quản lý thông qua tài nguyên Hoạt động được tạo. Chỉ có thể sử dụng kết quả của dữ liệu xuất sau khi hoàn tất thao tác liên kết. Nếu một hoạt động xuất bị huỷ trước khi hoàn tất, thì thao tác này có thể để lại một phần dữ liệu trong Google Cloud Storage. Để biết thêm thông tin chi tiết về hành vi xuất và định dạng đầu ra, hãy tham khảo: https://cloud.google.com/firestore/docs/manage-data/export-import
|
Nhận Sao lưu |
---|
Xem thông tin về bản sao lưu.
|
Nhận lịch biểu Sao lưu |
---|
Lấy thông tin về lịch biểu sao lưu.
|
Cơ sở dữ liệu cơ sở dữ liệu |
---|
Lấy thông tin về cơ sở dữ liệu.
|
Trường nhận |
---|
Lấy siêu dữ liệu và cấu hình cho một Trường.
|
Chỉ mục GetIndex |
---|
Nhận chỉ mục tổng hợp.
|
Nhập tài liệu |
---|
Nhập tài liệu vào Google Cloud Firestore. Các tài liệu hiện có có cùng tên sẽ bị ghi đè. Quá trình nhập diễn ra ở chế độ nền và có thể theo dõi cũng như quản lý tiến trình này thông qua tài nguyên Hoạt động được tạo. Nếu thao tác ImportDocuments bị huỷ, thì có thể một tập hợp con dữ liệu đã được nhập vào Cloud Firestore.
|
ListBackupSchedules |
---|
Liệt kê lịch biểu sao lưu.
|
Sao lưu danh sách |
---|
Liệt kê tất cả bản sao lưu.
|
ListDatabases |
---|
Liệt kê tất cả cơ sở dữ liệu trong dự án.
|
Trường danh sách |
---|
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. Hiện tại,
|
Danh sách chỉ mục |
---|
Liệt kê các chỉ mục tổng hợp.
|
Khôi phục Cơ sở dữ liệu |
---|
Tạo cơ sở dữ liệu mới bằng cách khôi phục từ bản sao lưu hiện có. Cơ sở dữ liệu mới phải ở cùng khu vực đám mây hoặc vị trí nhiều vùng với bản sao lưu hiện có. Thao tác này hoạt động tương tự như [FirestoreAdmin.CreateDatabase][google.firestore.admin.v1.CreateDatabase] ngoại trừ thay vì tạo cơ sở dữ liệu trống mới, bạn sẽ tạo cơ sở dữ liệu mới bằng loại cơ sở dữ liệu, cấu hình chỉ mục và tài liệu từ bản sao lưu hiện có. Bạn có thể sử dụng
|
Cập nhật Lịch Sao lưu |
---|
Cập nhật lịch biểu sao lưu.
|
UpdateDatabase |
---|
Cập nhật cơ sở dữ liệu.
|
Trường cập nhật |
---|
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 Lệnh gọi này trả về một Để đị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
|
Dự phòng
Bản sao lưu của Cơ sở dữ liệu Cloud Firestore.
Bản sao lưu chứa tất cả tài liệu và cấu hình chỉ mục của cơ sở dữ liệu đã cho tại một thời điểm cụ thể.
Trường | |
---|---|
name |
Chỉ có đầu ra. Tên tài nguyên duy nhất của Bản sao lưu. Định dạng là |
database |
Chỉ có đầu ra. Tên của cơ sở dữ liệu Firestore dùng để sao lưu. Định dạng là |
database_uid |
Chỉ có đầu ra. Mã nhận dạng duy nhất (UUID4) do hệ thống tạo cho cơ sở dữ liệu Firestore chứa bản sao lưu. |
snapshot_time |
Chỉ có đầu ra. Bản sao lưu này chứa một bản sao nhất quán bên ngoài của cơ sở dữ liệu tại thời điểm này. |
expire_time |
Chỉ có đầu ra. Dấu thời gian mà bản sao lưu này hết hạn. |
state |
Chỉ có đầu ra. Trạng thái hiện tại của bản sao lưu. |
Tiểu bang
Cho biết trạng thái hiện tại của bản sao lưu.
Enum | |
---|---|
STATE_UNSPECIFIED |
Chưa xác định tiểu bang này. |
CREATING |
Hệ thống vẫn đang tạo bản sao lưu đang chờ xử lý. Các hoạt động trên bản sao lưu sẽ bị từ chối ở trạng thái này. |
READY |
Đã sao lưu xong và sẵn sàng cho bạn sử dụng. |
NOT_AVAILABLE |
Hiện không dùng được nội dung sao lưu. |
Lịch biểu sao lưu
Lịch sao lưu cho Cơ sở dữ liệu Cloud Firestore.
Tài nguyên này thuộc sở hữu của cơ sở dữ liệu mà nó đang sao lưu và sẽ bị xoá cùng với cơ sở dữ liệu. Tuy nhiên, các bản sao lưu thực tế thì không.
Trường | |
---|---|
name |
Chỉ có đầu ra. Mã nhận dạng lịch biểu sao lưu duy nhất trên tất cả các vị trí và cơ sở dữ liệu của dự án nhất định. Giá trị này sẽ được gán tự động. Định dạng là |
create_time |
Chỉ có đầu ra. Dấu thời gian mà lịch biểu sao lưu này được tạo và có hiệu lực kể từ thời điểm đó. Sẽ không có bản sao lưu nào được tạo cho lịch biểu này trước thời điểm này. |
update_time |
Chỉ có đầu ra. Dấu thời gian mà lịch biểu sao lưu này được cập nhật gần đây nhất. Khi tạo lịch sao lưu lần đầu tiên, lịch biểu này giống với create_time. |
retention |
Tại thời điểm tương đối trong tương lai so với thời gian tạo bản sao lưu, bản sao lưu sẽ bị xoá, ví dụ: giữ các bản sao lưu trong 7 ngày. |
Trường hợp recurrence . Một trường đại diện cho thời điểm thực hiện sao lưu. recurrence chỉ có thể là một trong những trạng thái sau: |
|
daily_recurrence |
Đối với lịch biểu chạy hằng ngày. |
weekly_recurrence |
Đối với lịch biểu chạy hằng tuần vào một ngày cụ thể. |
Tạo BackupScheduleRequest
Yêu cầu đối với FirestoreAdmin.CreateBackupSchedule
.
Trường | |
---|---|
parent |
Bắt buộc. Cơ sở dữ liệu mẹ. Định dạng |
backup_schedule |
Bắt buộc. Lịch biểu sao lưu cần tạo. |
CreateDatabaseMetadata (Siêu dữ liệu)
Loại này không có trường.
Siêu dữ liệu liên quan đến thao tác tạo cơ sở dữ liệu.
CreateDatabaseRequest
Yêu cầu đối với FirestoreAdmin.CreateDatabase
.
Trường | |
---|---|
parent |
Bắt buộc. Tên cha mẹ của biểu mẫu |
database |
Bắt buộc. Cơ sở dữ liệu cần tạo. |
database_id |
Bắt buộc. Mã nhận dạng để sử dụng cho cơ sở dữ liệu, mã này sẽ trở thành thành phần cuối cùng trong tên tài nguyên của cơ sở dữ liệu. Giá trị này phải dài từ 4 đến 63 ký tự. Các ký tự hợp lệ là /[a-z][0-9]-/ với ký tự đầu tiên là một chữ cái và chữ cái cuối cùng là một số. Không được giống như UUID /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/. Mã cơ sở dữ liệu "(mặc định)" cũng hợp lệ. |
CreateIndexRequest
Yêu cầu đối với FirestoreAdmin.CreateIndex
.
Trường | |
---|---|
parent |
Bắt buộc. Tên cha mẹ của biểu mẫu |
index |
Bắt buộc. Chỉ mục tổng hợp cần tạo. |
Tần suất định kỳ hằng ngày
Loại này không có trường.
Đại diện cho lịch biểu định kỳ chạy mỗi ngày.
Múi giờ là giờ UTC.
Cơ sở dữ liệu
Cơ sở dữ liệu Cloud Firestore.
Trường | |
---|---|
name |
Tên tài nguyên của Cơ sở dữ liệu. Định dạng: |
uid |
Chỉ có đầu ra. UUID4 do hệ thống tạo cho Cơ sở dữ liệu này. |
create_time |
Chỉ có đầu ra. Dấu thời gian mà cơ sở dữ liệu này được tạo. Các cơ sở dữ liệu được tạo trước năm 2016 không điền sẵn create_time. |
update_time |
Chỉ có đầu ra. Dấu thời gian mà cơ sở dữ liệu này được cập nhật gần đây nhất. Lưu ý rằng phương án này chỉ áp dụng cho các bản cập nhật cho tài nguyên cơ sở dữ liệu chứ không bao gồm dữ liệu trong cơ sở dữ liệu. |
delete_time |
Chỉ có đầu ra. Dấu thời gian mà cơ sở dữ liệu này đã bị xoá. Chỉ thiết lập nếu cơ sở dữ liệu đã bị xoá. |
location_id |
Vị trí của cơ sở dữ liệu. Bạn có thể xem danh sách các địa điểm được hỗ trợ tại https://cloud.google.com/firestore/docs/locations. |
type |
Loại cơ sở dữ liệu. Hãy truy cập vào https://cloud.google.com/datastore/docs/firestore-or-datastore để biết thông tin về cách chọn. |
concurrency_mode |
Chế độ kiểm soát đồng thời dùng cho cơ sở dữ liệu này. |
version_retention_period |
Chỉ có đầu ra. Khoảng thời gian mà các phiên bản dữ liệu trước đây được lưu giữ trong cơ sở dữ liệu. Mọi Nếu bạn bật tính năng PITR, khoảng thời gian lưu giữ là 7 ngày. Nếu không, khoảng thời gian lưu giữ sẽ là 1 giờ. |
earliest_version_time |
Chỉ có đầu ra. Dấu thời gian sớm nhất mà tại đó các phiên bản cũ hơn của dữ liệu có thể được đọc từ cơ sở dữ liệu. Xem [version_retention_period] ở trên; trường này được điền bằng Giá trị này được cập nhật liên tục và sẽ lỗi thời vào thời điểm truy vấn. Nếu bạn đang sử dụng giá trị này để khôi phục dữ liệu, hãy nhớ tính đến thời điểm từ thời điểm giá trị được truy vấn đến thời điểm bạn bắt đầu quá trình khôi phục. |
point_in_time_recovery_enablement |
Liệu có bật tính năng PITR trên cơ sở dữ liệu này hay không. |
app_engine_integration_mode |
Chế độ tích hợp App Engine để dùng cho cơ sở dữ liệu này. |
key_prefix |
Chỉ có đầu ra. Tiền tố khoá cho cơ sở dữ liệu này. Key_prefix này được sử dụng kết hợp với mã dự án (" Giá trị này có thể trống trong trường hợp đó, appid để sử dụng cho khoá được mã hoá URL là project_id (ví dụ: foo thay vì v~foo). |
delete_protection_state |
Trạng thái bảo vệ chống xoá của cơ sở dữ liệu. |
cmek_config |
Không bắt buộc. Sự hiện diện cho biết rằng CMEK đã được bật cho cơ sở dữ liệu này. |
previous_id |
Chỉ có đầu ra. Mã cơ sở dữ liệu trước đây của tài nguyên cơ sở dữ liệu. Trường này chỉ được điền sẵn cho các cơ sở dữ liệu đã bị xoá. |
etag |
Giá trị tổng kiểm này được máy chủ tính toán dựa trên giá trị của các trường khác và có thể được gửi khi có yêu cầu cập nhật và xoá để đảm bảo máy khách có giá trị đã cập nhật trước khi tiếp tục. |
AppEngineIntegrationMode
Loại chế độ tích hợp App Engine.
Enum | |
---|---|
APP_ENGINE_INTEGRATION_MODE_UNSPECIFIED |
Không được sử dụng. |
ENABLED |
Nếu một ứng dụng App Engine tồn tại trong cùng khu vực với cơ sở dữ liệu này, thì cấu hình của App Engine sẽ ảnh hưởng đến cơ sở dữ liệu này. Điều này bao gồm việc vô hiệu hoá ứng dụng và cơ sở dữ liệu, cũng như vô hiệu hoá hoạt động ghi vào cơ sở dữ liệu. |
DISABLED |
App Engine không ảnh hưởng đến khả năng phân phát các yêu cầu của cơ sở dữ liệu này. Đây là chế độ cài đặt mặc định cho cơ sở dữ liệu được tạo bằng API Firestore. |
Cấu hình Cmek
Cấu hình CMEK (Khoá mã hoá do khách hàng quản lý) cho cơ sở dữ liệu Firestore. Nếu không có, thì cơ sở dữ liệu sẽ được bảo vệ bằng khoá mã hoá mặc định của Google.
Trường | |
---|---|
kms_key_name |
Bắt buộc. Bạn chỉ được phép sử dụng các khoá có cùng vị trí với cơ sở dữ liệu này để mã hoá. Đối với vùng đa vùng nam5 của Firestore, thuộc tính này tương ứng với vùng đa vùng Hoa Kỳ của Cloud KMS. Đối với đa vùng eur3 của Firestore, tỷ lệ này tương ứng với Cloud KMS đa vùng châu Âu. Hãy tham khảo tại https://cloud.google.com/km/docs/locations để biết thêm thông tin. Định dạng hợp lệ là |
active_key_version[] |
Chỉ có đầu ra. Các phiên bản khoá KMS đang được sử dụng. Trong quá trình xoay vòng khoá, có thể có nhiều phiên bản khoá đang được sử dụng. Định dạng hợp lệ là |
Chế độ đồng thời
Loại chế độ kiểm soát đồng thời cho các giao dịch.
Enum | |
---|---|
CONCURRENCY_MODE_UNSPECIFIED |
Không được sử dụng. |
OPTIMISTIC |
Sử dụng chế độ kiểm soát đồng thời tối ưu theo mặc định. Chế độ này dành cho cơ sở dữ liệu Cloud Firestore. |
PESSIMISTIC |
Sử dụng chế độ kiểm soát đồng thời bi quan theo mặc định. Chế độ này dành cho cơ sở dữ liệu Cloud Firestore. Đây là chế độ cài đặt mặc định cho Cloud Firestore. |
OPTIMISTIC_WITH_ENTITY_GROUPS |
Sử dụng chế độ kiểm soát đồng thời lạc quan với các nhóm thực thể theo mặc định. Đây là chế độ duy nhất hiện có cho Cloud Datastore. Bạn cũng có thể sử dụng chế độ này cho Cloud Firestore ở Chế độ kho dữ liệu nhưng không nên dùng. |
Loại cơ sở dữ liệu
Loại cơ sở dữ liệu. Hãy truy cập vào https://cloud.google.com/datastore/docs/firestore-or-datastore để biết thông tin về cách chọn.
Chỉ cho phép thay đổi chế độ nếu cơ sở dữ liệu trống.
Enum | |
---|---|
DATABASE_TYPE_UNSPECIFIED |
Giá trị mặc định. Giá trị này được dùng nếu loại cơ sở dữ liệu bị bỏ qua. |
FIRESTORE_NATIVE |
Chế độ gốc trên Firestore |
DATASTORE_MODE |
Firestore ở Chế độ Datastore. |
DeleteProtectionState
Trạng thái bảo vệ xoá của cơ sở dữ liệu.
Enum | |
---|---|
DELETE_PROTECTION_STATE_UNSPECIFIED |
Giá trị mặc định. Chưa chỉ định loại bảo vệ |
DELETE_PROTECTION_DISABLED |
Tính năng xoá tính năng bảo vệ đã bị tắt |
DELETE_PROTECTION_ENABLED |
Tính năng xoá bảo vệ đã bật |
PointInTimeRecoveryEnablement
Bật tính năng Khôi phục thời điểm.
Enum | |
---|---|
POINT_IN_TIME_RECOVERY_ENABLEMENT_UNSPECIFIED |
Không được sử dụng. |
POINT_IN_TIME_RECOVERY_ENABLED |
Hoạt động đọc được hỗ trợ trên những phiên bản dữ liệu đã chọn trong vòng 7 ngày qua:
Bạn có thể sử dụng |
POINT_IN_TIME_RECOVERY_DISABLED |
Hỗ trợ đọc dữ liệu trên mọi phiên bản dữ liệu trong vòng 1 giờ qua. |
Xoá yêu cầu sao lưu
Yêu cầu đối với FirestoreAdmin.DeleteBackup
.
Trường | |
---|---|
name |
Bắt buộc. Tên của bản sao lưu cần xoá. là |
Xoá BackupScheduleRequest
Yêu cầu [FirestoreQuản trị.DeletebackupSchedules][].
Trường | |
---|---|
name |
Bắt buộc. Tên lịch biểu sao lưu. Định dạng |
XoáDatabaseMetadata
Loại này không có trường.
Siêu dữ liệu liên quan đến thao tác xoá cơ sở dữ liệu.
XoáDatabaseRequest
Yêu cầu đối với FirestoreAdmin.DeleteDatabase
.
Trường | |
---|---|
name |
Bắt buộc. Tên của biểu mẫu |
etag |
Etag hiện tại của Cơ sở dữ liệu. Nếu một etag được cung cấp nhưng không khớp với etag hiện tại của cơ sở dữ liệu, thì việc xoá sẽ bị chặn và lỗi FAILED_PRE phối sẽ được trả về. |
Xoá yêu cầu chỉ mục
Yêu cầu đối với FirestoreAdmin.DeleteIndex
.
Trường | |
---|---|
name |
Bắt buộc. Tên của biểu mẫu |
ExportDocumentsMetadata
Siêu dữ liệu về các kết quả bằng google.longrunning.Operation
từ FirestoreAdmin.ExportDocuments
.
Trường | |
---|---|
start_time |
Thời gian bắt đầu thao tác này. |
end_time |
Thời gian hoàn tất thao tác này. Giá trị này sẽ không được đặt nếu bạn vẫn đang thực hiện thao tác. |
operation_state |
Trạng thái của hoạt động xuất. |
progress_documents |
Tiến trình của hoạt động này (trong các tài liệu). |
progress_bytes |
Tiến trình, tính bằng byte, của thao tác này. |
collection_ids[] |
Mã bộ sưu tập nào đang được xuất. |
output_uri_prefix |
Nơi xuất tài liệu. |
namespace_ids[] |
Mã không gian tên đang được xuất. |
snapshot_time |
Dấu thời gian tương ứng với phiên bản cơ sở dữ liệu đang được xuất. Nếu bạn không chỉ định thì sẽ không có gì đảm bảo về tính nhất quán của giấy tờ được xuất. |
ExportDocumentsRequest
Yêu cầu đối với FirestoreAdmin.ExportDocuments
.
Trường | |
---|---|
name |
Bắt buộc. Cơ sở dữ liệu để xuất. Phải có dạng: |
collection_ids[] |
Mã bộ sưu tập cần xuất. Chưa xác định có nghĩa là tất cả các bộ sưu tập. |
output_uri_prefix |
URI đầu ra. Hiện chỉ hỗ trợ các URI Google Cloud Storage có dạng: |
namespace_ids[] |
Danh sách trống đại diện cho tất cả các không gian tên. Đây là cách sử dụng ưu tiên cho những cơ sở dữ liệu không sử dụng không gian tên. Một phần tử chuỗi trống đại diện cho không gian tên mặc định. Bạn nên dùng cách này nếu không muốn đưa dữ liệu vào không gian tên mặc định của cơ sở dữ liệu. Mỗi không gian tên trong danh sách này phải là duy nhất. |
snapshot_time |
Dấu thời gian tương ứng với phiên bản cơ sở dữ liệu sẽ được xuất. Dấu thời gian phải ở trong quá khứ, được làm tròn đến phút và không quá |
Phản hồi về tài liệu xuất
Được trả về trong trường phản hồi google.longrunning.Operation
.
Trường | |
---|---|
output_uri_prefix |
Vị trí của các tệp đầu ra. Bạn có thể sử dụng mã này để bắt đầu nhập vào Cloud Firestore (dự án này hoặc một dự án khác) sau khi thao tác hoàn tất. |
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.
Trường | |
---|---|
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ã)
|
index_config |
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 |
ttl_config |
Cấu hình TTL cho |
Cấu hình chỉ mục
Cấu hình chỉ mục của trường này.
Trường | |
---|---|
indexes[] |
Chỉ mục được hỗ trợ cho trường này. |
uses_ancestor_config |
Chỉ có đầu ra. Nếu đúng, cấu hình chỉ mục của |
ancestor_field |
Chỉ có đầu ra. Chỉ định tên tài nguyên của |
reverting |
Chỉ xuất khi giá trị true (đúng), cấu hình chỉ mục của |
Cấu hình 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.
Trường | |
---|---|
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. |
Thao tác trường siêu dữ liệu
Siêu dữ liệu về các kết quả bằng google.longrunning.Operation
từ FirestoreAdmin.UpdateField
.
Trường | |
---|---|
start_time |
Thời gian bắt đầu thao tác này. |
end_time |
Thời gian hoàn tất thao tác này. Giá trị này sẽ không được đặt nếu bạn vẫn đang thực hiện thao tác. |
field |
Tài nguyên trường mà toán tử này đang hoạt động. Ví dụ: |
index_config_deltas[] |
Danh sách |
state |
Trạng thái của hoạt động. |
progress_documents |
Tiến trình của hoạt động này (trong các tài liệu). |
progress_bytes |
Tiến trình, tính bằng byte, của thao tác này. |
ttl_config_delta |
Mô tả các delta của cấu hình TTL. |
IndexConfigDelta
Thông tin về thay đổi cấu hình chỉ mục.
Trường | |
---|---|
change_type |
Chỉ định cách chỉ mục thay đổi. |
index |
Chỉ mục đang được thay đổi. |
Loại thay đổi
Chỉ định cách chỉ mục thay đổi.
Enum | |
---|---|
CHANGE_TYPE_UNSPECIFIED |
Loại thay đổi chưa được chỉ định hoặc chưa được xác định. |
ADD |
Đang thêm chỉ mục trường duy nhất. |
REMOVE |
Chỉ mục trường đơn đang bị xoá. |
TtlConfigDelta
Thông tin về việc thay đổi cấu hình TTL.
Trường | |
---|---|
change_type |
Chỉ rõ cách cấu hình TTL thay đổi. |
Loại thay đổi
Chỉ định cách thay đổi cấu hình TTL.
Enum | |
---|---|
CHANGE_TYPE_UNSPECIFIED |
Loại thay đổi chưa được chỉ định hoặc chưa được xác định. |
ADD |
Đang thêm cấu hình TTL. |
REMOVE |
Đang xoá cấu hình TTL. |
Nhận yêu cầu sao lưu
Yêu cầu đối với FirestoreAdmin.GetBackup
.
Trường | |
---|---|
name |
Bắt buộc. Tên của bản sao lưu cần tìm nạp. Định dạng là |
NhậnSao lưuScheduleRequest
Yêu cầu đối với FirestoreAdmin.GetBackupSchedule
.
Trường | |
---|---|
name |
Bắt buộc. Tên lịch biểu sao lưu. Định dạng |
GetDatabaseRequest
Yêu cầu đối với FirestoreAdmin.GetDatabase
.
Trường | |
---|---|
name |
Bắt buộc. Tên của biểu mẫu |
GetFieldRequest
Yêu cầu đối với FirestoreAdmin.GetField
.
Trường | |
---|---|
name |
Bắt buộc. Tên của biểu mẫu |
GetIndexRequest
Yêu cầu đối với FirestoreAdmin.GetIndex
.
Trường | |
---|---|
name |
Bắt buộc. Tên của biểu mẫu |
ImportDocumentsMetadata
Siêu dữ liệu về các kết quả bằng google.longrunning.Operation
từ FirestoreAdmin.ImportDocuments
.
Trường | |
---|---|
start_time |
Thời gian bắt đầu thao tác này. |
end_time |
Thời gian hoàn tất thao tác này. Giá trị này sẽ không được đặt nếu bạn vẫn đang thực hiện thao tác. |
operation_state |
Trạng thái của thao tác nhập. |
progress_documents |
Tiến trình của hoạt động này (trong các tài liệu). |
progress_bytes |
Tiến trình, tính bằng byte, của thao tác này. |
collection_ids[] |
Mã bộ sưu tập nào đang được nhập. |
input_uri_prefix |
Vị trí của chứng từ đang được nhập. |
namespace_ids[] |
Mã không gian tên đang được nhập. |
ImportDocumentsRequest
Yêu cầu đối với FirestoreAdmin.ImportDocuments
.
Trường | |
---|---|
name |
Bắt buộc. Cơ sở dữ liệu để nhập vào. Phải có dạng: |
collection_ids[] |
Mã bộ sưu tập cần nhập. Chưa chỉ định có nghĩa là tất cả tập hợp có trong dữ liệu nhập. |
input_uri_prefix |
Vị trí của các tệp đã xuất. Giá trị này phải khớp với output_uri_prefix của ExportDocumentsResponse trong một quá trình xuất đã hoàn tất thành công. Hãy xem: |
namespace_ids[] |
Danh sách trống đại diện cho tất cả các không gian tên. Đây là cách sử dụng ưu tiên cho những cơ sở dữ liệu không sử dụng không gian tên. Một phần tử chuỗi trống đại diện cho không gian tên mặc định. Bạn nên dùng cách này nếu không muốn đưa dữ liệu vào không gian tên mặc định của cơ sở dữ liệu. Mỗi không gian tên trong danh sách này phải là duy nhất. |
Chỉ mục
Chỉ mục Cloud Firestore hỗ trợ các truy vấn đơn giản và phức tạp đối với tài liệu trong cơ sở dữ liệu.
Trường | |
---|---|
name |
Chỉ có đầu ra. Tên do máy chủ xác định cho chỉ mục này. Tên này cho chỉ mục tổng hợp sẽ là: |
query_scope |
Các chỉ mục có phạm vi truy vấn bộ sưu tập được chỉ định sẽ cho phép truy vấn đối với một tập hợp là phần tử con của một tài liệu cụ thể, được chỉ định tại thời điểm truy vấn và có cùng mã bộ sưu tập. Các chỉ mục có phạm vi truy vấn nhóm bộ sưu tập được chỉ định sẽ cho phép truy vấn đối với tất cả các bộ sưu tập là bắt nguồn từ một tài liệu cụ thể, được chỉ định tại thời điểm truy vấn và có cùng mã bộ sưu tập với chỉ mục này. |
api_scope |
Phạm vi API mà chỉ mục này hỗ trợ. |
fields[] |
Các trường mà chỉ mục này hỗ trợ. Đối với chỉ mục tổng hợp, yêu cầu tối thiểu là 2 và tối đa là 100 trường. Mục nhập trường cuối cùng luôn dành cho đường dẫn trường Đối với các chỉ mục trường đơn, đây sẽ luôn là một mục nhập có đường dẫn trường bằng với đường dẫn trường của trường được liên kết. |
state |
Chỉ có đầu ra. Trạng thái phân phát của chỉ mục. |
ApiScope
Phạm vi API xác định các API (Firestore Native hoặc Firestore ở Chế độ Datastore) được hỗ trợ cho truy vấn.
Enum | |
---|---|
ANY_API |
Chỉ API truy vấn gốc của Firestore mới có thể sử dụng chỉ mục này. Đây là tuỳ chọn mặc định. |
DATASTORE_MODE_API |
Chỉ Firestore trong Datastore Mode truy vấn API mới có thể sử dụng chỉ mục. |
Trường chỉ mục
Một trường trong chỉ mục. Trường_path mô tả trường nào được lập chỉ mục, còn value_mode mô tả cách hệ thống lập chỉ mục giá trị của trường.
Trường | |
---|---|
field_path |
Có thể là name. Đối với các chỉ mục trường đơn, giá trị này phải khớp với tên của trường hoặc có thể bị bỏ qua. |
Trường hợp value_mode . Cách Google lập chỉ mục giá trị của trường. value_mode chỉ có thể là một trong những trạng thái sau: |
|
order |
Cho biết rằng trường này hỗ trợ sắp xếp theo thứ tự đã chỉ định hoặc so sánh bằng cách sử dụng =, !=, <, <=, >, >=. |
array_config |
Cho biết rằng trường này hỗ trợ các thao tác trên |
vector_config |
Cho biết rằng trường này hỗ trợ các phép toán lân cận và khoảng cách gần nhất trên vectơ. |
Cấu hình mảng
Các cấu hình giá trị mảng được hỗ trợ.
Enum | |
---|---|
ARRAY_CONFIG_UNSPECIFIED |
Chỉ mục không hỗ trợ các truy vấn mảng bổ sung. |
CONTAINS |
Chỉ mục hỗ trợ các truy vấn vùng chứa mảng. |
Gọi món
Các thứ tự được hỗ trợ.
Enum | |
---|---|
ORDER_UNSPECIFIED |
Chưa xác định thứ tự. Không phải là lựa chọn hợp lệ. |
ASCENDING |
Trường này được sắp xếp theo giá trị của trường tăng dần. |
DESCENDING |
Trường này được sắp xếp theo giá trị của trường giảm dần. |
Cấu hình vectơ
Cấu hình chỉ mục để hỗ trợ các thao tác tìm kiếm vectơ
Trường | |
---|---|
dimension |
Bắt buộc. Kích thước vectơ mà cấu hình này áp dụng. Chỉ mục kết quả sẽ chỉ bao gồm các vectơ của kích thước này và có thể được sử dụng cho tìm kiếm vectơ có cùng kích thước. |
Trường hợp type . Loại chỉ mục được sử dụng. type chỉ có thể là một trong những trạng thái sau: |
|
flat |
Cho biết chỉ mục vectơ là chỉ mục phẳng. |
Chỉ mục phẳng
Loại này không có trường.
Chỉ mục lưu trữ vectơ trong cấu trúc dữ liệu phẳng và hỗ trợ tìm kiếm đầy đủ.
Phạm vi truy vấn
Phạm vi truy vấn xác định phạm vi chạy truy vấn. Nội dung này được chỉ định trong trường from
của Truy vấn có cấu trúc.
Enum | |
---|---|
QUERY_SCOPE_UNSPECIFIED |
Chưa chỉ định phạm vi truy vấn. Không phải là lựa chọn hợp lệ. |
COLLECTION |
Chỉ mục có phạm vi truy vấn tập hợp được chỉ định cho phép truy vấn đối với một tập hợp là phần tử con của một tài liệu cụ thể, được chỉ định tại thời điểm truy vấn và có mã bộ sưu tập do chỉ mục chỉ định. |
COLLECTION_GROUP |
Các chỉ mục có phạm vi truy vấn nhóm bộ sưu tập được chỉ định sẽ cho phép truy vấn đối với tất cả các tập hợp có mã bộ sưu tập do chỉ mục chỉ định. |
COLLECTION_RECURSIVE |
Thêm đối tượng cấp trên của tất cả tập hợp vào chỉ mục. Chỉ dành cho cơ sở dữ liệu Chế độ kho dữ liệu. |
Tiểu bang
Trạng thái của chỉ mục. Trong quá trình tạo chỉ mục, chỉ mục sẽ ở trạng thái CREATING
. Nếu được tạo thành công, chỉ mục sẽ chuyển sang trạng thái READY
. Nếu quá trình tạo chỉ mục gặp sự cố, thì chỉ mục sẽ chuyển sang trạng thái NEEDS_REPAIR
.
Enum | |
---|---|
STATE_UNSPECIFIED |
Chưa xác định tiểu bang này. |
CREATING |
Chỉ mục đang được tạo. Có một hoạt động hoạt động diễn ra trong thời gian dài cho chỉ mục. Chỉ mục được cập nhật khi soạn một tài liệu. Một số dữ liệu chỉ mục có thể tồn tại. |
READY |
Chỉ mục đã sẵn sàng để sử dụng. Chỉ mục được cập nhật khi soạn một tài liệu. Chỉ mục được điền đầy đủ từ tất cả các tài liệu được lưu trữ mà chỉ mục áp dụng. |
NEEDS_REPAIR |
Chỉ mục đang được tạo, nhưng đã xảy ra lỗi. Không có hoạt động nào đang hoạt động trong thời gian dài cho chỉ mục và hoạt động chạy trong thời gian dài kết thúc gần đây nhất đều không thành công. Chỉ mục không được cập nhật khi soạn một tài liệu. Một số dữ liệu chỉ mục có thể tồn tại. Sử dụng API google.longRunning.Operations để xác định lý do khiến hoạt động gần đây nhất nhằm tạo chỉ mục này không thành công, sau đó tạo lại chỉ mục. |
Chỉ số OperationMetadata
Siêu dữ liệu về các kết quả bằng google.longrunning.Operation
từ FirestoreAdmin.CreateIndex
.
Trường | |
---|---|
start_time |
Thời gian bắt đầu thao tác này. |
end_time |
Thời gian hoàn tất thao tác này. Giá trị này sẽ không được đặt nếu bạn vẫn đang thực hiện thao tác. |
index |
Tài nguyên chỉ mục mà toán tử này đang xử lý. Ví dụ: |
state |
Trạng thái của hoạt động. |
progress_documents |
Tiến trình của hoạt động này (trong các tài liệu). |
progress_bytes |
Tiến trình, tính bằng byte, của thao tác này. |
ListBackupSchedulesRequest
Yêu cầu đối với FirestoreAdmin.ListBackupSchedules
.
Trường | |
---|---|
parent |
Bắt buộc. Cơ sở dữ liệu mẹ. Định dạng là |
ListBackupSchedulesResponse
Câu trả lời cho FirestoreAdmin.ListBackupSchedules
.
Trường | |
---|---|
backup_schedules[] |
Danh sách tất cả lịch sao lưu. |
ListSao lưu yêu cầu
Yêu cầu đối với FirestoreAdmin.ListBackups
.
Trường | |
---|---|
parent |
Bắt buộc. Vị trí để liệt kê bản sao lưu. Định dạng là |
ListSao lưu phản hồi
Câu trả lời cho FirestoreAdmin.ListBackups
.
Trường | |
---|---|
backups[] |
Danh sách tất cả bản sao lưu của dự án. |
unreachable[] |
Danh sách vị trí không thể tìm nạp các bản sao lưu hiện có. Thay vì không thực hiện được toàn bộ yêu cầu khi không thể truy cập vào một vị trí duy nhất, phản hồi này sẽ trả về một phần tập hợp kết quả và danh sách các vị trí không thể truy cập tại đây. Bạn có thể thử yêu cầu lại trên một vị trí duy nhất để nhận được lỗi cụ thể. |
ListDatabasesRequest
Yêu cầu liệt kê Cơ sở dữ liệu Firestore ở mọi vị trí cho một dự án.
Trường | |
---|---|
parent |
Bắt buộc. Tên cha mẹ của biểu mẫu |
show_deleted |
Nếu đúng, hàm này cũng trả về các tài nguyên đã xoá. |
ListDatabasesResponse
Danh sách cơ sở dữ liệu của một dự án.
Trường | |
---|---|
databases[] |
Các cơ sở dữ liệu trong dự án. |
unreachable[] |
Trong trường hợp không thể liệt kê dữ liệu về cơ sở dữ liệu riêng lẻ, chúng sẽ được ghi lại tại đây. Ví dụ về mục nhập có thể là: project/some_project/locations/some_location Điều này có thể xảy ra nếu Khu vực đám mây chứa Cơ sở dữ liệu hiện không có sẵn. Trong trường hợp này, chúng tôi không thể tìm nạp tất cả thông tin chi tiết về cơ sở dữ liệu. Bạn có thể nhận được thông báo lỗi chi tiết hơn (hoặc tìm nạp tài nguyên) bằng cách gửi yêu cầu "Nhận" cho tài nguyên hoặc yêu cầu "Danh sách" cho vị trí cụ thể. |
Yêu cầu trường danh sách
Yêu cầu đối với FirestoreAdmin.ListFields
.
Trường | |
---|---|
parent |
Bắt buộc. Tên cha mẹ của biểu mẫu |
filter |
Bộ lọc để áp dụng cho kết quả danh sách. Hiện tại, |
page_size |
Số lượng kết quả trả về. |
page_token |
Mã thông báo trang, được trả về từ lệnh gọi trước đó đến |
Phản hồi trường danh sách
Câu trả lời cho FirestoreAdmin.ListFields
.
Trường | |
---|---|
fields[] |
Các trường được yêu cầu. |
next_page_token |
Mã thông báo trang có thể được dùng để yêu cầu một trang kết quả khác. Nếu trang trống, thì đây là trang cuối cùng. |
ListIndexesRequest
Yêu cầu đối với FirestoreAdmin.ListIndexes
.
Trường | |
---|---|
parent |
Bắt buộc. Tên cha mẹ của biểu mẫu |
filter |
Bộ lọc để áp dụng cho kết quả danh sách. |
page_size |
Số lượng kết quả trả về. |
page_token |
Mã thông báo trang, được trả về từ lệnh gọi trước đó đến |
ListIndexesResponse
Câu trả lời cho FirestoreAdmin.ListIndexes
.
Trường | |
---|---|
indexes[] |
Chỉ mục được yêu cầu. |
next_page_token |
Mã thông báo trang có thể được dùng để yêu cầu một trang kết quả khác. Nếu trang trống, thì đây là trang cuối cùng. |
LocationMetadata (Siêu dữ liệu vị trí)
Loại này không có trường.
Thông báo siêu dữ liệu cho google.cloud.location.Location.metadata
.
Trạng thái hoạt động
Mô tả trạng thái của hoạt động.
Enum | |
---|---|
OPERATION_STATE_UNSPECIFIED |
Không xác định. |
INITIALIZING |
Yêu cầu đang được chuẩn bị để xử lý. |
PROCESSING |
Yêu cầu đang được xử lý. |
CANCELLING |
Yêu cầu đang trong quá trình bị huỷ sau khi người dùng có tên là google.longRunning.Operations.CancelOperation thực hiện. |
FINALIZING |
Yêu cầu đã được xử lý và đang trong giai đoạn hoàn tất. |
SUCCESSFUL |
Yêu cầu đã hoàn tất thành công. |
FAILED |
Yêu cầu đã được xử lý xong nhưng gặp lỗi. |
CANCELLED |
Yêu cầu đã bị huỷ sau khi người dùng có tên là google.longRunning.Operations.CancelOperation. |
Tiến độ
Mô tả tiến trình của thao tác. Đơn vị công việc là khái niệm chung và phải được diễn giải dựa trên nơi sử dụng Progress
.
Trường | |
---|---|
estimated_work |
Khối lượng công việc ước tính. |
completed_work |
Khối lượng công việc đã hoàn thành. |
Khôi phục Siêu dữ liệu
Siêu dữ liệu cho long-running operation
từ yêu cầu [RestoreDatabase][google.firestore.admin.v1.RestoreDatabase].
Trường | |
---|---|
start_time |
Thời điểm bắt đầu quá trình khôi phục. |
end_time |
Thời gian hoàn tất quá trình khôi phục, không đặt đối với các quá trình khôi phục đang diễn ra. |
operation_state |
Trạng thái hoạt động của quá trình khôi phục. |
database |
Tên của cơ sở dữ liệu đang được khôi phục. |
backup |
Tên của quá trình khôi phục bản sao lưu. |
progress_percentage |
Khoảng thời gian khôi phục là phần trăm thời gian còn lại ước tính. |
Khôi phục_Yêu cầu cơ sở dữ liệu
Thông báo yêu cầu cho [FirestoreManage.RestoreDatabase][google.firestore.admin.v1.RestoreDatabase].
Trường | |
---|---|
parent |
Bắt buộc. Dự án khôi phục cơ sở dữ liệu. Định dạng là |
database_id |
Bắt buộc. Mã nhận dạng để sử dụng cho cơ sở dữ liệu, mã này sẽ trở thành thành phần cuối cùng trong tên tài nguyên của cơ sở dữ liệu. Không được liên kết mã cơ sở dữ liệu này với một cơ sở dữ liệu hiện có. Giá trị này phải dài từ 4 đến 63 ký tự. Các ký tự hợp lệ là /[a-z][0-9]-/ với ký tự đầu tiên là một chữ cái và chữ cái cuối cùng là một số. Không được giống như UUID /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/. Mã cơ sở dữ liệu "(mặc định)" cũng hợp lệ. |
Trường hợp
|
|
backup |
Sao lưu để khôi phục. Phải thuộc cùng một dự án với mẫu gốc. Định dạng là: |
UpdateBackupScheduleRequest
Yêu cầu đối với FirestoreAdmin.UpdateBackupSchedule
.
Trường | |
---|---|
backup_schedule |
Bắt buộc. Lịch biểu sao lưu cần cập nhật. |
update_mask |
Danh sách trường cần cập nhật. |
UpdateDatabaseMetadata
Loại này không có trường.
Siêu dữ liệu liên quan đến thao tác cập nhật cơ sở dữ liệu.
UpdateDatabaseRequest
Yêu cầu đối với FirestoreAdmin.UpdateDatabase
.
Trường | |
---|---|
database |
Bắt buộc. Cơ sở dữ liệu cần cập nhật. |
update_mask |
Danh sách trường cần cập nhật. |
Yêu cầu trường cập nhật
Yêu cầu đối với FirestoreAdmin.UpdateField
.
Trường | |
---|---|
field |
Bắt buộc. Trường sẽ được cập nhật. |
update_mask |
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. |
Tần suất hằng tuần
Đại diện cho lịch biểu định kỳ chạy vào một ngày được chỉ định trong tuần.
Múi giờ là giờ UTC.
Trường | |
---|---|
day |
Ngày trong tuần sẽ chạy. Không cho phép DAY_OF_WEEK_UNSPECIFIED. |