Method: projects.databases.collectionGroups.fields.patch

Memperbarui konfigurasi kolom. Saat ini, pembaruan kolom hanya berlaku untuk konfigurasi indeks kolom tunggal. Namun, panggilan ke FirestoreAdmin.UpdateField harus menyediakan mask kolom untuk menghindari perubahan konfigurasi apa pun yang tidak diketahui pemanggil. Mask kolom harus ditentukan sebagai: { paths: "indexConfig" }.

Panggilan ini menampilkan google.longrunning.Operation yang dapat digunakan untuk melacak status pembaruan kolom. Metadata untuk operasi akan berupa jenis FieldOperationMetadata.

Untuk mengonfigurasi setelan kolom default untuk database, gunakan Field khusus dengan nama resource: projects/{projectId}/databases/{databaseId}/collectionGroups/__default__/fields/*.

Permintaan HTTP

PATCH https://firestore.googleapis.com/v1beta2/{field.name=projects/*/databases/*/collectionGroups/*/fields/*}

URL menggunakan sintaksis gRPC Transcoding.

Parameter jalur

Parameter
field.name

string

Nama kolom formulir projects/{projectId}/databases/{databaseId}/collectionGroups/{collectionId}/fields/{fieldPath}

Jalur kolom dapat berupa nama kolom sederhana, misalnya address atau jalur ke kolom dalam mapValue , misalnya address.city, atau jalur kolom khusus. Satu-satunya kolom khusus yang valid adalah *, yang mewakili kolom apa pun.

Jalur kolom dapat dikutip menggunakan (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),[,]`, serta semua karakter simbol ASCII.

Contoh: (Catatan: Komentar di sini ditulis dalam sintaksis markdown, sehingga ada lapisan tanda kutip terbalik tambahan untuk mewakili blok kode) \address.city`represents a field namedaddress.city, not the map key cityin the fieldaddress. `*`represents a field named*`, bukan kolom apa pun.

Field khusus berisi setelan pengindeksan default untuk semua kolom. Nama resource kolom ini adalah: projects/{projectId}/databases/{databaseId}/collectionGroups/__default__/fields/* Indeks yang ditentukan dalam Field ini akan diterapkan ke semua kolom yang tidak memiliki konfigurasi indeks Field sendiri.

Parameter kueri

Parameter
updateMask

string (FieldMask format)

Mask, relatif terhadap kolom. Jika ditentukan, hanya konfigurasi yang ditentukan oleh field_mask ini yang akan diperbarui di kolom tersebut.

Ini adalah daftar yang dipisahkan koma yang berisi nama kolom yang sepenuhnya memenuhi syarat. Contoh: "user.displayName,photo".

Isi permintaan

Isi permintaan memuat instance Field.

Isi respons

Jika berhasil, isi respons akan berisi instance Operation.

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

Untuk informasi selengkapnya, lihat Ringkasan Autentikasi.