Package google.firestore.admin.v1beta2

Dizin

FirestoreAdmin

İşlemler FirestoreAdmin hizmeti tarafından oluşturulur ancak google.longrunning.Operations hizmeti üzerinden erişilebilir.

CreateIndex

rpc CreateIndex(CreateIndexRequest) returns (Operation)

Bileşik bir dizin oluşturur. Bu, oluşturma işleminin durumunu izlemek için kullanılabilecek bir google.longrunning.Operation döndürür. İşlemin meta verileri türü IndexOperationMetadata olacaktı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ış sayfasına göz atın.
DeleteIndex

rpc DeleteIndex(DeleteIndexRequest) returns (Empty)

Bir bileşik dizini 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ış sayfasına göz atın.
ExportDocuments

rpc ExportDocuments(ExportDocumentsRequest) returns (Operation)

Google Cloud Firestore'daki dokümanların tümü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 aktarma işlemine yansıtılmayabilir. Dışa aktarma işlemi arka planda gerçekleşir ve ilerleme durumu, oluşturulan işlem kaynağıyla izlenip yönetilebilir. Dışa aktarma çıkışı, yalnızca ilişkili işlem tamamlandığında kullanılabilir. Bir dışa aktarma işlemi tamamlanmadan önce iptal edilirse kısmi veriler Google Cloud Storage'da kalabilir.

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.
GetField

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ış sayfasına göz atı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ış sayfasına göz atın.
ImportDocuments

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şir ve ilerleme durumu, oluşturulan işlem kaynağı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ış sayfasına göz atın.
ListFields

rpc ListFields(ListFieldsRequest) returns (ListFieldsResponse)

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

FirestoreAdmin.ListFields şu anda yalnızca açıkça geçersiz kılınan giriş alanlarını desteklemektedir. Bu sorguyu yayınlamak için filtre indexConfig.usesAncestorConfig:false değerine ayarlı olarak 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ış sayfasına göz atın.
ListIndexes

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ış sayfasına göz atın.
UpdateField

rpc UpdateField(UpdateFieldRequest) returns (Operation)

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: "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 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/{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ış sayfasına göz atın.

CreateIndexRequest

FirestoreAdmin.CreateIndex isteği.

Alanlar
parent

string

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

Index

Oluşturulacak bileşik dizin.

DeleteIndexRequest

FirestoreAdmin.DeleteIndex isteği.

Alanlar
name

string

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

ExportDocumentsMetadata

FirestoreAdmin.ExportDocuments verisindeki google.longrunning.Operation sonuçları meta verileri.

Alanlar
start_time

Timestamp

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

Timestamp

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

OperationState

Dışa aktarma işleminin durumu.
progress_documents

Progress

Bu işlemin ilerleme durumu (belgelerde).
progress_bytes

Progress

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

string

Dışa aktarılan koleksiyon kimlikleri.
output_uri_prefix

string

Varlıkların dışa aktarıldığı hedef.

ExportDocumentsRequest

FirestoreAdmin.ExportDocuments isteği.

Alanlar
name

string

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

string

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

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.

ExportDocumentsResponse

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

Alanlar
output_uri_prefix

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.

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

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.
index_config

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.

IndexConfig

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

Alanlar
indexes[]

Index

Bu alanda desteklenen dizinler.
uses_ancestor_config

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

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.

FieldOperationMetadata

FirestoreAdmin.UpdateField verisindeki google.longrunning.Operation sonuçları meta verileri.

Alanlar
start_time

Timestamp

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

Timestamp

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

string

Bu işlemin üzerinde işlem yaptığı 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.
document_progress

Progress

Bu işlemin ilerleme durumu (belgelerde).
bytes_progress

Progress

Bu işlemin bayt cinsinden ilerleme durumu.

IndexConfigDelta

Dizin yapılandırması değişikliği ile ilgili bilgiler.

Alanlar
change_type

ChangeType

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

Index

Değiştirilmekte olan dizin.

ChangeType

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

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

GetFieldRequest

FirestoreAdmin.GetField isteği.

Alanlar
name

string

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

GetIndexRequest

FirestoreAdmin.GetIndex isteği.

Alanlar
name

string

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

ImportDocumentsMetadata

FirestoreAdmin.ImportDocuments verisindeki google.longrunning.Operation sonuçları meta verileri.

Alanlar
start_time

Timestamp

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

Timestamp

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

OperationState

İçe aktarma işleminin durumu.
progress_documents

Progress

Bu işlemin ilerleme durumu (belgelerde).
progress_bytes

Progress

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

string

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

