Alan yapılandırmasını günceller. Şu anda alan güncellemeleri yalnızca tek alanlı dizin yapılandırmasına uygulanmaktadır. Ancak FirestoreAdmin.UpdateField
çağrılarında, arayanın farkında olmadığı yapılandırmaların değiştirilmesini önlemek için bir alan maskesi sağlanmalıdır. Alan maskesi şu şekilde belirtilmelidir: { paths: "indexConfig" }
.
Bu çağrı, alan güncellemesinin durumunu izlemek için kullanılabilecek bir google.longrunning.Operation
döndürür. İşlemin meta verileri türü FieldOperationMetadata
olacaktır.
Veritabanının varsayılan alan ayarlarını yapılandırmak için kaynak adına sahip özel Field
özelliğini kullanın: projects/{projectId}/databases/{databaseId}/collectionGroups/__default__/fields/*
.
HTTP isteği
PATCH https://firestore.googleapis.com/v1/{field.name=projects/*/databases/*/collectionGroups/*/fields/*}
URL, gRPC Kod Dönüştürme söz dizimini kullanır.
Yol parametreleri
Parametreler | |
---|---|
field.name |
Zorunlu. Alan yolu, basit bir alan adı (ör. Alan yolları, Örnekler: (Not: Buradaki yorumlar, markdown söz dizimiyle yazılır. Bu nedenle, bir kod bloğunu temsil eden ek bir vurgu işareti katmanı vardır) Özel bir |
Sorgu parametreleri
Parametreler | |
---|---|
updateMask |
Alana göre bir maske. Belirtilirse alanda yalnızca bu field_mask ile belirtilen yapılandırma güncellenir. Bu, tam nitelikli alan adlarının virgülle ayrılmış bir listesidir. Örnek: |
İstek içeriği
İstek metni, Field
öğesinin bir örneğini içerir.
Yanıt gövdesi
Başarılıysa yanıt metni, Operation
öğesinin bir örneğini içerir.
Yetkilendirme kapsamları
Aşağıdaki OAuth kapsamlarından birini gerektirir:
https://www.googleapis.com/auth/datastore
https://www.googleapis.com/auth/cloud-platform
Daha fazla bilgi için Kimlik Doğrulamaya Genel Bakış sayfasına göz atın.