Package google.firestore.admin.v1

string

Yalnızca çıkış. Yedeklemenin benzersiz kaynak adı.

Biçim: projects/{project}/locations/{location}/backups/{backup}.

string

Yalnızca çıkış. Yedeğin ait olduğu Firestore veritabanının adı.

Biçim: projects/{project}/databases/{database}.

string

Yalnızca çıkış. Yedeklemenin ait olduğu Firestore veritabanı için sistem tarafından oluşturulan UUID4.

Timestamp

Yalnızca çıkış. Yedek, şu anda veritabanının harici olarak tutarlı bir kopyasını içermektedir.

Timestamp

Yalnızca çıkış. Bu yedeğin süresinin dolacağı zaman damgası.

State

Yalnızca çıkış. Yedeğin mevcut durumu.

string

Yalnızca çıkış. Belirli bir proje için tüm konumlar ve veritabanlarındaki benzersiz yedekleme programı tanımlayıcısı.

Bu, otomatik olarak atanacak.

Biçim: projects/{project}/databases/{database}/backupSchedules/{backup_schedule}

Timestamp

Yalnızca çıkış. Bu yedekleme planının oluşturulduğu ve o zamandan beri geçerli olduğu zaman damgası.

Bu tarihten önce bu program için yedek oluşturulmayacak.

Timestamp

Yalnızca çıkış. Bu yedekleme programının en son güncellendiği zaman damgası. Yedekleme planı ilk oluşturulduğunda, create_time ile aynıdır.

Duration

Yedeklemenin, oluşturulma zamanına kıyasla gelecekteki göreli herhangi bir zamanda silinmesi gerekir (ör. yedekleri 7 gün süreyle tutma).

DailyRecurrence

Günlük olarak çalıştırılan bir program için.

WeeklyRecurrence

Haftalık olarak belirli bir günde çalışan bir program için.

string

Zorunlu. Üst veritabanı.

Biçim projects/{project}/databases/{database}

BackupSchedule

Zorunlu. Oluşturulacak yedekleme programı.

string

Zorunlu. projects/{project_id} formunun üst adı

Database

Zorunlu. Oluşturulacak Veritabanı.

string

Zorunlu. Veritabanı için kullanılacak kimlik. Bu kimlik, veritabanının kaynak adının son bileşeni olur.

Bu değer 4 ila 63 karakter arasında olmalıdır. Geçerli karakterler, ilk karakteri bir harf, son karakteri ise bir harf veya rakam olmak üzere /[a-z][0-9]-/ şeklindedir. UUID benzeri /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/ olmamalıdır.

"(varsayılan)" veritabanı kimliği de geçerlidir.

string

Zorunlu. projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id} formunun üst adı

Index

Zorunlu. Oluşturulacak bileşik dizin.

string

Veritabanının kaynak adı. Biçim: projects/{project}/databases/{database}

string

Yalnızca çıkış. Bu Veritabanı için sistem tarafından oluşturulan UUID4.

Timestamp

Yalnızca çıkış. Bu veritabanının oluşturulduğu zaman damgası. 2016'dan önce oluşturulan veritabanlarında create_time parametresi doldurulmaz.

Timestamp

Yalnızca çıkış. Bu veritabanının en son güncellendiği zaman damgası. Bunun yalnızca veritabanı kaynağında yapılan güncellemeleri içerdiğini, veritabanında bulunan verileri kapsamadığını unutmayın.

string

Veritabanının konumu. Özelliğin kullanılabildiği konumları https://cloud.google.com/firestore/docs/locations adresinde bulabilirsiniz.

DatabaseType

Veritabanının türü. Seçim yapma hakkında bilgi için https://cloud.google.com/datastore/docs/firestore-or-datastore adresini ziyaret edin.

ConcurrencyMode

Bu veritabanı için kullanılacak eşzamanlılık kontrol modu.

Duration

Yalnızca çıkış. Verilerin eski sürümlerinin veritabanında saklandığı dönem.

Herhangi bir read veya query, bu pencerede bir read_time belirtebilir ve veritabanının o zaman durumunu okur.

PITR özelliği etkinse saklama süresi 7 gündür. Aksi takdirde saklama süresi 1 saattir.

Timestamp

Yalnızca çıkış. Verilerin eski sürümlerinin veritabanından okunabileceği en erken zaman damgası. Yukarıdaki [version_retention_period] bölümüne bakın. Bu alan now - version_retention_period ile doldurulur.

