Trang này được dịch bởi Cloud Translation API.

Package google.firestore.admin.v1beta2

Chỉ mục

FirestoreAdmin (giao diện)
CreateIndexRequest (thông báo)
DeleteIndexRequest (thông báo)
ExportDocumentsMetadata (thông báo)
ExportDocumentsRequest (thông báo)
ExportDocumentsResponse (thông báo)
Field (thông báo)
Field.IndexConfig (thông báo)
FieldOperationMetadata (thông báo)
FieldOperationMetadata.IndexConfigDelta (thông báo)
FieldOperationMetadata.IndexConfigDelta.ChangeType (enum)
GetFieldRequest (thông báo)
GetIndexRequest (thông báo)
ImportDocumentsMetadata (thông báo)
ImportDocumentsRequest (thông báo)
Index (thông báo)
Index.IndexField (thông báo)
Index.IndexField.ArrayConfig (enum)
Index.IndexField.Order (enum)
Index.QueryScope (enum)
Index.State (enum)
IndexOperationMetadata (thông báo)
ListFieldsRequest (thông báo)
ListFieldsResponse (thông báo)
ListIndexesRequest (thông báo)
ListIndexesResponse (thông báo)
OperationState (enum)
Progress (thông báo)
UpdateFieldRequest (thông báo)

Quản trị viên trên Firestore

Các thao tác do dịch vụ FirestoreAdmin tạo ra, nhưng được truy cập thông qua dịch vụ google.longrunning.Operations.

CreateIndex

CreateIndex
`rpc CreateIndex(CreateIndexRequest) returns (Operation)` Tạo chỉ mục tổng hợp. Thao tác này sẽ trả về một `google.longrunning.Operation` có thể dùng để theo dõi trạng thái của quá trình tạo. Siêu dữ liệu của thao tác sẽ là kiểu `IndexOperationMetadata`. Phạm vi uỷ quyền Yêu cầu một trong các phạm vi OAuth sau: `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ề việc xác thực.

rpc CreateIndex(CreateIndexRequest) returns (Operation)

Tạo chỉ mục tổng hợp. Thao tác này sẽ trả về một google.longrunning.Operation có thể dùng để theo dõi trạng thái của quá trình tạo. Siêu dữ liệu của thao tác sẽ là kiểu IndexOperationMetadata.

Phạm vi uỷ quyền

Yêu cầu một trong các phạm vi OAuth sau:

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ề việc xác thực.

Xóa chỉ mục

Xóa chỉ mục
`rpc DeleteIndex(DeleteIndexRequest) returns (Empty)` Xóa chỉ mục tổng hợp. Phạm vi uỷ quyền Yêu cầu một trong các phạm vi OAuth sau: `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ề việc xác thực.

rpc DeleteIndex(DeleteIndexRequest) returns (Empty)

Xóa chỉ mục tổng hợp.

Phạm vi uỷ quyền

Yêu cầu một trong các phạm vi OAuth sau:

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ề việc xác thực.

Xuất tài liệu

Xuất tài liệu
`rpc ExportDocuments(ExportDocumentsRequest) returns (Operation)` Xuất bản sao của tất cả hoặc một nhóm nhỏ các 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 sẽ diễn ra ở chế độ nền và bạn có thể giám sát cũng như quản lý tiến trình xuất thông qua tài nguyên Vận hành được tạo. Bạn chỉ có thể sử dụng dữ liệu xuất ra sau khi thực hiện xong thao tác liên kết. Nếu quá trình xuất dữ liệu bị huỷ trước khi hoàn tất, thì có thể để lại một phần dữ liệu trong Google Cloud Storage. Phạm vi uỷ quyền Yêu cầu một trong các phạm vi OAuth sau: `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ề việc xác thực.

rpc ExportDocuments(ExportDocumentsRequest) returns (Operation)

Xuất bản sao của tất cả hoặc một nhóm nhỏ các 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 sẽ diễn ra ở chế độ nền và bạn có thể giám sát cũng như quản lý tiến trình xuất thông qua tài nguyên Vận hành được tạo. Bạn chỉ có thể sử dụng dữ liệu xuất ra sau khi thực hiện xong thao tác liên kết. Nếu quá trình xuất dữ liệu bị huỷ trước khi hoàn tất, thì có thể để lại một phần dữ liệu trong Google Cloud Storage.

Phạm vi uỷ quyền

Yêu cầu một trong các phạm vi OAuth sau:

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ề việc xác thực.

GetField

GetField
`rpc GetField(GetFieldRequest) returns (Field)` Lấy siêu dữ liệu và cấu hình cho một Trường. Phạm vi uỷ quyền Yêu cầu một trong các phạm vi OAuth sau: `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ề việc xác thực.

