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)
  },
  "ttlConfig": {
    object (TtlConfig)
  }
}
Alanlar
name

string

Zorunlu. projects/{projectId}/databases/{databaseId}/collectionGroups/{collectionId}/fields/{fieldPath} biçimindeki alan adı

Alan yolu, basit bir alan adı (ör. address) veya matchValue içindeki alanlara giden bir yol (ör. address.city) ya da özel bir alan yolu olabilir. Geçerli tek özel alan, herhangi bir alanı temsil eden *'dir.

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),[,]` ifadeleri ve ASCII sembolik karakterleri kullanılarak alıntılanabilir.

Ö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) \address.city`represents a field namedaddress.city, not the map key cityin the fieldaddress. `*`represents a field named*`, herhangi bir alan değildir.

Ö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 politikasında tanımlanan dizinler, kendi Field dizin yapılandırmasına sahip olmayan tüm alanlara uygulanır.
indexConfig

object (IndexConfig)

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

object (TtlConfig)

Bu Field için TTL yapılandırması. Bunun ayarlanması veya kaldırılması, bu Field öğesine sahip dokümanlar için TTL'yi etkinleştirir veya devre dışı bırakır.

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 alanda desteklenen dizinler.
usesAncestorConfig

boolean

Yalnızca çıkış. Doğru değerine ayarlanırsa Field dizin yapılandırması, ancestorField tarafından belirtilen yapılandırmadan ayarlanır. Yanlış değerine ayarlanırsa Field 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)ayarlanacağı Field kaynak adını belirtir.
reverting

boolean

Yalnızca çıkış Doğru değerine ayarlandığında Field dizin yapılandırması geri alınma sürecindedir. İşlem tamamlandığında dizin yapılandırması, ancestorField tarafından belirtilen alanla aynı duruma geçirilir. Bu noktada usesAncestorConfig değeri true, reverting değeri ise false olur.

TtlConfig

Bu Field öğesinin ayarlandığı dokümanlar için TTL (geçerlilik süresi) yapılandırması.

Zaman damgası değerinin TTL'nin etkin olduğu bir alana depolanması, dokümanın mutlak geçerlilik süresi olarak değerlendirilir. Geçmişteki zaman damgası değerleri, belgenin anında geçerlilik bitiş tarihi için uygun olduğunu gösterir. Başka bir veri türünün kullanılması veya alanın boş bırakılması, söz konusu doküman için geçerlilik süresinin devre dışı bırakılmasına neden olur.

JSON gösterimi 
{
  "state": enum (State)
}
Alanlar
state

enum (State)

Yalnızca çıkış. TTL yapılandırmasının durumu.

Eyalet

TTL yapılandırmasının tüm dokümanlara uygulanma durumu.

Sıralamalar
STATE_UNSPECIFIED Durum belirtilmemiş veya bilinmiyor.
CREATING TTL uygulanıyor. Değişikliği izlemek için uzun süreli etkin bir işlem vardır. Yeni yazılan dokümanlara, istendiği gibi TTL'ler uygulanır. Mevcut dokümanlardaki istenen TTL'ler işlenmeye devam etmektedir. Mevcut tüm dokümanların TTL'leri işlendiğinde durum "ACTIVE" olarak değişir.
ACTIVE TTL tüm dokümanlar için etkindir.
NEEDS_REPAIR TTL yapılandırması mevcut tüm dokümanlar için etkinleştirilemedi. Yeni yazılan dokümanların TTL'si uygulanmaya devam eder. Bu Field için TTL'yi etkinleştirme girişiminde bulunulduğu son LRO başarısız oldu ve daha fazla ayrıntı içerebilir.

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 verilerini listeler.

patch

 Alan yapılandırmasını günceller.