Bu değer sürekli olarak güncellenir ve sorgulandığı anda geçersiz hale gelir. Bu değeri verileri kurtarmak için kullanıyorsanız değerin sorgulandığı andan kurtarma işlemini başlattığınız ana kadar geçen süreyi hesaba kattığınızdan emin olun.

PointInTimeRecoveryEnablement

Bu veritabanında PITR özelliğinin etkinleştirilip etkinleştirilmeyeceği.

AppEngineIntegrationMode

Bu veritabanı için kullanılacak App Engine entegrasyon modu.

string

Yalnızca çıkış. Bu veritabanı için key_prefix. Bu key_prefix, Google App Engine birinci nesil çalışma zamanlarında Cloud Datastore API'lerinden döndürülen uygulama kimliğini oluşturmak için proje kimliğiyle ("~") birlikte kullanılır.

Bu değer boş olabilir. Böyle bir durumda, URL kodlamalı anahtarlar için kullanılacak appid proje_kimliğidir (ör. v~foo yerine foo).

DeleteProtectionState

Veritabanı için silme korumasının durumu.

CmekConfig

İsteğe bağlı. Mevcut olması, CMEK'nin bu veritabanı için etkin olduğunu gösterir.

string

Bu sağlama toplamı, sunucu tarafından diğer alanların değerine göre hesaplanır ve devam etmeden önce istemcinin güncel bir değere sahip olduğundan emin olmak için güncelleme ve silme isteklerinde gönderilebilir.

string

Zorunlu. Yalnızca bu veritabanıyla aynı konumdaki anahtarların şifreleme için kullanılmasına izin verilir.

Firestore'un nam5 çoklu bölgesi için bu, bize Cloud KMS çoklu bölge kullanımına karşılık gelir. Firestore'un eur3 çoklu bölgesi için bu, Cloud KMS çok bölgeli Avrupa'ya karşılık gelir. https://cloud.google.com/kms/docs/locations adresine göz atın.

Beklenen biçim: projects/{project_id}/locations/{kms_location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}.

string

Yalnızca çıkış. Şu anda kullanımda olan KMS anahtarı sürümleri. Anahtar rotasyonu sırasında, kullanımda olan birden fazla anahtar sürümü olabilir.

Beklenen biçim: projects/{project_id}/locations/{kms_location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{key_version}.

string

Zorunlu. Silinecek yedeğin adı.

biçimi şöyledir: projects/{project}/locations/{location}/backups/{backup}.

string

Zorunlu. Yedekleme planının adı.

Biçim projects/{project}/databases/{database}/backupSchedules/{backup_schedule}

string

Zorunlu. projects/{project_id}/databases/{database_id} formunun adı

string

Veritabanının geçerli etag'i. Bir etag sağlanır ve veritabanının mevcut durumu ile eşleşmezse silme işlemi engellenir ve FAILED_PRECONDITION hatası döndürülür.

string

Zorunlu. projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id} formunun adı

Timestamp

Bu işlemin başladığı saat.

Timestamp

Bu işlemin tamamlandığı saat. İşlem hâlâ devam ediyorsa ayarı iptal edilir.

OperationState

Dışa aktarma işleminin durumu.

Progress

Bu işlemin ilerleme durumu (belgelerde).

Progress

Bu işlemin bayt cinsinden ilerleme durumu.

string

Dışa aktarılan koleksiyon kimlikleri.

string

Dokümanların dışa aktarıldığı hedef.

string

Dışa aktarılan ad alanı kimlikleri.

Timestamp

Dışa aktarılan veritabanının sürümüne karşılık gelen zaman damgası. Bu değer belirtilmediğinde, dışa aktarılan dokümanların tutarlılığı konusunda herhangi bir garanti verilmez.

string

Zorunlu. Dışa aktarılacak veritabanı. projects/{project_id}/databases/{database_id} biçiminde olmalıdır.

string

Dışa aktarılacak koleksiyon kimlikleri. Belirtilmemiş ifadesi, tüm koleksiyonlar anlamına gelir.

string

