Package google.firestore.admin.v1

Dizin

Firestore Yöneticisi

Cloud Firestore Admin API.

Bu API, Cloud Firestore için çeşitli yönetim hizmetleri sağlar.

Proje, Veritabanı, Ad Alanı, Koleksiyon, Toplama Grubu ve Belge, Google Cloud Firestore API'de tanımlandığı şekilde kullanılır.

İşlem: İşlem, arka planda gerçekleştirilen işi temsil eder.

Dizin hizmeti, Cloud Firestore dizinlerini yönetir.

Dizin oluşturma işlemi eşzamansız olarak gerçekleştirilir. Bu tür her eşzamansız işlem için bir İşlem kaynağı oluşturulur. İşlemin durumu (karşılaşılan hatalar dahil), İşlem kaynağı aracılığıyla sorgulanabilir.

Operasyonlar koleksiyonu, belirtilen Proje için gerçekleştirilen işlemlerin (devam eden İşlemler dahil) kaydını sağlar. İşlemler doğrudan değil, diğer koleksiyonlar veya kaynaklar üzerinde yapılan çağrılar aracılığıyla oluşturulur.

Tamamlanan bir İşlem, artık İşlem koleksiyonunun parçası olarak listelenmemesi için silinebilir. Atıklar 30 gün sonra toplanır. Varsayılan olarak, ListOperations yalnızca devam eden ve başarısız işlemleri döndürür. Tamamlanan işlemi listelemek için done: true filtresiyle bir ListOperations isteği gönderin.

İşlemler FirestoreAdmin hizmeti tarafından oluşturulur ancak bunlara google.longrunning.Operations hizmeti aracılığıyla erişilir.

Yedekleme Planlaması Oluştur

rpc CreateBackupSchedule(CreateBackupScheduleRequest) returns (BackupSchedule)

Bir veritabanında yedekleme programı oluşturur. Bir veritabanında günlük yedekleme ve haftalık yedekleme olmak üzere en fazla iki yedekleme programı yapılandırılabilir.

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ış başlıklı makaleye bakın.
Veritabanı Oluşturma

rpc CreateDatabase(CreateDatabaseRequest) returns (Operation)

Veritabanı oluşturun.

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ış başlıklı makaleye bakın.
CreateIndex

rpc CreateIndex(CreateIndexRequest) returns (Operation)

Bileşik bir dizin oluşturur. Bu işlem, oluşturma işleminin durumunu izlemek için kullanılabilecek bir google.longrunning.Operation döndürür. İşlemin meta verileri IndexOperationMetadata türünde olur.

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ış başlıklı makaleye bakın.
Yedeklemeyi Sil

rpc DeleteBackup(DeleteBackupRequest) returns (Empty)

Bir yedeği siler.

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ış başlıklı makaleye bakın.
DeleteBackupPlanlama

rpc DeleteBackupSchedule(DeleteBackupScheduleRequest) returns (Empty)

Yedekleme programını siler.

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ış başlıklı makaleye bakın.
Veritabanı Silme

rpc DeleteDatabase(DeleteDatabaseRequest) returns (Operation)

Veritabanını siler.

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ış başlıklı makaleye bakın.
DeleteIndex

rpc DeleteIndex(DeleteIndexRequest) returns (Empty)

Bileşik bir dizin siler.

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ış başlıklı makaleye bakın.
Dokümanları Dışa Aktar

rpc ExportDocuments(ExportDocumentsRequest) returns (Operation)

Google Cloud Firestore'daki dokümanların tamamının veya bir alt kümesinin kopyasını Google Cloud Storage gibi başka bir depolama sistemine aktarır. Dokümanlarda yapılan son güncellemeler dışa aktarmaya yansıtılmayabilir. Dışa aktarma işlemi arka planda gerçekleştirilir. İşlemin ilerleme durumu, oluşturulan İşlem kaynağı aracılığıyla izlenip yönetilebilir. Dışa aktarma işleminin sonucu yalnızca ilişkili işlem tamamlandıktan sonra kullanılabilir. Bir dışa aktarma işlemi tamamlanmadan iptal edilirse Google Cloud Storage'da kısmi veriler kalabilir.

Dışa aktarma davranışı ve çıkış biçimi hakkında daha fazla bilgi için şu sayfaya bakın: https://cloud.google.com/firestore/docs/manage-data/export-import

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ış başlıklı makaleye bakın.
Yedeklemeyi Al

rpc GetBackup(GetBackupRequest) returns (Backup)

Bir yedeklemeyle ilgili bilgileri alır.

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ış başlıklı makaleye bakın.
Yedek Programı Alma

rpc GetBackupSchedule(GetBackupScheduleRequest) returns (BackupSchedule)

Yedekleme programıyla ilgili bilgileri alır.

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ış başlıklı makaleye bakın.
Veritabanı Alma

rpc GetDatabase(GetDatabaseRequest) returns (Database)

Bir veritabanı hakkında bilgi alır.

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ış başlıklı makaleye bakın.
Alan

rpc GetField(GetFieldRequest) returns (Field)

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

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ış başlıklı makaleye bakın.
GetIndex

rpc GetIndex(GetIndexRequest) returns (Index)

Bileşik bir dizin alır.

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ış başlıklı makaleye bakın.
Dokümanları İçe Aktar