string

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

ImportDocumentsRequest

FirestoreAdmin.ImportDocuments isteği.

Alanlar
name

string

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

string

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

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.v1beta2.ExportDocumentsResponse.output_uri_prefix.

Dizin

Cloud Firestore dizinleri, veritabanındaki belgelerde basit ve karmaşık sorgular yapılmasını sağlar.

Alanlar
name

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.
query_scope

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.
fields[]

IndexField

Bu dizin tarafından desteklenen alanlar.

Bileşik dizinler için bu her zaman 2 veya daha fazla alandır. 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

State

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

IndexField

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

Ad olabilir. Tek alan dizinleri için bu ad, alanın adıyla eşleşmelidir veya 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 siparişe göre sıralamayı veya =, <, <=, >, >= kullanarak karşılaştırma yapmayı desteklediğini belirtir.
array_config

ArrayConfig

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

ArrayConfig

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

Sıralamalar
ARRAY_CONFIG_UNSPECIFIED Dizin, ek dizi sorgularını desteklemiyor.
CONTAINS Dizin, dizi kapsama sorgularını destekler.

Sipariş

Desteklenen siparişler.

Sıralamalar
ORDER_UNSPECIFIED Sıralama belirtilmedi. 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.

QueryScope

Sorgu Kapsamı, sorgunun çalıştırıldığı kapsamı tanımlar. Bu değer, 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 sorgusu kapsamının belirtildiği dizinler, sorgu zamanında belirtilen ve dizin tarafından belirtilen koleksiyon kimliğine sahip belirli bir belgenin alt öğesi olan bir koleksiyonda sorgulara izin verir.
COLLECTION_GROUP Koleksiyon grubu sorgu kapsamının belirtildiği dizinler, dizin tarafından belirtilen koleksiyon kimliğine sahip tüm koleksiyonlarda yapılan sorgulara izin verir.

Eyalet

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

Sıralamalar
STATE_UNSPECIFIED Durum belirtilmemiş.
CREATING Dizin oluşturuluyor. Dizin için uzun süreli etkin bir işlem mevcut. 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 depolanan dokümanlardan tamamen doldurulur.
NEEDS_REPAIR Dizin oluşturuluyor ancak bir sorun oluştu. Dizin için etkin bir uzun süreli 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şturmaya çalışan en son işlemin neden başarısız olduğunu belirlemek için google.longRun.İşlemler API'sını kullanın ve dizini yeniden oluşturun.

IndexOperationMetadata

FirestoreAdmin.CreateIndex verisindeki google.longrunning.Operation sonuçları meta verileri.

Alanlar
start_time

Timestamp

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

Timestamp

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

string

Bu işlemin üzerinde işlem yaptığı 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 ilerleme durumu (belgelerde).
progress_bytes

Progress

Bu işlemin bayt cinsinden ilerleme durumu.

ListFieldsRequest

FirestoreAdmin.ListFields isteği.

Alanlar
parent

string

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 yayınlamak için filtre indexConfig.usesAncestorConfig:false değerine ayarlı olarak FirestoreAdmin.ListFields yöntemini çağırın.
page_size

int32

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

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.

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 bir sayfa jetonu. Boşsa bu son sayfadır.

ListIndexesRequest

FirestoreAdmin.ListIndexes isteği.

Alanlar
parent

string

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ç sayısı.
page_token

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.

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 bir sayfa jetonu. Boşsa bu son sayfadır.

OperationState

İşlemin durumunu açıklar.

Sıralamalar
OPERATION_STATE_UNSPECIFIED Belirtilmedi.
INITIALIZING İstek işlenmek üzere hazırlanıyor.
PROCESSING İstek etkin olarak işleniyor.
CANCELLING Kullanıcı, işlemde google.long running.Operations.Canceloperas adlı kullanıcıyı çağırdıktan sonra istek iptal edilme sürecindedir.
FINALIZING İstek işlendi ve kesinleşme aşamasında.
SUCCESSFUL İstek başarıyla tamamlandı.
FAILED İsteğin işlenmesi tamamlandı, ancak bir hatayla karşılaşıldı.
CANCELLED Kullanıcının google.longusercontent.Transactions.Canceloperasyonu çağırmasının ardından istek iptal edildi.

İlerleme

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

Alanlar
estimated_work

int64

Tahmin edilen iş miktarı.
completed_work

int64

Tamamlanan çalışma miktarı.

UpdateFieldRequest

FirestoreAdmin.UpdateField isteği.

Alanlar
field

Field

Güncellenecek alan.
update_mask

FieldMask

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