rpc GetField(GetFieldRequest) returns (Field)

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

Phạm vi uỷ quyền

Yêu cầu một trong các phạm vi OAuth sau:

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ề việc xác thực.

GetIndex

GetIndex
`rpc GetIndex(GetIndexRequest) returns (Index)` Lấy chỉ mục tổng hợp. Phạm vi uỷ quyền Yêu cầu một trong các phạm vi OAuth sau: `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ề việc xác thực.

rpc GetIndex(GetIndexRequest) returns (Index)

Lấy chỉ mục tổng hợp.

Phạm vi uỷ quyền

Yêu cầu một trong các phạm vi OAuth sau:

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ề việc xác thực.

Nhập tài liệu

Nhập tài liệu
`rpc ImportDocuments(ImportDocumentsRequest) returns (Operation)` 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à bạn có thể giám sát cũng như quản lý tiến trình nhập thông qua tài nguyên Vận hành được tạo. Nếu thao tác ImportDocuments bị huỷ, thì có thể một nhóm nhỏ dữ liệu đã được nhập vào Cloud Firestore. Phạm vi uỷ quyền Yêu cầu một trong các phạm vi OAuth sau: `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ề việc xác thực.

rpc ImportDocuments(ImportDocumentsRequest) returns (Operation)

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à bạn có thể giám sát cũng như quản lý tiến trình nhập thông qua tài nguyên Vận hành được tạo. Nếu thao tác ImportDocuments bị huỷ, thì có thể một nhóm nhỏ dữ liệu đã được nhập vào Cloud Firestore.

Phạm vi uỷ quyền

Yêu cầu một trong các phạm vi OAuth sau:

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ề việc xác thực.

ListField (Trường danh sách)

ListField (Trường danh sách)
`rpc ListFields(ListFieldsRequest) returns (ListFieldsResponse)` Liệt kê cấu hình của trường và siêu dữ liệu của cơ sở dữ liệu này. Hiện tại, `FirestoreAdmin.ListFields` chỉ hỗ trợ các trường danh sách đã bị ghi đè rõ ràng. Để đưa ra truy vấn này, hãy gọi `FirestoreAdmin.ListFields` với bộ lọc được đặt thành `indexConfig.usesAncestorConfig:false`. Phạm vi uỷ quyền Yêu cầu một trong các phạm vi OAuth sau: `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ề việc xác thực.

rpc ListFields(ListFieldsRequest) returns (ListFieldsResponse)

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

Hiện tại, FirestoreAdmin.ListFields chỉ hỗ trợ các trường danh sách đã bị ghi đè rõ ràng. Để đưa ra truy vấn này, hãy gọi FirestoreAdmin.ListFields với bộ lọc được đặt thành indexConfig.usesAncestorConfig:false.

Phạm vi uỷ quyền

Yêu cầu một trong các phạm vi OAuth sau:

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ề việc xác thực.

ListIndexes (Chỉ mục danh sách)

ListIndexes (Chỉ mục danh sách)
`rpc ListIndexes(ListIndexesRequest) returns (ListIndexesResponse)` Liệt kê các chỉ mục tổng hợp. Phạm vi uỷ quyền Yêu cầu một trong các phạm vi OAuth sau: `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ề việc xác thực.

rpc ListIndexes(ListIndexesRequest) returns (ListIndexesResponse)

Liệt kê các chỉ mục tổng hợp.

Phạm vi uỷ quyền

Yêu cầu một trong các phạm vi OAuth sau:

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ề việc xác thực.

Trường cập nhật