rpc ImportDocuments(ImportDocumentsRequest) returns (Operation)

Belgeleri Google Cloud Firestore'a aktarır. Aynı ada sahip mevcut dokümanların üzerine yazılır. İçe aktarma işlemi arka planda gerçekleştirilir. İçe aktarma işlemi, oluşturulan İşlem kaynağı aracılığıyla izlenip yönetilebilir. ImportDocuments işlemi iptal edilirse verilerin bir alt kümesi zaten Cloud Firestore'a aktarılmış olabilir.

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ış başlıklı makaleye bakın.
ListBackupProgramları

rpc ListBackupSchedules(ListBackupSchedulesRequest) returns (ListBackupSchedulesResponse)

Yedekleme programlarını listeleme.

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ış başlıklı makaleye bakın.
ListBackup'ları

rpc ListBackups(ListBackupsRequest) returns (ListBackupsResponse)

Tüm yedekleri listeler.

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ış başlıklı makaleye bakın.
Veritabanlarını Listeleme

rpc ListDatabases(ListDatabasesRequest) returns (ListDatabasesResponse)

Projedeki tüm veritabanlarını listeleyin.

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ış başlıklı makaleye bakın.
Liste Alanları

rpc ListFields(ListFieldsRequest) returns (ListFieldsResponse)

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

FirestoreAdmin.ListFields şu anda yalnızca açıkça geçersiz kılınan giriş alanlarını desteklemektedir. Bu sorguyu göndermek için indexConfig.usesAncestorConfig:false veya ttlConfig:* olarak ayarlanmış filtreyle FirestoreAdmin.ListFields yöntemini çağırın.

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ış başlıklı makaleye bakın.
Liste Dizinleri

rpc ListIndexes(ListIndexesRequest) returns (ListIndexesResponse)

Bileşik dizinleri listeler.

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ış başlıklı makaleye bakın.
Veritabanını Geri Yükle

rpc RestoreDatabase(RestoreDatabaseRequest) returns (Operation)

Mevcut bir yedekten geri yükleyerek yeni veritabanı oluşturur.

Yeni veritabanı, mevcut yedekle aynı bulut bölgesinde veya çoklu bölge konumunda olmalıdır. Bu komut, [FirestoreAdmin.CreateDatabase][google.firestore.admin.v1.CreateDatabase] benzeridir; tek fark, yeni bir boş veritabanı oluşturmak yerine veritabanı türü, dizin yapılandırması ve mevcut bir yedekten dokümanlarla yeni bir veritabanı oluşturulmasıdır.

long-running operation, geri yükleme işleminin ilerlemesini izlemek için kullanılabilir. İşlemin metadata alan türü RestoreDatabaseMetadata olur. Geri yükleme başarılı olduysa response türü Database olur. LRO tamamlanana kadar yeni veritabanı okunamaz veya yazılamaz.

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ış başlıklı makaleye bakın.
UpdateBackupPlanlama'sı

rpc UpdateBackupSchedule(UpdateBackupScheduleRequest) returns (BackupSchedule)

Yedekleme planını günceller.

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ış başlıklı makaleye bakın.
Güncelleme Veritabanı

rpc UpdateDatabase(UpdateDatabaseRequest) returns (Operation)

Veritabanını günceller.

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ış başlıklı makaleye bakın.
GüncellemeAlanı

rpc UpdateField(UpdateFieldRequest) returns (Operation)

Bir alan yapılandırmasını günceller. Alan güncellemeleri şu anda yalnızca tekli alan dizin yapılandırması için geçerlidir. Ancak FirestoreAdmin.UpdateField için yapılan çağrılar, çağrıyı yapanın farkında olmadığı yapılandırmaların değiştirilmesini önlemek için alan maskesi sağlamalıdır. Alan maskesi şu şekilde belirtilmelidir: { paths: "index_config" }.

Bu çağrı, alan güncellemesinin durumunu izlemek için kullanılabilecek bir google.longrunning.Operation döndürür. İşlemin meta verileri FieldOperationMetadata türünde olur.