Çıkış URI'sı. Şu anda yalnızca gs://BUCKET_NAME[/NAMESPACE_PATH] biçimindeki Google Cloud Storage URI'ları desteklenir. Burada BUCKET_NAME Google Cloud Storage paketinin adıdır ve NAMESPACE_PATH isteğe bağlı bir Google Cloud Storage ad alanı yoludur. Ad seçerken Google Cloud Storage adlandırma yönergelerini göz önünde bulundurmayı unutmayın: https://cloud.google.com/storage/docs/naming. URI bir paketse (ad alanı yolu olmayan) başlangıç zamanına göre bir önek oluşturulur.

string

Boş bir liste tüm ad alanlarını temsil eder. Bu, ad alanları kullanmayan veritabanları için tercih edilen kullanımdır.

Boş bir dize öğesi, varsayılan ad alanını temsil eder. Veritabanının varsayılan olmayan ad alanlarında verileri varsa ancak bunları dahil etmek istemiyorsa bu seçenek kullanılmalıdır. Bu listedeki her ad alanı benzersiz olmalıdır.

Timestamp

Dışa aktarılacak veritabanının sürümüne karşılık gelen zaman damgası. Zaman damgası geçmişte olmalı, dakikaya yuvarlanmış ve en fazla earliestVersionTime olmalıdır. Belirtilirse dışa aktarılan dokümanlar, sağlanan zamanda veritabanının tutarlı bir görünümünü temsil eder. Aksi takdirde, dışa aktarılan dokümanların tutarlılığı konusunda herhangi bir garanti verilmez.

string

Çıkış dosyalarının konumu. Bu anahtar, işlem başarıyla tamamlandıktan sonra Cloud Firestore'a (bu proje veya başka bir proje) içe aktarma işlemini başlatmak için kullanılabilir.

string

Zorunlu. projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path} biçimindeki alan adı

Alan yolu, basit bir alan adı (ör. address) veya eş_değeri 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/{project_id}/databases/{database_id}/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

Bu alan için dizin yapılandırması. Politika ayarlanmadan bırakılırsa alan dizine ekleme işlemi, ancestor_field 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

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.

Index

Bu alanda desteklenen dizinler.

bool

Yalnızca çıkış. Doğru değerine ayarlanırsa Field dizin yapılandırması, ancestor_field 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.

string

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

bool

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ı, ancestor_field tarafından belirtilen alanla aynı duruma geçirilir. Bu noktada uses_ancestor_config değeri true, reverting değeri ise false olur.

State

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

Timestamp

Bu işlemin başladığı saat.

Timestamp

Bu işlemin tamamlandığı saat. İşlem hâlâ devam ediyorsa ayarı iptal edilir.

string

Bu işlemin üzerinde işlem yaptığı alan kaynağı. Örneğin: projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}

IndexConfigDelta

Bu işlemin amacını açıklayan IndexConfigDelta listesi.

OperationState

İşlemin durumu.

Progress

Bu işlemin ilerleme durumu (belgelerde).

Progress

Bu işlemin bayt cinsinden ilerleme durumu.

TtlConfigDelta

TTL yapılandırmasının deltalarını açıklar.

ChangeType

Dizinin nasıl değiştiğini belirtir.

Index

Değiştirilmekte olan dizin.

ChangeType

TTL yapılandırmasının nasıl değiştirileceğini belirtir.

string

Zorunlu. Getirilecek yedeğin adı.

Biçim: projects/{project}/locations/{location}/backups/{backup}.

string

Zorunlu. Yedekleme planının adı.

Biçim projects/{project}/databases/{database}/backupSchedules/{backup_schedule}

string

Zorunlu. projects/{project_id}/databases/{database_id} formunun adı

string

Zorunlu. projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_id} formunun adı

string

Zorunlu. projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id} formunun adı

Timestamp

Bu işlemin başladığı saat.

Timestamp

Bu işlemin tamamlandığı saat. İşlem hâlâ devam ediyorsa ayarı iptal edilir.

OperationState

İçe aktarma işleminin durumu.

Progress

Bu işlemin ilerleme durumu (belgelerde).

Progress

Bu işlemin bayt cinsinden ilerleme durumu.

string

Hangi koleksiyon kimliklerinin içe aktarıldığı.

string

İçe aktarılan dokümanların konumu.

string

Hangi ad alanı kimliklerinin içe aktarıldığı.

string

Zorunlu. İçe aktarılacak veritabanı. projects/{project_id}/databases/{database_id} biçiminde olmalıdır.

string

İçe aktarılacak koleksiyon kimlikleri. Belirtilmemiş ifadesi, içe aktarmaya dahil edilen tüm koleksiyonlar anlamına gelir.