Trường cập nhật
`rpc UpdateField(UpdateFieldRequest) returns (Operation)` Cập nhật một cấu hình trường. Hiện tại, nội dung cập nhật về trường chỉ áp dụng cho cấu hình chỉ mục trường duy nhất. Tuy nhiên, các lệnh gọi đến `FirestoreAdmin.UpdateField` phải cung cấp mặt nạ trường để tránh thay đổi bất kỳ cấu hình nào mà phương thức gọi không biết. Bạn phải chỉ định mặt nạ trường là: `{ paths: "index_config" }`. Lệnh gọi này trả về một `google.longrunning.Operation` có thể 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 sẽ là kiểu `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/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/*`. Phạm vi uỷ quyền Yêu cầu một trong các phạm vi OAuth sau: `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ề việc xác thực.

rpc UpdateField(UpdateFieldRequest) returns (Operation)

Cập nhật một cấu hình trường. Hiện tại, nội dung cập nhật về trường chỉ áp dụng cho cấu hình chỉ mục trường duy nhất. Tuy nhiên, các lệnh gọi đến FirestoreAdmin.UpdateField phải cung cấp mặt nạ trường để tránh thay đổi bất kỳ cấu hình nào mà phương thức gọi không biết. Bạn phải chỉ định mặt nạ trường là: { paths: "index_config" }.

Lệnh gọi này trả về một google.longrunning.Operation có thể 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 sẽ là kiểu 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/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/*.

Phạm vi uỷ quyền

Yêu cầu một trong các phạm vi OAuth sau:

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ề việc xác thực.

CreateIndexRequest (Yêu cầu chỉ mục)

Yêu cầu cho FirestoreAdmin.CreateIndex.

Trường

parent

string

Tên gốc của biểu mẫu projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}

index

Index

Chỉ mục tổng hợp cần tạo.

Yêu cầu chỉ mục

Yêu cầu cho FirestoreAdmin.DeleteIndex.

Trường

Trường
`name`	`string` Tên biểu mẫu `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}`

name

string

Tên biểu mẫu projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}

Xuất siêu dữ liệu tài liệu

Siêu dữ liệu về google.longrunning.Operation kết quả từ FirestoreAdmin.ExportDocuments.

Trường
`start_time`	`Timestamp` Thời điểm bắt đầu hoạt động này.
`end_time`	`Timestamp` Thời gian hoạt động này hoàn tất. 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`	`OperationState` Trạng thái của hoạt động xuất.
`progress_documents`	`Progress` Tiến trình, trong tài liệu, của thao tác này.
`progress_bytes`	`Progress` Tiến trình, tính bằng byte, của thao tác này.
`collection_ids[]`	`string` Những mã bộ sưu tập nào đang được xuất.
`output_uri_prefix`	`string` Nơi các thực thể đang được xuất sang.

Xuất tài liệuRequest

Yêu cầu cho FirestoreAdmin.ExportDocuments.

Trường

Trường
`name`	`string` Cơ sở dữ liệu để xuất. Phải có dạng: `projects/{project_id}/databases/{database_id}`.
`collection_ids[]`	`string` Những mã nhận dạng bộ sưu tập cần xuất. Không xác định có nghĩa là tất cả các bộ sưu tập.
`output_uri_prefix`	`string` URI đầu ra. Hiện tại, chúng tôi chỉ hỗ trợ các URI của Google Cloud Storage ở dạng: `gs://BUCKET_NAME[/NAMESPACE_PATH]`, trong đó `BUCKET_NAME` là tên của bộ chứa Google Cloud Storage và `NAMESPACE_PATH` là một đường dẫn không gian tên không bắt buộc trên Google Cloud Storage. Khi chọn tên, hãy nhớ cân nhắc đến nguyên tắc đặt tên của Google Cloud Storage: https://cloud.google.com/storage/docs/naming. Nếu URI là một bộ chứa (không có đường dẫn không gian tên), thì một tiền tố sẽ được tạo dựa trên thời gian bắt đầu.

name

string

Cơ sở dữ liệu để xuất. Phải có dạng: projects/{project_id}/databases/{database_id}.

collection_ids[]

string

Những mã nhận dạng bộ sưu tập cần xuất. Không xác định có nghĩa là tất cả các bộ sưu tập.

output_uri_prefix

string

URI đầu ra. Hiện tại, chúng tôi chỉ hỗ trợ các URI của Google Cloud Storage ở dạng: gs://BUCKET_NAME[/NAMESPACE_PATH], trong đó BUCKET_NAME là tên của bộ chứa Google Cloud Storage và NAMESPACE_PATH là một đường dẫn không gian tên không bắt buộc trên Google Cloud Storage. Khi chọn tên, hãy nhớ cân nhắc đến nguyên tắc đặt tên của Google Cloud Storage: https://cloud.google.com/storage/docs/naming. Nếu URI là một bộ chứa (không có đường dẫn không gian tên), thì một tiền tố sẽ được tạo dựa trên thời gian bắt đầu.

