Indeks
FirestoreAdmin
(antar muka)Backup
(pesan)Backup.State
(enum)BackupSchedule
(pesan)CreateBackupScheduleRequest
(pesan)CreateDatabaseMetadata
(pesan)CreateDatabaseRequest
(pesan)CreateIndexRequest
(pesan)DailyRecurrence
(pesan)Database
(pesan)Database.AppEngineIntegrationMode
(enum)Database.ConcurrencyMode
(enum)Database.DatabaseType
(enum)Database.DeleteProtectionState
(enum)Database.PointInTimeRecoveryEnablement
(enum)DeleteBackupRequest
(pesan)DeleteBackupScheduleRequest
(pesan)DeleteDatabaseMetadata
(pesan)DeleteDatabaseRequest
(pesan)DeleteIndexRequest
(pesan)ExportDocumentsMetadata
(pesan)ExportDocumentsRequest
(pesan)ExportDocumentsResponse
(pesan)Field
(pesan)Field.IndexConfig
(pesan)Field.TtlConfig
(pesan)Field.TtlConfig.State
(enum)FieldOperationMetadata
(pesan)FieldOperationMetadata.IndexConfigDelta
(pesan)FieldOperationMetadata.IndexConfigDelta.ChangeType
(enum)FieldOperationMetadata.TtlConfigDelta
(pesan)FieldOperationMetadata.TtlConfigDelta.ChangeType
(enum)GetBackupRequest
(pesan)GetBackupScheduleRequest
(pesan)GetDatabaseRequest
(pesan)GetFieldRequest
(pesan)GetIndexRequest
(pesan)ImportDocumentsMetadata
(pesan)ImportDocumentsRequest
(pesan)Index
(pesan)Index.ApiScope
(enum)Index.IndexField
(pesan)Index.IndexField.ArrayConfig
(enum)Index.IndexField.Order
(enum)Index.QueryScope
(enum)Index.State
(enum)IndexOperationMetadata
(pesan)ListBackupSchedulesRequest
(pesan)ListBackupSchedulesResponse
(pesan)ListBackupsRequest
(pesan)ListBackupsResponse
(pesan)ListDatabasesRequest
(pesan)ListDatabasesResponse
(pesan)ListFieldsRequest
(pesan)ListFieldsResponse
(pesan)ListIndexesRequest
(pesan)ListIndexesResponse
(pesan)LocationMetadata
(pesan)OperationState
(enum)Progress
(pesan)RestoreDatabaseMetadata
(pesan)RestoreDatabaseRequest
(pesan)UpdateBackupScheduleRequest
(pesan)UpdateDatabaseMetadata
(pesan)UpdateDatabaseRequest
(pesan)UpdateFieldRequest
(pesan)WeeklyRecurrence
(pesan)
FirestoreAdmin
Cloud Firestore Admin API.
API ini menyediakan beberapa layanan administratif untuk Cloud Firestore.
Project, Database, Namespace, Collection, Collection Group, dan Dokumen digunakan seperti yang ditentukan dalam Google Cloud Firestore API.
Operasi: Operasi mewakili pekerjaan yang sedang dilakukan di latar belakang.
Layanan indeks mengelola indeks Cloud Firestore.
Pembuatan indeks dilakukan secara asinkron. Resource Operation dibuat untuk setiap operasi asinkron tersebut. Status operasi (termasuk error yang ditemukan) dapat dikueri melalui resource Operation.
Kumpulan Operasi menyediakan catatan tindakan yang dilakukan untuk Project yang ditentukan (termasuk Operasi apa pun yang sedang berlangsung). Operasi tidak dibuat secara langsung, tetapi melalui panggilan pada koleksi atau resource lain.
Operasi yang telah selesai dapat dihapus sehingga tidak lagi terdaftar sebagai bagian dari kumpulan Operasi. Operasi akan membersihkan sampah memori setelah 30 hari. Secara default, ListOperations hanya akan menampilkan operasi yang sedang berlangsung dan gagal. Untuk mencantumkan operasi yang telah selesai, berikan permintaan ListOperations dengan filter done: true
.
Operasi dibuat oleh layanan FirestoreAdmin
, tetapi diakses melalui layanan google.longrunning.Operations
.
CreateBackupSchedule |
---|
Membuat jadwal pencadangan di database. Maksimal dua jadwal pencadangan dapat dikonfigurasi pada database, satu jadwal pencadangan harian dengan retensi hingga 7 hari, dan satu jadwal pencadangan mingguan dengan retensi hingga 14 minggu.
|
CreateDatabase |
---|
Membuat database.
|
CreateIndex |
---|
Membuat indeks komposit. Tindakan ini akan menampilkan
|
DeleteBackup |
---|
Menghapus cadangan.
|
DeleteBackupSchedule |
---|
Menghapus jadwal pencadangan.
|
DeleteDatabase |
---|
Menghapus database.
|
DeleteIndex |
---|
Menghapus indeks komposit.
|
ExportDocuments |
---|
Mengekspor salinan semua atau sebagian dokumen dari Google Cloud Firestore ke sistem penyimpanan lain, seperti Google Cloud Storage. Perubahan terbaru pada dokumen mungkin tidak ditampilkan dalam ekspor. Ekspor terjadi di latar belakang dan progresnya dapat dipantau serta dikelola melalui resource Operation yang dibuat. Output ekspor hanya dapat digunakan setelah operasi yang terkait selesai. Jika operasi ekspor dibatalkan sebelum selesai, sebagian data mungkin akan tertinggal di Google Cloud Storage. Untuk detail selengkapnya tentang perilaku ekspor dan format output, lihat: https://cloud.google.com/firestore/docs/manage-data/export-import
|
GetBackup |
---|
Mendapatkan informasi tentang cadangan.
|
GetBackupSchedule |
---|
Mendapatkan informasi tentang jadwal pencadangan.
|
GetDatabase |
---|
Mendapatkan informasi tentang database.
|
GetField |
---|
Mendapatkan metadata dan konfigurasi untuk Kolom.
|
GetIndex |
---|
Mendapatkan indeks komposit.
|
ImportDocuments |
---|
Mengimpor dokumen ke Google Cloud Firestore. Dokumen yang ada dengan nama yang sama akan ditimpa. Impor terjadi di latar belakang dan progresnya dapat dipantau serta dikelola melalui resource Operation yang dibuat. Jika operasi ImportDocuments dibatalkan, ada kemungkinan sebagian data telah diimpor ke Cloud Firestore.
|
ListBackupSchedules |
---|
Mencantumkan jadwal pencadangan.
|
ListBackups |
---|
Mencantumkan semua cadangan.
|
ListDatabases |
---|
Membuat daftar semua database dalam project.
|
ListFields |
---|
Mencantumkan konfigurasi kolom dan metadata untuk database ini. Saat ini,
|
ListIndexes |
---|
Mencantumkan indeks komposit.
|
RestoreDatabase |
---|
Membuat database baru dengan memulihkan dari cadangan yang ada. Database baru harus berada di region cloud atau lokasi multi-region yang sama dengan cadangan yang ada. Perilaku ini mirip dengan [FirestoreAdmin.CreateDatabase][google.firestore.admin.v1.CreateDatabase], tetapi bukannya membuat database baru yang kosong, database baru dibuat dengan jenis database, konfigurasi indeks, dan dokumen dari cadangan yang ada.
|
UpdateBackupSchedule |
---|
Memperbarui jadwal pencadangan.
|
UpdateDatabase |
---|
Memperbarui database.
|
UpdateField |
---|
Memperbarui konfigurasi kolom. Saat ini, pembaruan kolom hanya berlaku untuk konfigurasi indeks kolom tunggal. Namun, panggilan ke Panggilan ini menampilkan Untuk mengonfigurasi setelan kolom default untuk database, gunakan
|
Pencadangan
Cadangan Database Cloud Firestore.
Cadangan berisi semua dokumen dan konfigurasi indeks untuk database tertentu pada titik waktu tertentu.
Kolom | |
---|---|
name |
Hanya output. Nama resource unik Cadangan. Formatnya adalah |
database |
Hanya output. Nama database Firestore tempat cadangan berasal. Formatnya adalah |
database_uid |
Hanya output. UUID4 yang dihasilkan sistem untuk database Firestore tempat cadangan berasal. |
snapshot_time |
Hanya output. Cadangan berisi salinan database yang konsisten secara eksternal saat ini. |
expire_time |
Hanya output. Stempel waktu saat pencadangan ini berakhir masa berlakunya. |
state |
Hanya output. Status cadangan saat ini. |
Negara Bagian
Menunjukkan status pencadangan saat ini.
Enum | |
---|---|
STATE_UNSPECIFIED |
Status tidak ditentukan. |
CREATING |
Cadangan yang tertunda masih dibuat. Operasi pada cadangan akan ditolak dalam status ini. |
READY |
Pencadangan selesai dan siap digunakan. |
NOT_AVAILABLE |
Cadangan tidak tersedia untuk saat ini. |
BackupSchedule
Jadwal cadangan untuk Database Cloud Firestore.
Resource ini dimiliki oleh database yang dicadangkannya, dan dihapus bersama databasenya. Cadangan yang sebenarnya tidaklah demikian.
Kolom | |
---|---|
name |
Hanya output. ID jadwal pencadangan unik di semua lokasi dan database untuk project tertentu. Opsi ini akan ditetapkan secara otomatis. Formatnya adalah |
create_time |
Hanya output. Stempel waktu saat jadwal pencadangan ini dibuat dan berlaku sejak saat itu. Tidak ada cadangan yang akan dibuat untuk jadwal ini sebelum waktu ini. |
update_time |
Hanya output. Stempel waktu pada jadwal pencadangan ini terakhir diperbarui. Saat jadwal cadangan pertama kali dibuat, ini sama dengan create_time. |
retention |
Pada waktu yang relatif di masa mendatang, dibandingkan dengan waktu pembuatannya, cadangan harus dihapus, mis. simpan cadangan selama 7 hari. |
Kolom union recurrence . Kolom oneof untuk menunjukkan kapan cadangan akan diambil. recurrence hanya ada berupa salah satu diantara berikut: |
|
daily_recurrence |
Untuk jadwal yang berjalan setiap hari. |
weekly_recurrence |
Untuk jadwal yang berjalan setiap minggu pada hari tertentu. |
CreateBackupScheduleRequest
Permintaan untuk FirestoreAdmin.CreateBackupSchedule
.
Kolom | |
---|---|
parent |
Wajib. Database induk. Format |
backup_schedule |
Wajib. Jadwal cadangan yang akan dibuat. |
CreateDatabaseMetadata
Jenis ini tidak memiliki kolom.
Metadata yang terkait dengan operasi pembuatan database.
CreateDatabaseRequest
Permintaan untuk FirestoreAdmin.CreateDatabase
.
Kolom | |
---|---|
parent |
Wajib. Nama induk dari formulir |
database |
Wajib. Database yang akan dibuat. |
database_id |
Wajib. ID yang akan digunakan untuk database, yang akan menjadi komponen akhir dari nama resource database. Nilai ini harus terdiri dari 4-63 karakter. Karakter yang valid adalah /[a-z][0-9]-/ dengan karakter pertama huruf dan huruf terakhir atau angka. Tidak boleh berbentuk UUID /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/. ID database "(default)" juga valid. |
CreateIndexRequest
Permintaan untuk FirestoreAdmin.CreateIndex
.
Kolom | |
---|---|
parent |
Wajib. Nama induk dari formulir |
index |
Wajib. Indeks komposit yang akan dibuat. |
DailyRecurrence
Jenis ini tidak memiliki kolom.
Mewakili jadwal berulang yang berjalan pada waktu tertentu setiap hari.
Zona waktu menggunakan UTC.
Database
Database Cloud Firestore.
Kolom | |
---|---|
name |
Nama resource Database. Format: |
uid |
Hanya output. UUID4 yang dihasilkan sistem untuk Database ini. |
create_time |
Hanya output. Stempel waktu pembuatan database ini. Database yang dibuat sebelum 2016 tidak mengisi create_time. |
update_time |
Hanya output. Stempel waktu saat database ini terakhir diperbarui. Perhatikan bahwa ini hanya mencakup pembaruan pada resource database dan bukan data yang terdapat dalam database. |
location_id |
Lokasi database. Lokasi yang tersedia tercantum di https://cloud.google.com/firestore/docs/locations. |
type |
Jenis database. Lihat https://cloud.google.com/datastore/docs/firestore-or-datastore untuk informasi tentang cara memilih. |
concurrency_mode |
Mode kontrol konkurensi yang akan digunakan untuk database ini. |
version_retention_period |
Hanya output. Periode saat versi data sebelumnya disimpan dalam database. Semua Jika fitur PITR diaktifkan, periode retensi data adalah 7 hari. Jika tidak, periode retensi data adalah 1 jam. |
earliest_version_time |
Hanya output. Stempel waktu paling awal saat versi data lama dapat dibaca dari database. Lihat [version_retention_period] di atas; kolom ini diisi dengan Nilai ini terus-menerus diperbarui, dan menjadi tidak berlaku saat dikueri. Jika Anda menggunakan nilai ini untuk memulihkan data, pastikan untuk memperhitungkan waktu dari saat nilai dikueri hingga saat Anda memulai pemulihan. |
point_in_time_recovery_enablement |
Apakah akan mengaktifkan fitur PITR pada database ini. |
app_engine_integration_mode |
Mode integrasi App Engine yang akan digunakan untuk database ini. |
key_prefix |
Hanya output. Key_prefix untuk database ini. key_prefix ini digunakan, bersama dengan ID project (" Nilai ini mungkin kosong, dalam hal ini appid yang akan digunakan untuk kunci yang dienkode ke URL adalah project_id (misalnya: foo, bukan v~foo). |
delete_protection_state |
Status perlindungan penghapusan untuk database. |
etag |
Checksum ini dihitung oleh server berdasarkan nilai kolom lain, dan dapat dikirim pada saat permintaan update dan penghapusan untuk memastikan klien memiliki nilai terbaru sebelum melanjutkan. |
AppEngineIntegrationMode
Jenis mode integrasi App Engine.
Enum | |
---|---|
APP_ENGINE_INTEGRATION_MODE_UNSPECIFIED |
Tidak digunakan. |
ENABLED |
Jika aplikasi App Engine ada di region yang sama dengan database ini, konfigurasi App Engine akan memengaruhi database ini. Hal ini termasuk menonaktifkan aplikasi & database, serta menonaktifkan penulisan ke database. |
DISABLED |
App Engine tidak berpengaruh pada kemampuan database ini untuk melayani permintaan. Ini adalah setelan default untuk database yang dibuat dengan Firestore API. |
ConcurrencyMode
Jenis mode kontrol serentak untuk transaksi.
Enum | |
---|---|
CONCURRENCY_MODE_UNSPECIFIED |
Tidak digunakan. |
OPTIMISTIC |
Gunakan kontrol konkurensi optimis secara default. Mode ini tersedia untuk database Cloud Firestore. |
PESSIMISTIC |
Gunakan kontrol konkurensi pesimis secara default. Mode ini tersedia untuk database Cloud Firestore. Ini adalah setelan default untuk Cloud Firestore. |
OPTIMISTIC_WITH_ENTITY_GROUPS |
Gunakan kontrol konkurensi optimis dengan grup entitas secara default. Mode ini adalah satu-satunya mode yang tersedia untuk Cloud Datastore. Mode ini juga tersedia untuk Cloud Firestore dengan Mode Datastore, tetapi tidak direkomendasikan. |
DatabaseType
Jenis database. Lihat https://cloud.google.com/datastore/docs/firestore-or-datastore untuk informasi tentang cara memilih.
Perubahan mode hanya diizinkan jika database kosong.
Enum | |
---|---|
DATABASE_TYPE_UNSPECIFIED |
Nilai default. Nilai ini digunakan jika jenis database dihilangkan. |
FIRESTORE_NATIVE |
Mode Native Firestore |
DATASTORE_MODE |
Firestore dalam Mode Datastore. |
DeleteProtectionState
Status perlindungan penghapusan database.
Enum | |
---|---|
DELETE_PROTECTION_STATE_UNSPECIFIED |
Nilai default. Jenis perlindungan penghapusan tidak ditentukan |
DELETE_PROTECTION_DISABLED |
Perlindungan penghapusan dinonaktifkan |
DELETE_PROTECTION_ENABLED |
Perlindungan penghapusan diaktifkan |
PointInTimeRecoveryEnablement
Pengaktifan fitur Pemulihan Point In Time.
Enum | |
---|---|
POINT_IN_TIME_RECOVERY_ENABLEMENT_UNSPECIFIED |
Tidak digunakan. |
POINT_IN_TIME_RECOVERY_ENABLED |
Operasi baca didukung di versi data yang dipilih dalam 7 hari terakhir:
|
POINT_IN_TIME_RECOVERY_DISABLED |
Operasi baca didukung pada semua versi data dari dalam 1 jam terakhir. |
DeleteBackupRequest
Permintaan untuk FirestoreAdmin.DeleteBackup
.
Kolom | |
---|---|
name |
Wajib. Nama cadangan yang akan dihapus. adalah |
DeleteBackupScheduleRequest
Permintaan untuk [FirestoreAdmin.DeleteBackupSchedules][].
Kolom | |
---|---|
name |
Wajib. Nama jadwal pencadangan. Format |
DeleteDatabaseMetadata
Jenis ini tidak memiliki kolom.
Metadata yang terkait dengan operasi penghapusan database.
DeleteDatabaseRequest
Permintaan untuk FirestoreAdmin.DeleteDatabase
.
Kolom | |
---|---|
name |
Wajib. Nama formulir |
etag |
Etag Database saat ini. Jika etag diberikan dan tidak cocok dengan etag database saat ini, penghapusan akan diblokir dan error FAILED_PRECONDITION akan ditampilkan. |
DeleteIndexRequest
Permintaan untuk FirestoreAdmin.DeleteIndex
.
Kolom | |
---|---|
name |
Wajib. Nama formulir |
ExportDocumentsMetadata
Metadata untuk google.longrunning.Operation
hasil dari FirestoreAdmin.ExportDocuments
.
Kolom | |
---|---|
start_time |
Waktu operasi ini dimulai. |
end_time |
Waktu operasi ini selesai. Akan dibatalkan penetapannya jika operasi masih berlangsung. |
operation_state |
Status operasi ekspor. |
progress_documents |
Progres operasi ini, dalam dokumen. |
progress_bytes |
Progres operasi ini, dalam byte. |
collection_ids[] |
ID koleksi yang diekspor. |
output_uri_prefix |
Tujuan ekspor dokumen. |
namespace_ids[] |
ID namespace mana yang diekspor. |
snapshot_time |
Stempel waktu yang sesuai dengan versi database yang diekspor. Jika tidak ditentukan, tidak ada jaminan terkait konsistensi dokumen yang diekspor. |
ExportDocumentsRequest
Permintaan untuk FirestoreAdmin.ExportDocuments
.
Kolom | |
---|---|
name |
Wajib. Database yang akan diekspor. Harus dalam bentuk: |
collection_ids[] |
ID koleksi yang akan diekspor. Tidak ditentukan berarti semua koleksi. |
output_uri_prefix |
URI output. Saat ini hanya mendukung URI Google Cloud Storage dalam bentuk: |
namespace_ids[] |
Daftar kosong mewakili semua namespace. Ini adalah penggunaan yang disarankan untuk database yang tidak menggunakan namespace. Elemen string kosong mewakili namespace default. Ini harus digunakan jika database memiliki data dalam namespace non-default, tetapi tidak ingin menyertakannya. Setiap namespace dalam daftar ini harus unik. |
snapshot_time |
Stempel waktu yang sesuai dengan versi database yang akan diekspor. Stempel waktu harus berada di masa lampau, dibulatkan ke menit, dan tidak lebih lama dari |
ExportDocumentsResponse
Ditampilkan di kolom respons google.longrunning.Operation
.
Kolom | |
---|---|
output_uri_prefix |
Lokasi file output. Ini dapat digunakan untuk memulai impor ke Cloud Firestore (project ini atau project lain) setelah operasi berhasil diselesaikan. |
Kolom
Menampilkan satu kolom dalam database.
Kolom dikelompokkan menurut "Grup Koleksi", yang mewakili semua koleksi dalam database dengan ID yang sama.
Kolom | |
---|---|
name |
Wajib. Nama kolom formulir Jalur kolom dapat berupa nama kolom sederhana, misalnya Jalur kolom dapat dikutip menggunakan Contoh: (Catatan: Komentar di sini ditulis dalam sintaksis markdown, sehingga ada lapisan tanda kutip terbalik tambahan untuk mewakili blok kode)
|
index_config |
Konfigurasi indeks untuk kolom ini. Jika tidak disetel, pengindeksan kolom akan dikembalikan ke konfigurasi yang ditentukan oleh |
ttl_config |
Konfigurasi TTL untuk |
IndexConfig
Konfigurasi indeks untuk kolom ini.
Kolom | |
---|---|
indexes[] |
Indeks yang didukung untuk kolom ini. |
uses_ancestor_config |
Hanya output. Jika benar, konfigurasi indeks |
ancestor_field |
Hanya output. Menentukan nama resource |
reverting |
Hanya output Saat benar, konfigurasi indeks |
TtlConfig
Konfigurasi TTL (time-to-live) untuk dokumen yang telah menetapkan Field
ini.
Penyimpanan nilai stempel waktu ke kolom yang mendukung TTL akan diperlakukan sebagai waktu habis masa berlaku absolut dokumen. Nilai stempel waktu di masa lalu menunjukkan bahwa dokumen memenuhi syarat untuk segera berakhir masa berlakunya. Menggunakan jenis data lainnya atau membiarkan kolom tidak ada akan menonaktifkan akhir masa berlaku untuk setiap dokumen.
Kolom | |
---|---|
state |
Hanya output. Status konfigurasi TTL. |
Negara Bagian
Status penerapan konfigurasi TTL ke semua dokumen.
Enum | |
---|---|
STATE_UNSPECIFIED |
Status tidak ditentukan atau tidak diketahui. |
CREATING |
TTL sedang diterapkan. Ada operasi aktif yang berjalan lama untuk melacak perubahan. Dokumen yang baru ditulis akan memiliki TTL yang diterapkan sesuai permintaan. TTL yang diminta pada dokumen yang ada masih diproses. Ketika TTL pada semua dokumen yang ada telah diproses, status akan dipindahkan ke 'ACTIVE'. |
ACTIVE |
TTL aktif untuk semua dokumen. |
NEEDS_REPAIR |
Konfigurasi TTL tidak dapat diaktifkan untuk semua dokumen yang ada. Dokumen yang baru ditulis akan tetap menerapkan TTL. LRO yang ditampilkan saat terakhir kali mencoba mengaktifkan TTL untuk Field ini gagal, dan mungkin memiliki detail selengkapnya. |
FieldOperationMetadata
Metadata untuk google.longrunning.Operation
hasil dari FirestoreAdmin.UpdateField
.
Kolom | |
---|---|
start_time |
Waktu operasi ini dimulai. |
end_time |
Waktu operasi ini selesai. Akan dibatalkan penetapannya jika operasi masih berlangsung. |
field |
Resource kolom yang ditindaklanjuti oleh operasi ini. Contoh: |
index_config_deltas[] |
Daftar |
state |
Status operasi. |
progress_documents |
Progres operasi ini, dalam dokumen. |
progress_bytes |
Progres operasi ini, dalam byte. |
ttl_config_delta |
Menjelaskan delta konfigurasi TTL. |
IndexConfigDelta
Informasi tentang perubahan konfigurasi indeks.
Kolom | |
---|---|
change_type |
Menentukan perubahan indeks. |
index |
Indeks sedang diubah. |
ChangeType
Menentukan perubahan indeks.
Enum | |
---|---|
CHANGE_TYPE_UNSPECIFIED |
Jenis perubahan tidak ditentukan atau diketahui. |
ADD |
Indeks kolom tunggal sedang ditambahkan. |
REMOVE |
Indeks kolom tunggal sedang dihapus. |
TtlConfigDelta
Informasi tentang perubahan konfigurasi TTL.
Kolom | |
---|---|
change_type |
Menentukan perubahan konfigurasi TTL. |
ChangeType
Menentukan perubahan konfigurasi TTL.
Enum | |
---|---|
CHANGE_TYPE_UNSPECIFIED |
Jenis perubahan tidak ditentukan atau diketahui. |
ADD |
Konfigurasi TTL sedang ditambahkan. |
REMOVE |
Konfigurasi TTL sedang dihapus. |
GetBackupRequest
Permintaan untuk FirestoreAdmin.GetBackup
.
Kolom | |
---|---|
name |
Wajib. Nama cadangan yang akan diambil. Formatnya adalah |
GetBackupScheduleRequest
Permintaan untuk FirestoreAdmin.GetBackupSchedule
.
Kolom | |
---|---|
name |
Wajib. Nama jadwal pencadangan. Format |
GetDatabaseRequest
Permintaan untuk FirestoreAdmin.GetDatabase
.
Kolom | |
---|---|
name |
Wajib. Nama formulir |
GetFieldRequest
Permintaan untuk FirestoreAdmin.GetField
.
Kolom | |
---|---|
name |
Wajib. Nama formulir |
GetIndexRequest
Permintaan untuk FirestoreAdmin.GetIndex
.
Kolom | |
---|---|
name |
Wajib. Nama formulir |
ImportDocumentsMetadata
Metadata untuk google.longrunning.Operation
hasil dari FirestoreAdmin.ImportDocuments
.
Kolom | |
---|---|
start_time |
Waktu operasi ini dimulai. |
end_time |
Waktu operasi ini selesai. Akan dibatalkan penetapannya jika operasi masih berlangsung. |
operation_state |
Status operasi impor. |
progress_documents |
Progres operasi ini, dalam dokumen. |
progress_bytes |
Progres operasi ini, dalam byte. |
collection_ids[] |
ID koleksi mana yang diimpor. |
input_uri_prefix |
Lokasi dokumen yang diimpor. |
namespace_ids[] |
ID namespace mana yang diimpor. |
ImportDocumentsRequest
Permintaan untuk FirestoreAdmin.ImportDocuments
.
Kolom | |
---|---|
name |
Wajib. Database yang akan diimpor. Harus dalam bentuk: |
collection_ids[] |
ID koleksi yang akan diimpor. Tidak ditentukan berarti semua koleksi yang disertakan dalam impor. |
input_uri_prefix |
Lokasi file yang diekspor. Nilai ini harus cocok dengan output_uri_prefix dari ExportDocumentsResponse dari ekspor yang telah berhasil diselesaikan. Lihat: |
namespace_ids[] |
Daftar kosong mewakili semua namespace. Ini adalah penggunaan yang disarankan untuk database yang tidak menggunakan namespace. Elemen string kosong mewakili namespace default. Ini harus digunakan jika database memiliki data dalam namespace non-default, tetapi tidak ingin menyertakannya. Setiap namespace dalam daftar ini harus unik. |
Indeks
Indeks Cloud Firestore memungkinkan kueri sederhana dan kompleks terhadap dokumen dalam database.
Kolom | |
---|---|
name |
Hanya output. Nama yang ditentukan server untuk indeks ini. Bentuk nama untuk indeks komposit ini adalah: |
query_scope |
Indeks dengan cakupan kueri koleksi yang ditentukan memungkinkan kueri terhadap koleksi yang merupakan turunan dokumen tertentu, ditentukan pada waktu kueri, dan yang memiliki ID koleksi yang sama. Indeks dengan cakupan kueri grup koleksi yang ditentukan memungkinkan kueri terhadap semua koleksi yang berasal dari dokumen tertentu, ditentukan pada waktu kueri, dan yang memiliki ID koleksi yang sama dengan indeks ini. |
api_scope |
Cakupan API yang didukung oleh indeks ini. |
fields[] |
Kolom yang didukung oleh indeks ini. Untuk indeks komposit, ini memerlukan minimal 2 kolom dan maksimal 100 kolom. Entri kolom terakhir selalu untuk jalur kolom Untuk indeks kolom tunggal, ini akan selalu tepat satu entri dengan jalur kolom yang sama dengan jalur kolom dari kolom terkait. |
state |
Hanya output. Status penayangan indeks. |
ApiScope
Cakupan API menentukan API (Firestore Native, atau Firestore dalam Mode Datastore) yang didukung untuk kueri.
Enum | |
---|---|
ANY_API |
Indeks hanya dapat digunakan oleh API kueri Native Firestore. Ini adalah defaultnya. |
DATASTORE_MODE_API |
Indeks hanya dapat digunakan oleh Firestore dalam API kueri Mode Datastore. |
IndexField
Kolom dalam indeks. Kolom_path menjelaskan kolom mana yang diindeks, value_mode menjelaskan cara nilai kolom diindeks.
Kolom | |
---|---|
field_path |
Dapat berupa name. Untuk indeks kolom tunggal, ini harus cocok dengan nama kolom atau dapat dihilangkan. |
Kolom union value_mode . Cara nilai kolom diindeks. value_mode hanya ada berupa salah satu diantara berikut: |
|
order |
Menunjukkan bahwa kolom ini mendukung pengurutan berdasarkan urutan yang ditentukan atau membandingkan menggunakan =, !=, <, <=, >, >=. |
array_config |
Menunjukkan bahwa kolom ini mendukung operasi pada |
ArrayConfig
Konfigurasi nilai array yang didukung.
Enum | |
---|---|
ARRAY_CONFIG_UNSPECIFIED |
Indeks tidak mendukung kueri array tambahan. |
CONTAINS |
Indeks mendukung kueri pembatasan array. |
Pesan
Pengurutan yang didukung.
Enum | |
---|---|
ORDER_UNSPECIFIED |
Urutan tidak ditentukan. Bukan opsi yang valid. |
ASCENDING |
Kolom ini diurutkan berdasarkan nilai kolom menaik. |
DESCENDING |
Kolom ini diurutkan berdasarkan nilai kolom menurun. |
QueryScope
Cakupan Kueri menentukan cakupan tempat kueri dijalankan. Ini ditentukan di kolom from
StructuredQuery.
Enum | |
---|---|
QUERY_SCOPE_UNSPECIFIED |
Cakupan kueri tidak ditentukan. Bukan opsi yang valid. |
COLLECTION |
Indeks dengan cakupan kueri koleksi yang ditentukan memungkinkan kueri terhadap koleksi yang merupakan turunan dokumen tertentu, ditentukan pada waktu kueri, dan yang memiliki ID koleksi yang ditentukan oleh indeks. |
COLLECTION_GROUP |
Indeks dengan cakupan kueri grup koleksi yang ditentukan memungkinkan kueri terhadap semua koleksi yang memiliki ID koleksi yang ditentukan oleh indeks. |
COLLECTION_RECURSIVE |
Menyertakan semua ancestor koleksi dalam indeks. Hanya tersedia untuk database Mode Datastore. |
Negara Bagian
Status indeks. Selama pembuatan indeks, indeks akan berada dalam status CREATING
. Jika berhasil dibuat, indeks akan beralih ke status READY
. Jika pembuatan indeks mengalami masalah, indeks akan bertransisi ke status NEEDS_REPAIR
.
Enum | |
---|---|
STATE_UNSPECIFIED |
Status tidak ditentukan. |
CREATING |
Indeks sedang dibuat. Ada operasi jangka panjang yang aktif untuk indeks. Indeks diperbarui saat menulis dokumen. Beberapa data indeks mungkin ada. |
READY |
Indeks siap digunakan. Indeks diperbarui saat menulis dokumen. Indeks terisi penuh dari semua dokumen tersimpan yang berlaku untuknya. |
NEEDS_REPAIR |
Indeks sedang dibuat, tetapi terjadi masalah. Tidak ada operasi jangka panjang yang aktif untuk indeks, dan operasi jangka panjang yang baru saja diselesaikan gagal. Indeks tidak diperbarui saat menulis dokumen. Beberapa data indeks mungkin ada. Gunakan google.longrunning.Operations API untuk mengetahui alasan kegagalan operasi yang terakhir kali mencoba membuat indeks ini, lalu buat ulang indeks. |
IndexOperationMetadata
Metadata untuk google.longrunning.Operation
hasil dari FirestoreAdmin.CreateIndex
.
Kolom | |
---|---|
start_time |
Waktu operasi ini dimulai. |
end_time |
Waktu operasi ini selesai. Akan dibatalkan penetapannya jika operasi masih berlangsung. |
index |
Resource indeks yang ditindaklanjuti oleh operasi ini. Contoh: |
state |
Status operasi. |
progress_documents |
Progres operasi ini, dalam dokumen. |
progress_bytes |
Progres operasi ini, dalam byte. |
ListBackupSchedulesRequest
Permintaan untuk FirestoreAdmin.ListBackupSchedules
.
Kolom | |
---|---|
parent |
Wajib. Database induk. Formatnya adalah |
ListBackupSchedulesResponse
Respons untuk FirestoreAdmin.ListBackupSchedules
.
Kolom | |
---|---|
backup_schedules[] |
Daftar semua jadwal pencadangan. |
ListBackupsRequest
Permintaan untuk FirestoreAdmin.ListBackups
.
Kolom | |
---|---|
parent |
Wajib. Lokasi asal daftar cadangan. Formatnya adalah |
ListBackupsResponse
Respons untuk FirestoreAdmin.ListBackups
.
Kolom | |
---|---|
backups[] |
Daftar semua cadangan untuk project. |
unreachable[] |
Daftar lokasi tempat cadangan yang ada tidak dapat diambil. Daripada menggagalkan seluruh permintaan saat satu lokasi tidak dapat dijangkau, respons ini menampilkan kumpulan hasil parsial dan daftar lokasi yang tidak dapat dijangkau di sini. Permintaan dapat dicoba ulang terhadap satu lokasi untuk mendapatkan error konkret. |
ListDatabasesRequest
Permintaan untuk mencantumkan Database Firestore di semua lokasi untuk sebuah project.
Kolom | |
---|---|
parent |
Wajib. Nama induk dari formulir |
ListDatabasesResponse
Daftar database untuk sebuah project.
Kolom | |
---|---|
databases[] |
Database dalam project. |
unreachable[] |
Jika data tentang masing-masing {i>database<i} tidak dapat dicantumkan, data tersebut akan dicatat di sini. Contoh entrinya mungkin: projects/some_project/locations/some_location. Hal ini dapat terjadi jika Region Cloud tempat Database berada saat ini tidak tersedia. Dalam hal ini, kita tidak dapat mengambil semua detail tentang database. Anda mungkin bisa mendapatkan pesan error yang lebih detail (atau mungkin mengambil resource) dengan mengirimkan permintaan 'Get' untuk resource tersebut atau permintaan 'List' untuk lokasi tertentu. |
ListFieldsRequest
Permintaan untuk FirestoreAdmin.ListFields
.
Kolom | |
---|---|
parent |
Wajib. Nama induk dari formulir |
filter |
Filter yang akan diterapkan ke hasil daftar. Saat ini, |
page_size |
Jumlah hasil yang akan ditampilkan. |
page_token |
Token halaman, yang ditampilkan dari panggilan sebelumnya ke |
ListFieldsResponse
Respons untuk FirestoreAdmin.ListFields
.
Kolom | |
---|---|
fields[] |
Kolom yang diminta. |
next_page_token |
Token halaman yang dapat digunakan untuk meminta halaman hasil lainnya. Jika kosong, ini adalah halaman terakhir. |
ListIndexesRequest
Permintaan untuk FirestoreAdmin.ListIndexes
.
Kolom | |
---|---|
parent |
Wajib. Nama induk dari formulir |
filter |
Filter yang akan diterapkan ke hasil daftar. |
page_size |
Jumlah hasil yang akan ditampilkan. |
page_token |
Token halaman, yang ditampilkan dari panggilan sebelumnya ke |
ListIndexesResponse
Respons untuk FirestoreAdmin.ListIndexes
.
Kolom | |
---|---|
indexes[] |
Indeks yang diminta. |
next_page_token |
Token halaman yang dapat digunakan untuk meminta halaman hasil lainnya. Jika kosong, ini adalah halaman terakhir. |
LocationMetadata
Jenis ini tidak memiliki kolom.
Pesan metadata untuk google.cloud.location.Location.metadata
.
OperationState
Menjelaskan status operasi.
Enum | |
---|---|
OPERATION_STATE_UNSPECIFIED |
Tidak ditentukan. |
INITIALIZING |
Permintaan sedang disiapkan untuk diproses. |
PROCESSING |
Permintaan sedang aktif diproses. |
CANCELLING |
Permintaan sedang dalam proses dibatalkan setelah pengguna memanggil google.longrunning.Operations.CancelOperation di operasi. |
FINALIZING |
Permintaan telah diproses dan sedang dalam tahap finalisasi. |
SUCCESSFUL |
Permintaan berhasil diselesaikan. |
FAILED |
Permintaan telah selesai diproses, tetapi mengalami error. |
CANCELLED |
Permintaan telah selesai dibatalkan setelah pengguna memanggil google.longrunning.Operations.CancelOperation. |
Progres
Menjelaskan kemajuan operasi. Unit kerja bersifat generik dan harus ditafsirkan berdasarkan tempat Progress
digunakan.
Kolom | |
---|---|
estimated_work |
Estimasi jumlah pekerjaan. |
completed_work |
Jumlah pekerjaan yang diselesaikan. |
RestoreDatabaseMetadata
Metadata untuk long-running operation
dari permintaan [RestoreDatabase][google.firestore.admin.v1.RestoreDatabase].
Kolom | |
---|---|
start_time |
Waktu pemulihan dimulai. |
end_time |
Waktu pemulihan selesai, tidak disetel untuk pemulihan yang sedang berlangsung. |
operation_state |
Status operasi pemulihan. |
database |
Nama database yang akan dipulihkan. |
backup |
Nama asal pencadangan cadangan. |
progress_percentage |
Sejauh mana pemulihan adalah perkiraan persentase waktu yang tersisa. |
RestoreDatabaseRequest
Pesan permintaan untuk [FirestoreAdmin.RestoreDatabase][google.firestore.admin.v1.RestoreDatabase].
Kolom | |
---|---|
parent |
Wajib. Project tempat database berada. Formatnya adalah |
database_id |
Wajib. ID yang akan digunakan untuk database, yang akan menjadi komponen akhir dari nama resource database. ID database ini tidak boleh dikaitkan dengan database yang sudah ada. Nilai ini harus terdiri dari 4-63 karakter. Karakter yang valid adalah /[a-z][0-9]-/ dengan karakter pertama huruf dan huruf terakhir atau angka. Tidak boleh berbentuk UUID /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/. ID database "(default)" juga valid. |
Kolom union
|
|
backup |
Cadangan untuk memulihkan. Harus berasal dari project yang sama dengan induk. Formatnya adalah: |
UpdateBackupScheduleRequest
Permintaan untuk FirestoreAdmin.UpdateBackupSchedule
.
Kolom | |
---|---|
backup_schedule |
Wajib. Jadwal cadangan akan diperbarui. |
update_mask |
Daftar kolom yang akan diperbarui. |
UpdateDatabaseMetadata
Jenis ini tidak memiliki kolom.
Metadata yang terkait dengan operasi pembaruan database.
UpdateDatabaseRequest
Permintaan untuk FirestoreAdmin.UpdateDatabase
.
Kolom | |
---|---|
database |
Wajib. Database yang akan diperbarui. |
update_mask |
Daftar kolom yang akan diperbarui. |
UpdateFieldRequest
Permintaan untuk FirestoreAdmin.UpdateField
.
Kolom | |
---|---|
field |
Wajib. Kolom yang akan diperbarui. |
update_mask |
Mask, relatif terhadap kolom. Jika ditentukan, hanya konfigurasi yang ditentukan oleh field_mask ini yang akan diperbarui di kolom tersebut. |
WeeklyRecurrence
Mewakili jadwal berulang yang berjalan pada hari tertentu dalam seminggu.
Zona waktu menggunakan UTC.
Kolom | |
---|---|
day |
Hari dalam seminggu untuk berlari. DAY_OF_WEEK_UNSPECIFIED tidak diizinkan. |