string

Dışa aktarılan dosyaların konumu. Bu değer, başarıyla tamamlanan bir dışa aktarmadaki ExportDocumentsResponse'un exit_uri_prefix değeriyle eşleşmelidir. Şu sayfaya göz atın: google.firestore.admin.v1.ExportDocumentsResponse.output_uri_prefix.

string

Boş bir liste tüm ad alanlarını temsil eder. Bu, ad alanları kullanmayan veritabanları için tercih edilen kullanımdır.

Boş bir dize öğesi, varsayılan ad alanını temsil eder. Veritabanının varsayılan olmayan ad alanlarında verileri varsa ancak bunları dahil etmek istemiyorsa bu seçenek kullanılmalıdır. Bu listedeki her ad alanı benzersiz olmalıdır.

string

Yalnızca çıkış. Bu dizin için sunucu tarafından tanımlanan bir ad. Bileşik dizinler için bu adın biçimi şu şekildedir: projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{composite_index_id} Tek alanlı dizinler için bu alan boş olur.

QueryScope

Koleksiyon sorgusu kapsamının belirtildiği dizinler, belirli bir belgenin alt öğesi olan, sorgu sırasında belirtilen ve aynı koleksiyon kimliğine sahip bir koleksiyonda sorgulara izin verir.

Koleksiyon grubu sorgu kapsamına sahip olan dizinler, belirli bir belgeden türetilmiş olan, sorgu sırasında belirtilen ve bu dizinle aynı koleksiyon kimliğine sahip olan tüm koleksiyonlarda yapılan sorgulara izin verir.

ApiScope

Bu dizin tarafından desteklenen API kapsamı.

IndexField

Bu dizin tarafından desteklenen alanlar.

Bileşik dizinler için bu, en az 2 ve en fazla 100 alan gerektirir. Son alan girişi her zaman __name__ alan yolu içindir. Oluşturma sırasında __name__ son alan olarak belirtilmemişse, tanımlanan son alanın yönüyle aynı yönde otomatik olarak eklenir. Bileşik dizindeki son alan yönlü değilse __name__, ASCENDING (açıkça belirtilmedikçe) olarak sıralanır.

Tek alan dizinlerinde bu, her zaman ilişkili alanın alan yoluna eşit bir alan yoluna sahip tam olarak tek bir giriş olacaktır.

State

Yalnızca çıkış. Dizinin sunulma durumu.

string

Ad olabilir. Tek alan dizinleri için bu ad, alanın adıyla eşleşmelidir veya atlanabilir.

Order

Bu alanın, belirtilen sıraya göre sıralamayı veya =, !=, <, <=, >, >= kullanarak karşılaştırma yapmayı desteklediğini belirtir.

ArrayConfig

Bu alanın, array_value işlemleri üzerindeki işlemleri desteklediğini belirtir.

VectorConfig

Bu alanın, vektör üzerinde en yakın komşu ve mesafe işlemlerini desteklediğini belirtir.

int32

Zorunlu. Bu yapılandırmanın geçerli olduğu vektör boyutu.

Sonuç olarak elde edilen dizin, yalnızca bu boyuttaki vektörleri içerir ve aynı boyuta sahip vektör araması için kullanılabilir.

FlatIndex

Vektör dizininin düz bir dizin olduğunu gösterir.

Timestamp

Bu işlemin başladığı saat.

Timestamp

Bu işlemin tamamlandığı saat. İşlem hâlâ devam ediyorsa ayarı iptal edilir.

string

Bu işlemin üzerinde işlem yaptığı dizin kaynağı. Örneğin: projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}

OperationState

İşlemin durumu.

Progress

Bu işlemin ilerleme durumu (belgelerde).

Progress

Bu işlemin bayt cinsinden ilerleme durumu.

string

Zorunlu. Üst veritabanı.

Biçim: projects/{project}/databases/{database}.

BackupSchedule

Tüm yedekleme programlarının listesi.

string

Zorunlu. Yedeklemelerin listeleneceği konum.

Biçim: projects/{project}/locations/{location}. Belirli bir proje için tüm konumlardaki yedekleri listelemek üzere {location} = '-' öğesini kullanın. Bu, tek bir konumdan veya tüm konumlardan yedeklemelerin listelenmesine olanak tanır.

Backup

Projedeki tüm yedeklerin listesi.

string

Mevcut yedeklerin getirilemediği konumların listesi.

