Package google.firestore.admin.v1beta2

Dizin

Firestore Yöneticisi

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

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

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.
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 filtre indexConfig.usesAncestorConfig:false olarak ayarlanmış şekilde FirestoreAdmin.ListFields işlevini ç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.
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.

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

Hangi koleksiyon kimliklerinin dışa aktarıldığı.
output_uri_prefix

string

Varlıkların aktarıldığı hedef.

ExportDocumentsRequest

FirestoreAdmin.ExportDocuments isteği.

Alanlar
name

string

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

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

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.

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.

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

Progress

Bu işlemin dokümanlardaki ilerleme durumu.
bytes_progress

Progress

Bu işlemin bayt cinsinden ilerleme durumu.

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.

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

ImportDocumentsRequest

FirestoreAdmin.ImportDocuments isteği.

Alanlar
name

string

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

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 zamanında belirtilen ve bu dizinle aynı koleksiyon kimliğine sahip tüm koleksiyonlarda 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 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.

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.

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.

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.

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.

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 göndermek için filtre indexConfig.usesAncestorConfig:false olarak ayarlanmış şekilde FirestoreAdmin.ListFields işlevini ç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

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.

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.longstudy.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ı.

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 tarafından belirtilen yapılandırma güncellenir.