Memperbarui konfigurasi bidang. Saat ini, pembaruan bidang hanya berlaku untuk konfigurasi indeks bidang tunggal. Namun, panggilan ke FirestoreAdmin.UpdateField
harus menyediakan field mask untuk menghindari perubahan konfigurasi apa pun yang tidak diketahui oleh pemanggil. Masker bidang harus ditentukan sebagai: { paths: "indexConfig" }
.
Panggilan ini mengembalikan google.longrunning.Operation
yang dapat digunakan untuk melacak status pembaruan bidang. Metadata untuk operasi ini adalah tipe FieldOperationMetadata
.
Untuk mengonfigurasi pengaturan bidang default untuk database, gunakan Field
khusus dengan nama sumber daya: projects/{projectId}/databases/{databaseId}/collectionGroups/__default__/fields/*
.
permintaan HTTP
PATCH https://firestore.googleapis.com/v1beta2/{field.name=projects/*/databases/*/collectionGroups/*/fields/*}
URL menggunakan sintaks Transcoding gRPC .
Parameter jalur
Parameter | |
---|---|
field.name | Nama bidang formulir Jalur bidang dapat berupa nama bidang yang sederhana, misalnya Jalur bidang dapat dikutip menggunakan Contoh: (Catatan: Komentar di sini ditulis dalam sintaksis penurunan harga, jadi ada lapisan backtick tambahan untuk mewakili blok kode) |
Parameter kueri
Parameter | |
---|---|
updateMask | Topeng, relatif terhadap lapangan. Jika ditentukan, hanya konfigurasi yang ditentukan oleh field_mask ini yang akan diperbarui di bidang tersebut. Ini adalah daftar nama bidang yang memenuhi syarat yang dipisahkan koma. Contoh: |
Permintaan tubuh
Badan permintaan berisi turunan Field
.
Badan respons
Jika berhasil, isi respons berisi turunan Operation
.
Cakupan otorisasi
Memerlukan salah satu cakupan OAuth berikut:
-
https://www.googleapis.com/auth/datastore
-
https://www.googleapis.com/auth/cloud-platform
Untuk informasi lebih lanjut, lihat Ikhtisar Otentikasi .