Veritabanının varsayılan alan ayarlarını yapılandırmak için kaynak adına sahip özel Field öğesini kullanın: projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/*.

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ış başlıklı makaleye bakın.

Yedek

Cloud Firestore Veritabanı Yedeği.

Yedek, belirli bir zamandaki veritabanı için tüm dokümanları ve dizin yapılandırmalarını içerir.

Alanlar
name

string

Yalnızca çıkış. Yedeğin benzersiz kaynak adı.

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

string

Yalnızca çıkış. Yedeğin alındığı Firestore veritabanının adı.

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

string

Yalnızca çıkış. Yedeğin alındığı Firestore veritabanı için sistem tarafından oluşturulan UUID4.
snapshot_time

Timestamp

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

Timestamp

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

State

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

Eyalet

Yedeğin mevcut durumunu belirtin.

Sıralamalar
STATE_UNSPECIFIED Eyalet belirtilmemiş.
CREATING Beklemedeki yedek hâlâ oluşturuluyor. Yedekle ilgili işlemler bu durumdayken reddedilecektir.
READY Yedekleme tamamlandı ve kullanıma hazır.
NOT_AVAILABLE Yedekleme şu anda kullanılamıyor.

Yedekleme Planlaması

Cloud Firestore Veritabanı için yedekleme programı.

Bu kaynak, yedeklediği veritabanına aittir ve veritabanıyla birlikte silinir. Ancak gerçek yedekler değildir.

Alanlar
name

string

Yalnızca çıkış. İlgili projenin tüm konumları ve veritabanlarındaki benzersiz yedekleme programı tanımlayıcısı.

Bu otomatik atanacak.

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

Timestamp

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

Bu süreden önce bu program için yedek oluşturulmayacak.
update_time

Timestamp

Yalnızca çıkış. Bu yedekleme planının en son güncellendiği zaman damgası. İlk kez bir yedekleme planlaması oluşturulduğunda bu süre, create_time ile aynıdır.
retention

Duration

Oluşturulma zamanına kıyasla gelecekteki göreli bir zamanda, yedeklerin silinmesi gerekir (ör. yedekleri 7 gün boyunca muhafaza et.

Desteklenen maksimum saklama süresi 14 haftadır.
Birleştirme alanı recurrence. Yedeklemelerin ne zaman yapılacağını temsil eden bir alandır. recurrence şunlardan yalnızca biri olabilir:
daily_recurrence

DailyRecurrence

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

WeeklyRecurrence

Haftalık olarak belirli bir günde çalıştırılan bir program içindir.

CreateBackupPlanRequest İsteği Oluştur

FirestoreAdmin.CreateBackupSchedule isteği.

Alanlar
parent

string

Zorunlu. Üst veritabanı.

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

BackupSchedule

Zorunlu. Oluşturulacak yedekleme programı.

CreateDatabaseMetadata

Bu türde alan yok.

Veritabanı oluşturma işlemiyle ilgili meta veriler.

CreateDatabaseRequest

FirestoreAdmin.CreateDatabase isteği.

Alanlar
parent

string

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

Database

Zorunlu. Oluşturulacak veritabanı.
database_id

string

Zorunlu. Veritabanı için kullanılacak kimlik ve veritabanının kaynak adının son bileşeni haline gelir.

Bu değer 4-63 karakter uzunluğunda olmalıdır. Geçerli karakterler /[a-z][0-9]-/ şeklindedir. İlk karakteri bir harf ve son karakteri bir harf veya bir rakamdır. 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.

CreateIndexRequest

FirestoreAdmin.CreateIndex isteği.

Alanlar
parent

string

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

Index

Zorunlu. Oluşturulacak bileşik dizin.

Günlük Yinelenme

Bu türde alan yok.

Her gün çalıştırılan yinelenen bir programı temsil eder.

Saat dilimi UTC'dir.

Veritabanı

Cloud Firestore Veritabanı.

Alanlar
name

string

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

string

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

Timestamp

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

Timestamp

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

Timestamp

Yalnızca çıkış. Bu veritabanının silindiği zaman damgası. Yalnızca veritabanı silindiyse ayarlanır.
location_id

string

Veritabanının konumu. Kullanılabildiği konumlar https://cloud.google.com/firestore/docs/locations adresinde listelenmiştir.
type

DatabaseType

Veritabanının türü. Nasıl seçim yapabileceğiniz hakkında bilgi için https://cloud.google.com/datastore/docs/firestore-or-datastore adresini ziyaret edin.
concurrency_mode

ConcurrencyMode

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

Duration

Yalnızca çıkış. Verilerin geçmiş sürümlerinin veritabanında tutulduğu dönem.

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

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

Timestamp

Yalnızca çıkış. Verilerin eski sürümlerinin veritabanından okunabildiği en erken zaman damgası. Yukarıdaki [version_retention_period] sayfasına bakın; bu alan now - version_retention_period ile doldurulur.

Bu değer sürekli olarak güncellenir ve sorgulandığı anda eskir. Verileri kurtarmak için bu değeri 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.
point_in_time_recovery_enablement

PointInTimeRecoveryEnablement

Bu veritabanında PITR özelliğinin etkinleştirilip etkinleştirilmeyeceğini belirler.
app_engine_integration_mode

AppEngineIntegrationMode

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

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. Bu durumda, URL kodlamalı anahtarlar için kullanılacak appid öğesi project_id olacaktır (ör. v~foo yerine foo).
delete_protection_state

DeleteProtectionState

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

CmekConfig

İsteğe bağlı. Bulunma, CMEK'nin bu veritabanı için etkinleştirildiğini gösterir.
previous_id

string

Yalnızca çıkış. Veritabanı kaynağının önceki veritabanı kimliği. Bu alan yalnızca silinen veritabanları için doldurulur.
etag

string

Bu sağlama toplamı, diğer alanların değerine bağlı olarak sunucu tarafından 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.

AppEngineIntegrationMode

App Engine entegrasyon modunun türü.

Sıralamalar
APP_ENGINE_INTEGRATION_MODE_UNSPECIFIED Kullanılmıyor.
ENABLED Bu veritabanıyla aynı bölgede bulunan bir App Engine uygulaması varsa App Engine yapılandırması bu veritabanını etkiler. Buna, uygulamanın devre dışı bırakılması ve ve veritabanına yazma işlemlerini devre dışı bırakmanızı sağlar.
DISABLED

App Engine'in, bu veritabanının istekleri yerine getirme özelliği üzerinde herhangi bir etkisi yoktur.

Bu, Firestore API ile oluşturulan veritabanları için varsayılan ayardır.

CmekConfig

Firestore veritabanı için CMEK (Müşteri Tarafından Yönetilen Şifreleme Anahtarı) yapılandırması. Bu komut mevcut değilse veritabanının güvenliği varsayılan Google şifreleme anahtarıyla sağlanır.

Alanlar
kms_key_name

string

Zorunlu. Şifreleme için yalnızca bu veritabanıyla aynı konumda bulunan anahtarların kullanılmasına izin verilir.

Firestore'un nam5 çoklu bölgesi için bu, Cloud KMS çoklu bölge (ABD) değerine 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 adresini ziyaret edin.

Kullanılması beklenen biçim projects/{project_id}/locations/{kms_location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}.
active_key_version[]

string

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

Kullanılması beklenen biçim projects/{project_id}/locations/{kms_location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{key_version}.

EşzamanlılıkModu

İşlemler için eşzamanlılık kontrol modunun türü.

Sıralamalar
CONCURRENCY_MODE_UNSPECIFIED Kullanılmıyor.
OPTIMISTIC Varsayılan olarak iyimser eşzamanlılık kontrolünü kullanın. Bu mod Cloud Firestore veritabanlarında kullanılabilir.
PESSIMISTIC

Kötümser eşzamanlılık kontrolünü varsayılan olarak kullanın. Bu mod Cloud Firestore veritabanlarında kullanılabilir.

Bu, Cloud Firestore için varsayılan ayardır.
OPTIMISTIC_WITH_ENTITY_GROUPS

Varsayılan olarak varlık gruplarıyla iyimser eşzamanlılık kontrolü kullanın.

Cloud Datastore için kullanılabilen tek mod budur.

Bu mod, Datastore Modu ile Cloud Firestore için de kullanılabilir ancak önerilmez.

Veritabanı Türü

Veritabanının türü. Nasıl seçim yapabileceğiniz hakkında bilgi için https://cloud.google.com/datastore/docs/firestore-or-datastore adresini ziyaret edin.

Mod değişikliklerine yalnızca veritabanı boşsa izin verilir.

Sıralamalar
DATABASE_TYPE_UNSPECIFIED Varsayılan değerdir. Veritabanı türü atlanırsa bu değer kullanılır.
FIRESTORE_NATIVE Firestore Yerel Modu
DATASTORE_MODE Datastore Modu'nda Firestore.

DeleteProtectionState

Veritabanının silme koruma durumu.

Sıralamalar
DELETE_PROTECTION_STATE_UNSPECIFIED Varsayılan değerdir. Koruma türü belirtilmedi
DELETE_PROTECTION_DISABLED Silme koruması devre dışı
DELETE_PROTECTION_ENABLED Silme koruması etkin

PointInTimeRecoveryEnable

Belirli Bir Noktası Kurtarma Özelliğinin Etkinleştirilmesi.

Sıralamalar
POINT_IN_TIME_RECOVERY_ENABLEMENT_UNSPECIFIED Kullanılmıyor.
POINT_IN_TIME_RECOVERY_ENABLED

Okuma işlemleri, son 7 gün içindeki verilerin seçili sürümlerinde desteklenir:

  • Son bir saat içindeki herhangi bir zaman damgasına göre okuma yapar
  • 1 saatten sonraki 7 gün içindeki 1 dakikalık anlık görüntülerde okuma yapar

version_retention_period ve earliest_version_time, desteklenen sürümleri belirlemek için kullanılabilir.
POINT_IN_TIME_RECOVERY_DISABLED Okuma işlemleri, son 1 saat içindeki tüm veri sürümlerinde desteklenir.

DeleteBackupRequest

FirestoreAdmin.DeleteBackup isteği.

Alanlar
name

string

Zorunlu. Silinecek yedeğin adı.

biçimi projects/{project}/locations/{location}/backups/{backup} şeklindedir.

DeleteBackupPlanRequest İsteği

[FirestoreAdmin.DeleteBackupSchedules][] için istek.

Alanlar
name

string

Zorunlu. Yedekleme planının adı.

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

DeleteDatabaseMetadata

Bu türde alan yok.

Veritabanı silme işlemiyle ilgili meta veriler.

DeleteDatabaseRequest

FirestoreAdmin.DeleteDatabase isteği.

Alanlar
name

string

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

string

Veritabanının mevcut e etiketi. Bir etag sağlanmışsa ve veritabanının mevcut etag'i ile eşleşmiyorsa silme işlemi engellenir ve FAILED_PRETERMS hatası döndürülür.

DeleteIndexRequest

FirestoreAdmin.DeleteIndex isteği.

Alanlar
name

string

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

ExportDocumentsMetadata

FirestoreAdmin.ExportDocuments kaynağından google.longrunning.Operation sonuçlarının meta verileri.

Alanlar
start_time

Timestamp

Bu işlemin başladığı zaman.
end_time

Timestamp

Bu işlemin tamamlandığı saat. İşlem devam ediyorsa ayarlanmaz.
operation_state

OperationState

Dışa aktarma işleminin durumu.
progress_documents

Progress

Bu işlemin dokümanlardaki ilerleme durumu.
progress_bytes

Progress

Bu işlemin bayt cinsinden ilerleme durumu.
collection_ids[]

string

Dışa aktarılan koleksiyon kimlikleri.
output_uri_prefix

string

Dokümanların aktarıldığı hedef.
namespace_ids[]

string

Hangi ad alanı kimliklerinin dışa aktarıldığı.
snapshot_time

Timestamp

Dışa aktarılan veritabanı sürümüne karşılık gelen zaman damgası. Belirtilmezse dışa aktarılan dokümanların tutarlılığıyla ilgili bir garanti verilmez.

ExportDocumentsRequest

FirestoreAdmin.ExportDocuments isteği.

Alanlar
name

string

Zorunlu. Dışa aktarılacak veritabanı. Şu biçimde olmalıdır: projects/{project_id}/databases/{database_id}.
collection_ids[]

string

Dışa aktarılacak koleksiyon kimlikleri. Belirtilmemiş, tüm koleksiyonlar anlamına gelir. Bu listedeki her koleksiyon kimliği benzersiz olmalıdır.
output_uri_prefix

string

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

string

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

Boş dize öğesi, varsayılan ad alanını temsil eder. Veritabanı varsayılan olmayan ad alanlarında veri içeriyorsa ancak bu verilerin dahil edilmesini istemiyorsa bu kullanılmalıdır. Bu listedeki her ad alanı benzersiz olmalıdır.
snapshot_time

Timestamp

Dışa aktarılacak veritabanı sürümüne karşılık gelen zaman damgası. Zaman damgası geçmişte olmalı, dakikaya yuvarlanmalı 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ığıyla ilgili bir garanti verilmez.

ExportDocumentsResponse

google.longrunning.Operation yanıt alanında döndürüldü.

Alanlar
output_uri_prefix

string

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

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.

Alanlar
name

string

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

Alan yolu, basit bir alan adı olabilir (ör. address veya match_value 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/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/* Bu Field üzerinde tanımlanan dizinler, kendi Field dizin yapılandırmasına sahip olmayan tüm alanlara uygulanacak.
index_config

IndexConfig

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

TtlConfig

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

IndexConfig

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

Alanlar
indexes[]

Index

Bu alan için desteklenen dizinler.
uses_ancestor_config

bool

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

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) alanın ayarlanacağı Field kaynak adını belirtir.
reverting

bool

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ı ancestor_field tarafından belirtilen alanla aynı duruma geçer. Bu noktada uses_ancestor_config, true ve reverting, false olur.

TtlConfig

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

TTL'nin etkin olduğu bir alanda zaman damgası değerinin depolanması, dokümanın mutlak geçerlilik süresi olarak değerlendirilir. Geçmişteki zaman damgası değerleri, dokümanın geçerlilik süresinin hemen sona ermeye uygun olduğunu gösterir. Başka herhangi bir veri türünün kullanılması veya alanın eksik bırakılması, ilgili doküman için geçerlilik süresinin devre dışı bırakılmasına neden olur.

Alanlar
state

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, istenen şekilde TTL'ler uygulanır. Mevcut dokümanlardaki istenen TTL'ler işlenmeye devam ediyor. Tüm mevcut dokümanlardaki TTL'ler işlendiğinde, durum "ACTIVE" olarak değiştirilir.
ACTIVE TTL tüm dokümanlar için etkin.
NEEDS_REPAIR TTL yapılandırması, mevcut tüm dokümanlar için etkinleştirilemedi. Yeni yazılan dokümanlara TTL'si uygulanmaya devam eder. Bu Field için TTL'yi etkinleştirmeye yönelik son deneme başarısız olduğunda döndürülen LRO, daha fazla ayrıntı içerebilir.

FieldOperationMetadata

FirestoreAdmin.UpdateField kaynağından google.longrunning.Operation sonuçlarının meta verileri.

Alanlar
start_time

Timestamp

Bu işlemin başladığı zaman.
end_time

Timestamp

Bu işlemin tamamlandığı saat. İşlem devam ediyorsa ayarlanmaz.
field

string

Bu işlemin etkilendiği alan kaynağı. Örneğin: projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}
index_config_deltas[]

IndexConfigDelta

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

OperationState

İşlemin durumu.
progress_documents

Progress

Bu işlemin dokümanlardaki ilerleme durumu.
progress_bytes

Progress

Bu işlemin bayt cinsinden ilerleme durumu.
ttl_config_delta

TtlConfigDelta

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

IndexConfigDelta

Dizin yapılandırmasındaki değişiklik hakkında bilgiler.

Alanlar
change_type

ChangeType

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

Index

Değiştirilen dizin.

ChangeType

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

Sıralamalar
CHANGE_TYPE_UNSPECIFIED Değişikliğin türü belirtilmedi veya bilinmiyor.
ADD Tek alan dizini ekleniyor.
REMOVE Tek alan dizini kaldırılıyor.

TtlConfigDelta

TTL yapılandırma değişikliğiyle ilgili bilgiler.

Alanlar
change_type

ChangeType

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

ChangeType

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

Sıralamalar
CHANGE_TYPE_UNSPECIFIED Değişikliğin türü belirtilmedi veya bilinmiyor.
ADD TTL yapılandırması ekleniyor.
REMOVE TTL yapılandırması kaldırılıyor.

Yedek İsteği Alın

FirestoreAdmin.GetBackup isteği.

Alanlar
name

string

Zorunlu. Getirilecek yedeğin adı.

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

GetBackupPlanRequest.

FirestoreAdmin.GetBackupSchedule isteği.

Alanlar
name

string

Zorunlu. Yedekleme planının adı.

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

GetDatabaseRequest

FirestoreAdmin.GetDatabase isteği.

Alanlar
name

string

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

GetFieldRequest

FirestoreAdmin.GetField isteği.

Alanlar
name

string

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

GetIndexRequest

FirestoreAdmin.GetIndex isteği.

Alanlar
name

string

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

ImportDocumentsMetadata

FirestoreAdmin.ImportDocuments kaynağından google.longrunning.Operation sonuçlarının meta verileri.

Alanlar
start_time

Timestamp

Bu işlemin başladığı zaman.
end_time

Timestamp

Bu işlemin tamamlandığı saat. İşlem devam ediyorsa ayarlanmaz.
operation_state

OperationState

İçe aktarma işleminin durumu.
progress_documents

Progress

Bu işlemin dokümanlardaki ilerleme durumu.
progress_bytes

Progress

Bu işlemin bayt cinsinden ilerleme durumu.
collection_ids[]

string

İçe aktarılan koleksiyon kimlikleri.
input_uri_prefix

string

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

string

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

ImportDocumentsRequest

FirestoreAdmin.ImportDocuments isteği.

Alanlar
name

string

Zorunlu. İçe aktarılacak veritabanı. Şu biçimde olmalıdır: projects/{project_id}/databases/{database_id}.
collection_ids[]

string

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

string

Dışa aktarılan dosyaların konumu. Bu, başarıyla tamamlanan bir dışa aktarmadaki ExportDocumentsResponse öğesinin çıkış_uri_prefix ile eşleşmesi gerekir. Şu sayfaya göz atın: google.firestore.admin.v1.ExportDocumentsResponse.output_uri_prefix.
namespace_ids[]

string

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

Boş dize öğesi, varsayılan ad alanını temsil eder. Veritabanı varsayılan olmayan ad alanlarında veri içeriyorsa ancak bu verilerin dahil edilmesini istemiyorsa bu kullanılmalıdır. Bu listedeki her ad alanı benzersiz olmalıdır.

Dizin

Cloud Firestore dizinleri, veritabanındaki belgelerde basit ve karmaşık sorgular yapılmasına olanak tanır.

Alanlar
name

string

Yalnızca çıkış. Bu dizin için sunucu tanımlı bir ad. Bileşik dizinler için bu adın biçimi şöyledir: projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{composite_index_id} Tek alanlı dizinler için bu alan boş bırakılır.
query_scope

QueryScope

Koleksiyon sorgu kapsamı belirtilen dizinler; sorgu zamanında belirtilen ve aynı koleksiyon kimliğine sahip belirli bir dokümanın alt öğesi olan bir koleksiyona yönelik sorgulara izin verir.

Belirtilen koleksiyon grubu sorgu kapsamına sahip dizinler, belirli bir dokümandan türetilen, sorgu sırasında belirtilen ve bu dizinle aynı koleksiyon kimliğine sahip tüm koleksiyonlardaki sorgulara izin verir.
api_scope

ApiScope

Bu dizin tarafından desteklenen API kapsamı.
fields[]

IndexField

Bu dizin tarafından desteklenen alanlar.

Bileşik dizinler için en az 2, en fazla 100 alan gerekir. 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 bir dizindeki son alan yönlü değilse __name__, ASCENDING olarak sıralanır (açıkça belirtilmedikçe).

Tek alanlı dizinler için bu, her zaman ilişkili alanın alan yoluna eşit olan bir alan yoluna sahip tam olarak tek bir giriş olacaktır.
state

State

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

APIKapsamı

API Kapsamı, sorgular için desteklenen API'leri (Firestore Yerel veya Datastore Modu'nda Firestore) tanımlar.

Sıralamalar
ANY_API Dizin yalnızca Firestore Yerel sorgu API'si tarafından kullanılabilir. Bu, varsayılan ayardır.
DATASTORE_MODE_API Dizin yalnızca Datastore Modu'nda Firestore sorgu API'si tarafından kullanılabilir.

Dizin Alanı

Dizindeki bir alan. Field_path hangi alanın dizine eklendiğini, value_mode ise alan değerinin nasıl dizine eklendiğini açıklar.

Alanlar
field_path

string

name olabilir. Tek alanlı dizinler için bu ad, alanın adıyla eşleşmelidir, aksi takdirde atlanabilir.
Birleştirme alanı value_mode. Alan değerinin dizine eklenme şekli. value_mode şunlardan yalnızca biri olabilir:
order

Order

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

ArrayConfig

Bu alanın array_value öğelerindeki işlemleri desteklediğini belirtir.
vector_config

VectorConfig

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

ArrayConfig

Desteklenen dizi değeri yapılandırmaları.

Sıralamalar
ARRAY_CONFIG_UNSPECIFIED Dizin, ek dizi sorgularını desteklemez.
CONTAINS Dizin, dizi içerme sorgularını destekler.

Sipariş

Desteklenen sıralamalar.

Sıralamalar
ORDER_UNSPECIFIED Sıralama belirtilmemiş. Geçerli bir seçenek değil.
ASCENDING Alan, artan alan değerine göre sıralanır.
DESCENDING Alan, azalan alan değerine göre sıralanır.

Vektör Yapılandırması

Vektör arama işlemlerini destekleyecek dizin yapılandırması

Alanlar
dimension

int32

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

Sonuçta elde edilen dizin yalnızca bu boyuttaki vektörleri içerir ve aynı boyuta sahip vektör araması için kullanılabilir.
Birleştirme alanı type. Kullanılan dizin türü. type şunlardan yalnızca biri olabilir:
flat

FlatIndex

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

FlatIndex

Bu türde alan yok.

Vektörleri düz bir veri yapısında depolayan ve kapsamlı aramayı destekleyen bir dizin.

QueryScope

Sorgu Kapsamı, sorgunun çalıştırıldığı kapsamı tanımlar. Bu, bir Yapılandırılmış Sorgu'nun from alanında belirtilir.

Sıralamalar
QUERY_SCOPE_UNSPECIFIED Sorgu kapsamı belirtilmedi. Geçerli bir seçenek değil.
COLLECTION Koleksiyon sorgu kapsamı belirtilen dizinler; sorgu zamanında belirtilen ve dizin tarafından belirtilen koleksiyon kimliğine sahip belirli bir dokümanın alt öğesi olan bir koleksiyona yönelik sorgulara izin verir.
COLLECTION_GROUP Bir koleksiyon grubu sorgu kapsamına sahip dizinler, dizin tarafından belirtilen koleksiyon kimliğine sahip tüm koleksiyonlarda sorgulara izin verir.
COLLECTION_RECURSIVE Tüm koleksiyonların üst öğesini dizine ekle. Yalnızca Datastore Modu veritabanları için kullanılabilir.

Eyalet

Bir dizinin durumu. Dizin oluşturma işlemi sırasında bir dizin CREATING durumunda olur. Dizin başarıyla oluşturulursa READY durumuna geçer. Dizin oluşturma işleminde bir sorunla karşılaşılırsa dizin NEEDS_REPAIR durumuna geçer.

Sıralamalar
STATE_UNSPECIFIED Eyalet belirtilmemiş.
CREATING Dizin oluşturuluyor. Dizin için uzun süreli etkin bir işlem var. Doküman yazılırken dizin güncellenir. Bazı dizin verileri mevcut olabilir.
READY Dizin kullanıma hazır. Doküman yazılırken dizin güncellenir. Dizin, geçerli olduğu tüm depolanmış dokümanlardan eksiksiz olarak doldurulur.
NEEDS_REPAIR Dizin oluşturuluyordu ancak bir hata oluştu. Dizin için uzun süreli etkin bir işlem yok ve en son tamamlanan uzun süreli işlem başarısız oldu. Doküman yazılırken dizin güncellenmez. Bazı dizin verileri mevcut olabilir. Bu dizini oluşturmayı son deneyen işlemin neden başarısız olduğunu belirlemek için google.long running.Operations API'sini kullanın, ardından dizini yeniden oluşturun.

IndexOperationMetadata

FirestoreAdmin.CreateIndex kaynağından google.longrunning.Operation sonuçlarının meta verileri.

Alanlar
start_time

Timestamp

Bu işlemin başladığı zaman.
end_time

Timestamp

Bu işlemin tamamlandığı saat. İşlem devam ediyorsa ayarlanmaz.
index

string

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

OperationState

İşlemin durumu.
progress_documents

Progress

Bu işlemin dokümanlardaki ilerleme durumu.
progress_bytes

Progress

Bu işlemin bayt cinsinden ilerleme durumu.

ListBackupPlansRequest

FirestoreAdmin.ListBackupSchedules isteği.

Alanlar
parent

string

Zorunlu. Üst veritabanı.

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

ListBackupPlansYanıtı

FirestoreAdmin.ListBackupSchedules için yanıt.

Alanlar
backup_schedules[]

BackupSchedule

Tüm yedekleme programlarının listesi.

ListBackupsRequest

FirestoreAdmin.ListBackups isteği.

Alanlar
parent

string

Zorunlu. Yedeklemelerin listeleneceği konum.

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

ListBackupsResponse

FirestoreAdmin.ListBackups için yanıt.

Alanlar
backups[]

Backup

Projenin tüm yedeklerinin listesi.
unreachable[]

string

Mevcut yedeklerin getirilemediği konumların listesi.

Bu yanıt, tek bir konuma ulaşılamıyorsa isteklerin tamamını yerine getirmek yerine, kısmi bir sonuç kümesi ve buradan erişilemeyen konumların listesini döndürür. İstek, somut bir hata almak için tek bir konumda yeniden denenebilir.

ListDatabasesRequest

Projenin tüm konumlarındaki Firestore Veritabanlarını listeleme isteği.

Alanlar
parent

string

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

bool

True (doğru) ise silinen kaynakları da döndürür.

ListDatabasesResponse

Bir projeye ait veritabanlarının listesi.

Alanlar
databases[]

Database

Projedeki veritabanları.
unreachable[]

string

Bağımsız veritabanlarıyla ilgili verilerin listelenememesi durumunda buraya kaydedilir.

Bu örnek giriş şöyle olabilir: projects/some_project/locations/some_location Bu, Veritabanının bulunduğu Bulut Bölgesi şu anda kullanılamıyorsa gerçekleşebilir. Bu durumda, veritabanıyla ilgili tüm ayrıntıları alamayız. Bir "Get" işlemi göndererek daha ayrıntılı bir hata mesajı alabilirsiniz (veya kaynak getirme ihtimaliniz de vardır). kaynak veya 'Liste' isteği istekte bulunabilirsiniz.

ListFieldsRequest

FirestoreAdmin.ListFields isteği.

Alanlar
parent

string

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

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 göndermek için indexConfig.usesAncestorConfig:false veya ttlConfig:* içeren bir filtreyle FirestoreAdmin.ListFields öğesini çağırın.
page_size

int32

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

string

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

ListFieldsResponse

FirestoreAdmin.ListFields için yanıt.

Alanlar
fields[]

Field

İstenen alanlar.
next_page_token

string

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

ListIndexesRequest

FirestoreAdmin.ListIndexes isteği.

Alanlar
parent

string

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

string

Liste sonuçlarına uygulanacak filtre.
page_size

int32

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

string

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

ListIndexesResponse

FirestoreAdmin.ListIndexes için yanıt.

Alanlar
indexes[]

Index

İstenen dizinler.
next_page_token

string

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

LocationMetadata

Bu türde alan yok.

google.cloud.location.Location.metadata için meta veri mesajı.

OperationState

İşlemin durumunu açıklar.

Sıralamalar
OPERATION_STATE_UNSPECIFIED Belirtilmedi.
INITIALIZING İstek işlenmek üzere hazırlanıyor.
PROCESSING İstek etkin bir şekilde işleniyor.
CANCELLING Kullanıcı, işlemle ilgili google.long running.Operations.CancelOperation adını aldıktan sonra istek iptal edilme sürecinde.
FINALIZING İstek işlendi ve kesinleştirme aşamasında.
SUCCESSFUL İstek başarıyla tamamlandı.
FAILED İsteğin işlenmesi tamamlandı, ancak bir hatayla karşılaşıldı.
CANCELLED google.long running.Operations.CancelOperation adlı kullanıcının çağrılmasından sonra istek iptal edildi.

İlerleme

İşlemin ilerlemesini açıklar. İş birimi geneldir ve Progress kullanıldığı yere göre yorumlanmalıdır.

Alanlar
estimated_work

int64

Tahmini çalışma miktarı.
completed_work

int64

Tamamlanan iş miktarı.

RestoreDatabaseMetadata

[RestoreDatabase][google.firestore.admin.v1.RestoreDatabase] isteğindeki long-running operation meta verileri.

Alanlar
start_time

Timestamp

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

Timestamp

Geri yüklemenin tamamlandığı saat. Devam eden geri yükleme işlemleri için ayarlanmamıştır.
operation_state

OperationState

Geri yüklemenin işlem durumu.
database

string

Geri yüklenmekte olan veritabanının adı.
backup

string

Geri yüklemenin kaynaklandığı yedeğin adı.
progress_percentage

Progress

Geri yüklemenin ne kadar uzakta olduğu, kalan sürenin tahmini yüzdesi olarak belirtilir.

RestoreDatabaseRequest

[FirestoreAdmin.RestoreDatabase][google.firestore.admin.v1.RestoreDatabase] için istek iletisi.

Alanlar
parent

string

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

string

Zorunlu. Veritabanı için kullanılacak kimlik ve veritabanının kaynak adının son bileşeni haline gelir. Bu veritabanı kimliği, mevcut bir veritabanıyla ilişkili olmamalıdır.

Bu değer 4-63 karakter uzunluğunda olmalıdır. Geçerli karakterler /[a-z][0-9]-/ şeklindedir. İlk karakteri bir harf ve son karakteri bir harf veya bir rakamdır. UUID benzeri /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/ olmamalıdır.

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

Birleştirme alanı source.

source şunlardan yalnızca biri olabilir:
backup

string

Geri yüklenecek yedekleme. Üst kuruluşla aynı projeye ait olmalıdır.

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

UpdateBackupPlanRequest istekleri

FirestoreAdmin.UpdateBackupSchedule isteği.

Alanlar
backup_schedule

BackupSchedule

Zorunlu. Güncellenecek yedekleme programı.
update_mask

FieldMask

Güncellenecek alanların listesi.

GüncellemeDatabaseMetadata

Bu türde alan yok.

Veritabanı güncelleme işlemiyle ilgili meta veriler.

UpdateDatabaseRequest

FirestoreAdmin.UpdateDatabase isteği.

Alanlar
database

Database

Zorunlu. Güncellenecek veritabanı.
update_mask

FieldMask

Güncellenecek alanların listesi.

UpdateFieldRequest

FirestoreAdmin.UpdateField isteği.

Alanlar
field

Field

Zorunlu. Güncellenecek alan.
update_mask

FieldMask

Alana göre bir maske. Belirtilirse alanda yalnızca bu Field_mask tarafından belirtilen yapılandırma güncellenir.

Haftalık Yinelenme

Haftanın belirli bir gününde çalıştırılan yinelenen bir programı temsil eder.

Saat dilimi UTC'dir.

Alanlar
day

DayOfWeek

Çalıştırılacak haftanın günü.

DAY_OF_WEEK_UNSPECIFIED tarihine izin verilmez.