Bu yanıt, tek bir konuma erişilemediğinde isteklerin tamamında başarısız olmak yerine kısmi bir sonuç kümesi ve burada erişilemeyen konumların listesini döndürür. İstek, somut bir hata almak için tek bir konum için yeniden denenebilir.

string

Zorunlu. projects/{project_id} formunun üst adı

Database

Projedeki veritabanları.

string

Bağımsız veritabanlarıyla ilgili verilerin listelenememesi halinde, bu veriler buraya kaydedilir.

Örnek giriş şu şekilde olabilir: projects/some_project/locations/some_location Bu durum, Veritabanının bulunduğu Cloud Region şu anda kullanılamıyorsa ortaya çıkabilir. Bu durumda, veritabanıyla ilgili tüm ayrıntıları getiremeyiz. Kaynak için "Al" isteği veya belirli bir konum için "Liste" isteği göndererek daha ayrıntılı bir hata mesajı alabilirsiniz (veya kaynağı alabilirsiniz).

string

Zorunlu. projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id} formunun üst adı

string

Liste sonuçlarına uygulanacak filtre. FirestoreAdmin.ListFields şu anda yalnızca açıkça geçersiz kılınan giriş alanlarını desteklemektedir. Bu sorguyu yayınlamak için indexConfig.usesAncestorConfig:false içeren bir filtreyle FirestoreAdmin.ListFields çağrısı yapın .

int32

Döndürülecek sonuç sayısı.

string

Önceki bir FirestoreAdmin.ListFields çağrısından döndürülen ve sonraki sonuç sayfasını almak için kullanılabilecek sayfa jetonu.

Field

İstenen alanlar.

string

Başka bir sonuç sayfası istemek için kullanılabilecek bir sayfa jetonu. Boşsa bu son sayfadır.

string

Zorunlu. projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id} formunun üst adı

string

Liste sonuçlarına uygulanacak filtre.

int32

Döndürülecek sonuç sayısı.

string

Önceki bir FirestoreAdmin.ListIndexes çağrısından döndürülen ve sonraki sonuç sayfasını almak için kullanılabilecek sayfa jetonu.

Index

İstenen dizinler.

string

Başka bir sonuç sayfası istemek için kullanılabilecek bir sayfa jetonu. Boşsa bu son sayfadır.

int64

Tahmin edilen iş miktarı.

int64

Tamamlanan çalışma miktarı.

Timestamp

Geri yüklemenin başlatıldığı zaman.

Timestamp

Geri yüklemenin sona erdiği zaman. Devam eden geri yükleme işlemleri için ayarı kaldırıldı.

OperationState

Geri yüklemenin işlem durumu.

string

Geri yüklenecek veritabanının adı.

string

Geri yüklemenin yapıldığı yedeğin adı.

Progress

Geri yükleme işleminin, kalan sürenin tahmini yüzdesi olarak ne kadar olduğu.

string

Zorunlu. Veritabanının geri yükleneceği proje. Biçim: projects/{project_id}.

string

Zorunlu. Veritabanı için kullanılacak kimlik. Bu kimlik, veritabanının kaynak adının son bileşeni olur. Bu veritabanı kimliği, mevcut bir veritabanıyla ilişkilendirilmemelidir.

Bu değer 4 ila 63 karakter arasında olmalıdır. Geçerli karakterler, ilk karakteri bir harf, son karakteri ise bir harf veya rakam olmak üzere /[a-z][0-9]-/ şeklindedir. UUID benzeri /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/ olmamalıdır.

"(varsayılan)" veritabanı kimliği de geçerlidir.

string

Geri yükleme için kullanılacak yedekleme'ye dokunun. Üst kuruluşla aynı projeye ait olmalıdır.

Biçim: projects/{project_id}/locations/{location}/backups/{backup}

BackupSchedule

Zorunlu. Güncellenecek yedekleme programı.

FieldMask

Güncellenecek alanların listesi.

Database

Zorunlu. Güncellenecek veritabanı.

FieldMask

Güncellenecek alanların listesi.

Field

Zorunlu. Güncellenecek alan.

FieldMask

Alana göre bir maske. Belirtilirse alanda yalnızca bu field_mask ile belirtilen yapılandırma güncellenir.

DayOfWeek

Yayınlanmak üzere haftanın günü.

DAY_OF_WEEK_UNSPECIFIED öğesine izin verilmiyor.