Xuất văn bản phản hồi

Được trả về trong trường phản hồi google.longrunning.Operation.

Trường

Trường
`output_uri_prefix`	`string` Vị trí của các tệp đầu ra. Bạn có thể dùng tính năng này để bắt đầu nhập dữ liệu vào Cloud Firestore (dự án này hoặc một dự án khác) sau khi thao tác này hoàn tất thành công.

output_uri_prefix

string

Vị trí của các tệp đầu ra. Bạn có thể dùng tính năng này để bắt đầu nhập dữ liệu vào Cloud Firestore (dự án này hoặc một dự án khác) sau khi thao tác này hoàn tất thành công.

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 bộ sưu tập" tương ứng. Nhóm này đại diện cho tất cả các bộ sưu tập trong cơ sở dữ liệu có cùng mã nhận dạng.

Trường

Trường
`name`	`string` Tên trường của biểu mẫu `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}` Đường dẫn trường có thể là một tên trường đơn giản, ví dụ: `address` hoặc một đường dẫn đến các trường trong map_value , 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 trường bất kỳ. Bạn có thể trích dẫn các đường dẫn trường bằng cách 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ư các ký tự tượng trưng trong bảng mã ASCII. Ví dụ: (Lưu ý: Nhận xét ở đây được viết theo cú pháp Markdown, do đó, có thêm một lớp dấu phẩy ngược để thể hiện khối mã) `\`address.city``represents a field named`address.city`, not the map key`city`in the field`address`.````represents a field named``, không phải bất kỳ trường nào. Một `Field` đặc biệt chứa các chế độ cài đặt lập chỉ mục mặc định cho mọi trường. Tên tài nguyên của trường này là: `projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/*` Chỉ mục được xác định trên `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.
`index_config`	`IndexConfig` Cấu hình chỉ mục cho trường này. Nếu bạn không đặt chính sách này, việc lập chỉ mục trường sẽ chuyển về cấu hình do `ancestor_field` 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.

name

string

Tên trường của biểu mẫu projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}

Đường dẫn trường có thể là một tên trường đơn giản, ví dụ: address hoặc một đường dẫn đến các trường trong map_value , 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 trường bất kỳ.

Bạn có thể trích dẫn các đường dẫn trường bằng cách 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ư các ký tự tượng trưng trong bảng mã ASCII.

Ví dụ: (Lưu ý: Nhận xét ở đây được viết theo cú pháp Markdown, do đó, có thêm một lớp dấu phẩy ngược để thể hiện khối mã) \address.city`represents a field namedaddress.city, not the map keycityin the fieldaddress.`*`represents a field named*`, không phải bất kỳ trường nào.

Một Field đặc biệt chứa các chế độ cài đặt lập chỉ mục mặc định cho mọi trường. Tên tài nguyên của trường này là: projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/* Chỉ mục được xác định trên 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.

index_config

IndexConfig

Cấu hình chỉ mục cho trường này. Nếu bạn không đặt chính sách này, việc lập chỉ mục trường sẽ chuyển về cấu hình do ancestor_field 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.

Cấu hình chỉ mục

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

Trường
`indexes[]`	`Index` Các chỉ mục được hỗ trợ cho trường này.
`uses_ancestor_config`	`bool` Chỉ có đầu ra. Nếu đúng, cấu hình chỉ mục của `Field` được đặt từ cấu hình do `ancestor_field` chỉ định. Khi đặt là false, cấu hình chỉ mục của `Field` sẽ được xác định rõ ràng.
`ancestor_field`	`string` Chỉ có đầu ra. Chỉ định tên tài nguyên của `Field` mà từ đó cấu hình chỉ mục của trường này được đặt (khi `uses_ancestor_config` là true) hoặc từ đó sẽ được đặt nếu trường này không có cấu hình chỉ mục (khi `uses_ancestor_config` là false).
`reverting`	`bool` Chỉ đầu ra Khi đú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 `ancestor_field` chỉ định, khi đó `uses_ancestor_config` sẽ là `true` và `reverting` sẽ là `false`.

Siêu dữ liệu thực địa

Siêu dữ liệu về google.longrunning.Operation kết quả từ FirestoreAdmin.UpdateField.

Trường
`start_time`	`Timestamp` Thời điểm bắt đầu hoạt động này.
`end_time`	`Timestamp` Thời gian hoạt động này hoàn tất. Giá trị này sẽ không được đặt nếu bạn vẫn đang thực hiện thao tác.
`field`	`string` Tài nguyên trường mà thao tác này đang thực hiện. Ví dụ: `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}`
`index_config_deltas[]`	`IndexConfigDelta` Danh sách `IndexConfigDelta` mô tả ý định của thao tác này.
`state`	`OperationState` Trạng thái của hoạt động.
`document_progress`	`Progress` Tiến trình, trong tài liệu, của thao tác này.
`bytes_progress`	`Progress` Tiến trình, tính bằng byte, của thao tác này.

IndexConfigDelta

Thông tin về việc thay đổi cấu hình chỉ mục.

Trường

change_type

ChangeType

Chỉ định cách chỉ mục thay đổi.

index

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 xác định.
`ADD`	Đang thêm chỉ mục trường duy nhất.
`REMOVE`	Chỉ mục trường duy nhất sẽ bị xoá.

Yêu cầu trường

Yêu cầu cho FirestoreAdmin.GetField.

Trường

Trường
`name`	`string` Tên biểu mẫu `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_id}`

name

string

Tên biểu mẫu projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_id}

GetIndexRequest (Yêu cầu chỉ mục)

Yêu cầu cho FirestoreAdmin.GetIndex.

Trường

Trường
`name`	`string` Tên biểu mẫu `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}`

name

string

Tên biểu mẫu projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}

Siêu dữ liệu ImportDocuments

Siêu dữ liệu về google.longrunning.Operation kết quả từ FirestoreAdmin.ImportDocuments.

Trường
`start_time`	`Timestamp` Thời điểm bắt đầu hoạt động này.
`end_time`	`Timestamp` Thời gian hoạt động này hoàn tất. 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`	`OperationState` Trạng thái của thao tác nhập.
`progress_documents`	`Progress` Tiến trình, trong tài liệu, của thao tác này.
`progress_bytes`	`Progress` Tiến trình, tính bằng byte, của thao tác này.
`collection_ids[]`	`string` Các mã bộ sưu tập đang được nhập.
`input_uri_prefix`	`string` Vị trí của tài liệu đang được nhập.

Nhập tài liệu yêu cầu

Yêu cầu cho FirestoreAdmin.ImportDocuments.

Trường

Trường
`name`	`string` Cơ sở dữ liệu để nhập vào. Phải có dạng: `projects/{project_id}/databases/{database_id}`.
`collection_ids[]`	`string` Mã bộ sưu tập cần nhập. Chưa xác định có nghĩa là tất cả các tập hợp được đưa vào quá trình nhập.
`input_uri_prefix`	`string` 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 một ExportDocumentsResponse trong một tệp xuất đã hoàn tất. Hãy xem: `google.firestore.admin.v1beta2.ExportDocumentsResponse.output_uri_prefix`.

name

string

Cơ sở dữ liệu để nhập vào. Phải có dạng: projects/{project_id}/databases/{database_id}.

collection_ids[]

string

Mã bộ sưu tập cần nhập. Chưa xác định có nghĩa là tất cả các tập hợp được đưa vào quá trình nhập.

input_uri_prefix

string

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 một ExportDocumentsResponse trong một tệp xuất đã hoàn tất. Hãy xem: google.firestore.admin.v1beta2.ExportDocumentsResponse.output_uri_prefix.

Chỉ mục

Chỉ mục trên Cloud Firestore cho phép thực hiện các truy vấn đơn giản và phức tạp dựa trên các tài liệu trong cơ sở dữ liệu.

Trường
`name`	`string` Chỉ có đầu ra. Tên do máy chủ xác định cho chỉ mục này. Dạng thức của tên này cho các chỉ mục kết hợp sẽ là: `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{composite_index_id}` Đối với các chỉ mục trường đơn, trường này sẽ trống.
`query_scope`	`QueryScope` Các 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 tập hợp là con của tài liệu cụ thể, được chỉ định tại thời điểm truy vấn và có cùng mã nhận dạng tập hợp. Các chỉ mục có phạm vi truy vấn nhóm tập hợp được chỉ định cho phép truy vấn đối với tất cả các tập hợp 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ã nhận dạng tập hợp với chỉ mục này.
`fields[]`	`IndexField` Các trường mà chỉ mục này hỗ trợ. Đối với chỉ mục tổng hợp, đây luôn là 2 trường trở lên. Mục nhập trường cuối cùng luôn dành cho đường dẫn trường `__name__`. Nếu khi tạo, `__name__` không được chỉ định làm trường cuối cùng, thì trường này sẽ tự động được thêm theo cùng hướng với trường cuối cùng được xác định. Nếu trường cuối cùng trong một chỉ mục tổng hợp không có hướng, `__name__` sẽ được sắp xếp theo thứ tự TĂNG CƯỜNG (trừ phi có chỉ định rõ ràng). Đối với các chỉ mục trường đơn, đây sẽ luôn là chính xác một mục nhập có đường dẫn trường bằng đường dẫn trường của trường được liên kết.
`state`	`State` Chỉ có đầu ra. Trạng thái phân phát của 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, value_mode mô tả cách giá trị của trường được lập chỉ mục.

Trường
`field_path`	`string` Có thể là name. Đối với các chỉ mục trường đơn, tên này phải khớp với tên của trường, nếu không thì chỉ mục có thể bị bỏ qua.
Trường kết 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 đây:
`order`	`Order` Cho biết trường này hỗ trợ sắp xếp thứ tự theo đơn đặt hàng đã chỉ định hoặc so sánh bằng =, <, <=, >, >=.
`array_config`	`ArrayConfig` Cho biết rằng trường này hỗ trợ các thao tác trên `array_value`.

ArrayConfig

Các cấu hình giá trị mảng được hỗ trợ.

Enum
`ARRAY_CONFIG_UNSPECIFIED`	Chỉ mục không hỗ trợ truy vấn mảng bổ sung.
`CONTAINS`	Chỉ mục hỗ trợ các truy vấn về vùng chứa mảng.

Gọi món

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ị trường tăng dần.
`DESCENDING`	Trường này được sắp xếp theo giá trị trường giảm dần.

Phạm vi truy vấn

Phạm vi truy vấn xác định phạm vi chạy truy vấn. Thông tin này được chỉ định trên trường from của CompositionQuery.

Enum
`QUERY_SCOPE_UNSPECIFIED`	Phạm vi truy vấn chưa được xác định. Không phải là lựa chọn hợp lệ.
`COLLECTION`	Các 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 tập hợp 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ã nhận dạng tập hợ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 cho phép truy vấn dựa vào tất cả các bộ sưu tập có id bộ sưu tập do chỉ mục chỉ định.

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 việc tạo chỉ mục gặp sự cố, chỉ mục sẽ chuyển sang trạng thái NEEDS_REPAIR.

Enum
`STATE_UNSPECIFIED`	Bạn chưa xác định trạng thái.
`CREATING`	Chỉ mục đang được tạo. Chỉ mục có một hoạt động diễn ra trong thời gian dài. Chỉ mục được cập nhật khi viết tài liệu. Có thể tồn tại một số dữ liệu về chỉ mục.
`READY`	Chỉ mục đã sẵn sàng để sử dụng. Chỉ mục được cập nhật khi viết tài liệu. Chỉ mục được điền đầy đủ từ mọi tài liệu được lưu trữ có áp dụng nó.
`NEEDS_REPAIR`	Đang tạo chỉ mục nhưng đã xảy ra lỗi. Không có hoạt động dài hạn nào đang hoạt động cho chỉ mục và thao tác chạy trong thời gian dài được hoàn thành gần đây nhất cũng không thành công. Chỉ mục không được cập nhật khi viết tài liệu. Có thể tồn tại một số dữ liệu về chỉ mục. Hãy sử dụng google.longRunning.Operations API để xác định nguyên nhân khiến thao tác gần đây nhất cố gắng tạo chỉ mục này không thành công, sau đó tạo lại chỉ mục.

Siêu dữ liệu IndexOperation

Siêu dữ liệu về google.longrunning.Operation kết quả từ FirestoreAdmin.CreateIndex.

Trường
`start_time`	`Timestamp` Thời điểm bắt đầu hoạt động này.
`end_time`	`Timestamp` Thời gian hoạt động này hoàn tất. Giá trị này sẽ không được đặt nếu bạn vẫn đang thực hiện thao tác.
`index`	`string` Tài nguyên chỉ mục mà thao tác này đang thực hiện. Ví dụ: `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}`
`state`	`OperationState` Trạng thái của hoạt động.
`progress_documents`	`Progress` Tiến trình, trong tài liệu, của thao tác này.
`progress_bytes`	`Progress` Tiến trình, tính bằng byte, của thao tác này.

Yêu cầu các trường danh sách

Yêu cầu cho FirestoreAdmin.ListFields.

Trường
`parent`	`string` Tên gốc của biểu mẫu `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}`
`filter`	`string` Bộ lọc để áp dụng cho kết quả dạng danh sách. Hiện tại, `FirestoreAdmin.ListFields` chỉ hỗ trợ các trường danh sách đã bị ghi đè rõ ràng. Để đưa ra truy vấn này, hãy gọi `FirestoreAdmin.ListFields` với bộ lọc được đặt thành `indexConfig.usesAncestorConfig:false`.
`page_size`	`int32` Số lượng kết quả cần trả về.
`page_token`	`string` Mã thông báo trang (được trả về từ lệnh gọi trước đó đến `FirestoreAdmin.ListFields`) có thể được dùng để nhận trang kết quả tiếp theo.

Phản hồi ListFields

Phản hồi cho FirestoreAdmin.ListFields.

Trường

Trường
`fields[]`	`Field` Các trường bắt buộc.
`next_page_token`	`string` Mã thông báo trang có thể dùng để yêu cầu một trang kết quả khác. Nếu trống thì đây là trang cuối cùng.

fields[]

Field

Các trường bắt buộc.

next_page_token

string

Mã thông báo trang có thể dùng để yêu cầu một trang kết quả khác. Nếu trống thì đây là trang cuối cùng.

Yêu cầu chỉ mục danh sách

Yêu cầu cho FirestoreAdmin.ListIndexes.

Trường
`parent`	`string` Tên gốc của biểu mẫu `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}`
`filter`	`string` Bộ lọc để áp dụng cho kết quả dạng danh sách.
`page_size`	`int32` Số lượng kết quả cần trả về.
`page_token`	`string` Mã thông báo trang (được trả về từ lệnh gọi trước đó đến `FirestoreAdmin.ListIndexes`) có thể được dùng để nhận trang kết quả tiếp theo.

Phản hồi ListIndexes

Phản hồi cho FirestoreAdmin.ListIndexes.

Trường

Trường
`indexes[]`	`Index` Các chỉ mục được yêu cầu.
`next_page_token`	`string` Mã thông báo trang có thể dùng để yêu cầu một trang kết quả khác. Nếu trống thì đây là trang cuối cùng.

indexes[]

Index

Các chỉ mục được yêu cầu.

next_page_token

string

Mã thông báo trang có thể dùng để yêu cầu một trang kết quả khác. Nếu trống thì đây là trang cuối cùng.

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 bị huỷ sau khi người dùng đã gọi google.longruntime.Operations.CancelOperation.
`FINALIZING`	Yêu cầu đã được xử lý và đang trong giai đoạn kết thúc.
`SUCCESSFUL`	Yêu cầu đã hoàn tất thành công.
`FAILED`	Yêu cầu đã hoàn tất được xử lý nhưng gặp lỗi.
`CANCELLED`	Yêu cầu đã bị huỷ sau khi người dùng đã gọi google.longRunning.Operations.CancelOperation.

Tiến trình

Mô tả tiến trình của thao tác. Đơn vị công việc mang tính chung chung và phải được diễn giải dựa vào trường hợp sử dụng Progress.

Trường

Trường
`estimated_work`	`int64` Lượng công việc đã ước tính.
`completed_work`	`int64` Lượng công việc đã hoàn tất.

estimated_work

int64

Lượng công việc đã ước tính.

completed_work

int64

Lượng công việc đã hoàn tất.

Yêu cầu cập nhật trường

Yêu cầu cho FirestoreAdmin.UpdateField.

Trường

Trường
`field`	`Field` Trường cần cập nhật.
`update_mask`	`FieldMask` Một mặt nạ, so với trường. Nếu bạn chỉ định, chỉ cấu hình do trường này chỉ định mới được cập nhật trong trường.

field

Field

Trường cần cập nhật.

update_mask

FieldMask

Một mặt nạ, so với trường. Nếu bạn chỉ định, chỉ cấu hình do trường này chỉ định mới được cập nhật trong trường.