Package google.firestore.admin.v1beta1

Dizin

FirestoreAdmin

Cloud Firestore Admin API.

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

Kavramlar

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

İşlem: İşlem, arka planda gerçekleştirilen çalışmayı 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 eşzamansız işlemlerin her biri için bir İşlem kaynağı oluşturulur. İşlemin durumu (karşılaşılan tüm hatalar dahil) Operasyon kaynağı aracılığıyla sorgulanabilir.

Meta veri

Cloud Firestore'daki veriler hakkında 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) bir kaydını sağlar. İşlemler doğrudan değil, diğer koleksiyon veya kaynaklara yapılan çağrılar aracılığıyla oluşturulur.

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

Tamamlanan bir işlem silinebilir ve artık İşlem koleksiyonunda listelenmez.

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

CreateIndex

rpc CreateIndex(CreateIndexRequest) returns (Operation)

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

Oluşturma sırasında işlem bir hatayla sonuçlanabilir, bu durumda dizin ERROR durumuna taşınır. Bu işlem, hataya neden olan veriler düzeltilerek, dizin delete ile kaldırılarak, ardından dizin create ile yeniden oluşturularak kurtarılabilir.

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

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ış sayfasına göz atı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ışlardır ve yok sayılır. Belirli tek alanlı dizinler 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

Çalışmanın çalışmaya başladığı saat.
end_time

Timestamp

İşlemin başarıyla veya başka bir şekilde sona erdiği saat. İş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ının tahmini.
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.

GetIndexRequest

FirestoreAdmin.GetIndex isteği.

Alanlar
name

string

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

ImportDocumentsMetadata

ImportDocuments işlemleriyle ilgili meta veriler.

Alanlar
start_time

Timestamp

Çalışmanın çalışmaya başladığı saat.
end_time

Timestamp

İşlemin başarıyla veya başka bir şekilde sona erdiği saat. İş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ının tahmini.
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.v1beta1.ExportDocumentsResponse.output_uri_prefix.

Dizin

Dizin tanımı.

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 durumudur. Dizin oluşturma 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 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.
ERROR 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.

IndexField

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

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

Sıralamalar
MODE_UNSPECIFIED Mod belirtilmedi.
ASCENDING Alanın değerleri, artan düzende sıralamayı destekleyecek ve <, >, <=, >= ve = ile sorgulanmasını destekleyecek şekilde dizine eklenir.
DESCENDING Alanın değerleri, azalan düzende sıralamayı destekleyecek şekilde ve <, >, <=, >= 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şlemleriyle ilgili meta veriler. Bu meta veri, google.longrunning.Operation meta veri alanını doldurur.

Alanlar
start_time

Timestamp

Çalışmanın çalışmaya başladığı saat.
end_time

Timestamp

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

string

Bu işlemin üzerinde işlem yaptığı 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 alır. İptal işlemi devam ediyorsa iptal "true" (doğru), google.longrunning.Operation.done değeri "false" (yanlış) değerini alır.
document_progress

Progress

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

OperationType

Dizin işleminin türü.

Sıralamalar
OPERATION_TYPE_UNSPECIFIED Belirtilmedi. Hiçbir zaman sunucu tarafından ayarlanmaz.
CREATING_INDEX İşlem, dizini oluşturmaktadır. 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 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

Belirli bir metriğin ilerlemesini ölçer.

Alanlar
work_completed

int64

Ne kadar işin tamamlandığına dair bir tahmin. Bu değerin work_estimated değerinden büyük olabileceğini unutmayın.
work_estimated

int64

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