REST Resource: projects.databases.collectionGroups.fields

Kaynak: Alan

Veritabanındaki tek bir alanı temsil eder.

Alanlar, veritabanındaki aynı kimliğe sahip tüm koleksiyonları temsil eden "Koleksiyon Grubu"na göre gruplandırılır.

JSON gösterimi 
{
  "name": string,
  "indexConfig": {
    object (IndexConfig)
  }
}
Alanlar
name

string

projects/{projectId}/databases/{databaseId}/collectionGroups/{collectionId}/fields/{fieldPath} biçiminde bir alan adı

Alan yolu, basit bir alan adı olabilir (ör. address veya MapValue içindeki alanların yolu , ör. address.city veya özel bir alan yolu. Geçerli tek özel alan, herhangi bir alanı temsil eden * alanıdır.

Alan yolları, (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),[,]" ve ASCII sembolik karakterleri kullanılarak tırnak içine alınabilir.

Örnekler: (Not: Buradaki yorumlar markdown söz dizimiyle yazıldığından kod bloğunu temsil eden ek vurgu işareti katmanı bulunur) \address.city`represents a field namedaddress.city, not the map key şehirin the fieldadres. `*`represents a field named*`, herhangi bir alan değil.

Özel bir Field, tüm alanlar için varsayılan dizine ekleme ayarlarını içerir. Bu alanın kaynak adı: projects/{projectId}/databases/{databaseId}/collectionGroups/__default__/fields/* Bu Field üzerinde tanımlanan dizinler, kendi Field dizin yapılandırmasına sahip olmayan tüm alanlara uygulanacak.
indexConfig

object (IndexConfig)

Bu alan için dizin yapılandırması. Politika ayarlanmadan bırakılırsa alan dizine ekleme, ancestorField tarafından tanımlanan yapılandırmaya geri döner. Bu alan için tüm dizinleri açık bir şekilde kaldırmak için boş dizin listesi içeren bir dizin yapılandırması belirtin.

IndexConfig

Bu alan için dizin yapılandırması.

JSON gösterimi 
{
  "indexes": [
    {
      object (Index)
    }
  ],
  "usesAncestorConfig": boolean,
  "ancestorField": string,
  "reverting": boolean
}
Alanlar
indexes[]

object (Index)

Bu alan için desteklenen dizinler.
usesAncestorConfig

boolean

Yalnızca çıkış. Bu değer "doğru" olduğunda Field öğesinin dizin yapılandırması, ancestorField tarafından belirtilen yapılandırmadan ayarlanır. Yanlış değerine ayarlandığında Field öğesinin dizin yapılandırması açık bir şekilde tanımlanır.
ancestorField

string

Yalnızca çıkış. Bu alanın dizin yapılandırmasının ayarlandığı (usesAncestorConfig doğru olduğunda) veya bu alanda dizin yapılandırması yoksa (usesAncestorConfig yanlış olduğunda) alanın ayarlanacağı Field kaynak adını belirtir.
reverting

boolean

Yalnızca çıkış (true) değerine ayarlanırsa Field öğesinin dizin yapılandırması geri alınma sürecindedir. İşlem tamamlandıktan sonra, dizin yapılandırması ancestorField tarafından belirtilen alanla aynı duruma geçer. Bu noktada usesAncestorConfig, true ve reverting, false olur.

Yöntemler

get

 Bir alanın meta verilerini ve yapılandırmasını alır.

list

 Bu veritabanı için alan yapılandırmasını ve meta verileri listeler.

patch

 Bir alan yapılandırmasını günceller.