Package google.firestore.admin.v1beta1

Dizin

Firestore Yöneticisi

Cloud Firestore Admin API.

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

Kavramlar

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

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

Hizmetler

Dizin

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.

Meta veri

Cloud Firestore'daki verilerle ilgili meta veri ve istatistiksel bilgiler sağlar. Bu API'nin bir parçası olarak sağlanan veriler eski olabilir.

İşlem

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.

Henüz tamamlanmamış bir İşlem iptal edilebilir. İptal isteği eşzamansızdır ve işlem, iptal isteği yapıldıktan sonra bir süre daha çalışmaya devam edebilir.

Tamamlanan bir İşlem, artık İşlem koleksiyonunun parçası olarak listelenmemesi için silinebilir.

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

CreateIndex

rpc CreateIndex(CreateIndexRequest) returns (Operation)

Belirtilen dizini oluşturur. Yeni oluşturulan bir dizinin başlangıç durumu: CREATING. Döndürülen google.longrunning.Operation tamamlandığında durum READY olacak. Dizin zaten mevcutsa çağrı bir ALREADY_EXISTS durumu döndürür.

Oluşturma işlemi sırasında işlem bir hatayla sonuçlanabilir. Bu durumda, dizin ERROR durumuna taşınır. Hataya neden olan veriler düzeltilerek, dizinin delete ile kaldırılması ve ardından create ile yeniden oluşturulması bu işlemin kurtarılmasına olanak tanır.

Tek bir alana sahip dizinler oluşturulamaz.

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)

Bir 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ış 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.
GetIndex

rpc GetIndex(GetIndexRequest) returns (Index)

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 Dizinleri

rpc ListIndexes(ListIndexesRequest) returns (ListIndexesResponse)

Belirtilen filtrelerle eşleşen 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.

CreateIndexRequest

FirestoreAdmin.CreateIndex isteği.

Alanlar
parent

string

Bu dizinin uygulanacağı veritabanının adı. Örneğin: projects/{project_id}/databases/{database_id}
index

Index

Oluşturulacak dizin. Ad ve durum alanları yalnızca çıkış olarak oluşturulur ve yoksayılır. Belirli tekli alan dizinleri oluşturulamaz veya silinemez.

DeleteIndexRequest

FirestoreAdmin.DeleteIndex isteği.

Alanlar
name

string

Dizin adı. Örneğin: projects/{project_id}/databases/{database_id}/indexes/{index_id}

ExportDocumentsMetadata

ExportDocuments işlemleri için meta veriler.

Alanlar
start_time

Timestamp

Operasyon çalışmasının başladığı saat.
end_time

Timestamp

İşlemin başarılı veya başka bir şekilde sona erdiği zaman. İşlem hâlâ etkinse ayarı kaldırın.
operation_state

OperationState

Dışa aktarma işleminin durumu.
progress_documents

Progress

İşlenen tahmini doküman sayısı.
progress_bytes

Progress

İşlenen bayt sayısına ilişkin bir tahmindir.
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.

GetIndexRequest

FirestoreAdmin.GetIndex isteği.

Alanlar
name

string

Dizinin adı. Örneğin: projects/{project_id}/databases/{database_id}/indexes/{index_id}

ImportDocumentsMetadata

ImportDocuments işlemleri için meta veriler.

Alanlar
start_time

Timestamp

Operasyon çalışmasının başladığı saat.
end_time

Timestamp

İşlemin başarılı veya başka bir şekilde sona erdiği zaman. İşlem hâlâ etkinse ayarı kaldırın.
operation_state

OperationState

İçe aktarma işleminin durumu.
progress_documents

Progress

İşlenen tahmini doküman sayısı.
progress_bytes

Progress

İşlenen bayt sayısına ilişkin bir tahmindir.
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.v1beta1.ExportDocumentsResponse.output_uri_prefix.

Dizin

Dizin tanımıdır.

Alanlar
name

string

Dizinin kaynak adı. Yalnızca çıkış.
collection_id

string

Bu dizinin geçerli olduğu koleksiyon kimliği. Zorunlu.
fields[]

IndexField

Dizine eklenecek alanlar.
state

State

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

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şturulamıyorsa ERROR 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.
ERROR 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.

Dizin Alanı

Dizin alanı.

Alanlar
field_path

string

Alanın yolu. [google.firestore.v1beta1.Document.fields][fields] tarafından açıklanan alan yolu spesifikasyonuyla eşleşmelidir. __name__ özel alan yolu tek başına veya bir yolun sonunda kullanılabilir. __type__ yalnızca yolun sonunda kullanılabilir.
mode

Mode

Alanın modu.

Mod

Mod, bir alanın nasıl dizine ekleneceğini belirler.

Sıralamalar
MODE_UNSPECIFIED Mod belirtilmedi.
ASCENDING Alanın değerleri, artan sırada sıralamayı destekleyecek ve ayrıca <, >, <=, >= ve = ile sorgulamayı destekleyecek şekilde dizine eklenir.
DESCENDING Alanın değerleri, azalan sırada sıralamayı destekleyecek ve ayrıca <, >, <=, >= ve = ile sorgulamayı destekleyecek şekilde dizine eklenir.
ARRAY_CONTAINS Alanın dizi değerleri, ARRAY_CONTAINS sorguları kullanılarak üyeliği desteklemek için dizine eklenir.

IndexOperationMetadata

Dizin işlemleri için meta veriler. Bu meta veri, google.longrunning.Operation öğesinin meta veri alanını doldurur.

Alanlar
start_time

Timestamp

Operasyon çalışmasının başladığı saat.
end_time

Timestamp

İşlemin başarılı veya başka bir şekilde sona erdiği zaman. İşlem hâlâ etkinse ayarı kaldırın.
index

string

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

OperationType

Dizin işleminin türü.
cancelled

bool

google.longrunning.Operation iptal edildiyse doğru değerini döndürür. İptal işlemi devam ediyorsa iptal edilen doğru olur, google.longrunning.Operation.done ise yanlış değerini alır.
document_progress

Progress

Mevcut işlemin ilerleme durumu (belge sayısı cinsinden ölçülür).

OperationType

Dizin işleminin türü.

Sıralamalar
OPERATION_TYPE_UNSPECIFIED Belirtilmedi. Hiçbir zaman sunucu tarafından ayarlanmaz.
CREATING_INDEX Bu işlem dizini oluşturuyor. Bir CreateIndex araması tarafından başlatıldı.

ListIndexesRequest

FirestoreAdmin.ListIndexes isteği.

Alanlar
parent

string

Veritabanı adı. Örneğin: projects/{project_id}/databases/{database_id}
filter

string
page_size

int32

Standart Liste sayfası boyutu.
page_token

string

Standart liste sayfası jetonu.

ListIndexesResponse

FirestoreAdmin.ListIndexes için yanıt.

Alanlar
indexes[]

Index

Dizinler.
next_page_token

string

Standart Liste sonraki sayfa jetonu.

LocationMetadata

Bu türde alan yok.

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

OperationState

Devam eden bir İşlem için olası çeşitli durumlar.

Sıralamalar
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

Belirli bir metriğin ilerlemesini ölçer.

Alanlar
work_completed

int64

İşin ne kadarının tamamlandığına dair bir tahmin. Bu değer, work_estimated değerinden büyük olabilir.
work_estimated

int64

Ne kadar iş yapılması gerektiğine dair bir tahmin. Çalışma tahmini kullanılamıyorsa sıfırdır. İş ilerledikçe değişebilir.