Package google.firestore.admin.v1beta2

Indeks

FirestoreAdmin

Operasi dibuat oleh layanan FirestoreAdmin, tetapi diakses melalui layanan google.longrunning.Operations.

CreateIndex

rpc CreateIndex(CreateIndexRequest) returns (Operation)

Membuat indeks komposit. Tindakan ini akan menampilkan google.longrunning.Operation yang dapat digunakan untuk melacak status pembuatan. Metadata untuk operasi akan berupa jenis IndexOperationMetadata.

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

Untuk informasi selengkapnya, lihat Ringkasan Autentikasi.
DeleteIndex

rpc DeleteIndex(DeleteIndexRequest) returns (Empty)

Menghapus indeks komposit.

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

Untuk informasi selengkapnya, lihat Ringkasan Autentikasi.
ExportDocuments

rpc ExportDocuments(ExportDocumentsRequest) returns (Operation)

Mengekspor salinan semua atau sebagian dokumen dari Google Cloud Firestore ke sistem penyimpanan lain, seperti Google Cloud Storage. Perubahan terbaru pada dokumen mungkin tidak ditampilkan dalam ekspor. Ekspor terjadi di latar belakang dan progresnya dapat dipantau serta dikelola melalui resource Operation yang dibuat. Output ekspor hanya dapat digunakan setelah operasi yang terkait selesai. Jika operasi ekspor dibatalkan sebelum selesai, sebagian data mungkin akan tertinggal di Google Cloud Storage.

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

Untuk informasi selengkapnya, lihat Ringkasan Autentikasi.
GetField

rpc GetField(GetFieldRequest) returns (Field)

Mendapatkan metadata dan konfigurasi untuk Kolom.

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

Untuk informasi selengkapnya, lihat Ringkasan Autentikasi.
GetIndex

rpc GetIndex(GetIndexRequest) returns (Index)

Mendapatkan indeks komposit.

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

Untuk informasi selengkapnya, lihat Ringkasan Autentikasi.
ImportDocuments

rpc ImportDocuments(ImportDocumentsRequest) returns (Operation)

Mengimpor dokumen ke Google Cloud Firestore. Dokumen yang ada dengan nama yang sama akan ditimpa. Impor terjadi di latar belakang dan progresnya dapat dipantau serta dikelola melalui resource Operation yang dibuat. Jika operasi ImportDocuments dibatalkan, ada kemungkinan sebagian data telah diimpor ke Cloud Firestore.

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

Untuk informasi selengkapnya, lihat Ringkasan Autentikasi.
ListFields

rpc ListFields(ListFieldsRequest) returns (ListFieldsResponse)

Mencantumkan konfigurasi kolom dan metadata untuk database ini.

Saat ini, FirestoreAdmin.ListFields hanya mendukung kolom listingan yang telah diganti secara eksplisit. Untuk mengeluarkan kueri ini, panggil FirestoreAdmin.ListFields dengan filter yang disetel ke indexConfig.usesAncestorConfig:false.

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

Untuk informasi selengkapnya, lihat Ringkasan Autentikasi.
ListIndexes

rpc ListIndexes(ListIndexesRequest) returns (ListIndexesResponse)

Mencantumkan indeks komposit.

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

Untuk informasi selengkapnya, lihat Ringkasan Autentikasi.
UpdateField

rpc UpdateField(UpdateFieldRequest) returns (Operation)

Memperbarui konfigurasi kolom. Saat ini, pembaruan kolom hanya berlaku untuk konfigurasi indeks kolom tunggal. Namun, panggilan ke FirestoreAdmin.UpdateField harus menyediakan mask kolom untuk menghindari perubahan konfigurasi apa pun yang tidak diketahui pemanggil. Mask kolom harus ditentukan sebagai: { paths: "index_config" }.

Panggilan ini menampilkan google.longrunning.Operation yang dapat digunakan untuk melacak status pembaruan kolom. Metadata untuk operasi akan berupa jenis FieldOperationMetadata.

Untuk mengonfigurasi setelan kolom default untuk database, gunakan Field khusus dengan nama resource: projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/*.

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

Untuk informasi selengkapnya, lihat Ringkasan Autentikasi.

CreateIndexRequest

Permintaan untuk FirestoreAdmin.CreateIndex.

Kolom
parent

string

Nama induk dari formulir projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}
index

Index

Indeks komposit yang akan dibuat.

DeleteIndexRequest

Permintaan untuk FirestoreAdmin.DeleteIndex.

Kolom
name

string

Nama formulir projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}

ExportDocumentsMetadata

Metadata untuk google.longrunning.Operation hasil dari FirestoreAdmin.ExportDocuments.

Kolom
start_time

Timestamp

Waktu operasi ini dimulai.
end_time

Timestamp

Waktu operasi ini selesai. Akan dibatalkan penetapannya jika operasi masih berlangsung.
operation_state

OperationState

Status operasi ekspor.
progress_documents

Progress

Progres operasi ini, dalam dokumen.
progress_bytes

Progress

Progres operasi ini, dalam byte.
collection_ids[]

string

ID koleksi yang diekspor.
output_uri_prefix

string

Tempat tujuan ekspor entitas.

ExportDocumentsRequest

Permintaan untuk FirestoreAdmin.ExportDocuments.

Kolom
name

string

Database yang akan diekspor. Harus dalam bentuk: projects/{project_id}/databases/{database_id}.
collection_ids[]

string

ID koleksi yang akan diekspor. Tidak ditentukan berarti semua koleksi.
output_uri_prefix

string

URI output. Saat ini hanya mendukung URI Google Cloud Storage dalam bentuk: gs://BUCKET_NAME[/NAMESPACE_PATH], dengan BUCKET_NAME sebagai nama bucket Google Cloud Storage dan NAMESPACE_PATH sebagai jalur namespace Google Cloud Storage opsional. Saat memilih nama, pastikan untuk mempertimbangkan panduan penamaan Google Cloud Storage: https://cloud.google.com/storage/docs/naming. Jika URI adalah bucket (tanpa jalur namespace), awalan akan dibuat berdasarkan waktu mulai.

ExportDocumentsResponse

Ditampilkan di kolom respons google.longrunning.Operation.

Kolom
output_uri_prefix

string

Lokasi file output. Ini dapat digunakan untuk memulai impor ke Cloud Firestore (project ini atau project lain) setelah operasi berhasil diselesaikan.

Kolom

Menampilkan satu kolom dalam database.

Kolom dikelompokkan menurut "Grup Koleksi", yang mewakili semua koleksi dalam database dengan ID yang sama.

Kolom
name

string

Nama kolom formulir projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}

Jalur kolom dapat berupa nama kolom sederhana, misalnya address atau jalur ke kolom dalam map_value , misalnya address.city, atau jalur kolom khusus. Satu-satunya kolom khusus yang valid adalah *, yang mewakili kolom apa pun.

Jalur kolom dapat dikutip menggunakan (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),[,]`, serta semua karakter simbol ASCII.

Contoh: (Catatan: Komentar di sini ditulis dalam sintaksis markdown, sehingga ada lapisan tanda kutip terbalik tambahan untuk mewakili blok kode) \address.city`represents a field namedaddress.city, not the map key cityin the fieldaddress. `*`represents a field named*`, bukan kolom apa pun.

Field khusus berisi setelan pengindeksan default untuk semua kolom. Nama resource kolom ini adalah: projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/* Indeks yang ditentukan dalam Field ini akan diterapkan ke semua kolom yang tidak memiliki konfigurasi indeks Field sendiri.
index_config

IndexConfig

Konfigurasi indeks untuk kolom ini. Jika tidak disetel, pengindeksan kolom akan dikembalikan ke konfigurasi yang ditentukan oleh ancestor_field. Untuk menghapus semua indeks untuk kolom ini secara eksplisit, tentukan konfigurasi indeks dengan daftar indeks kosong.

IndexConfig

Konfigurasi indeks untuk kolom ini.

Kolom
indexes[]

Index

Indeks yang didukung untuk kolom ini.
uses_ancestor_config

bool

Hanya output. Jika benar, konfigurasi indeks Field akan disetel dari konfigurasi yang ditentukan oleh ancestor_field. Jika salah, konfigurasi indeks Field akan ditentukan secara eksplisit.
ancestor_field

string

Hanya output. Menentukan nama resource Field yang digunakan untuk menetapkan konfigurasi indeks kolom ini (jika uses_ancestor_config bernilai benar), atau dari mana konfigurasi tersebut akan ditetapkan jika kolom ini tidak memiliki konfigurasi indeks (jika uses_ancestor_config bernilai salah).
reverting

bool

Hanya output Saat benar, konfigurasi indeks Field sedang dalam proses dikembalikan. Setelah selesai, konfigurasi indeks akan bertransisi ke status yang sama dengan kolom yang ditentukan oleh ancestor_field, di mana pada titik uses_ancestor_config akan menjadi true dan reverting akan menjadi false.

FieldOperationMetadata

Metadata untuk google.longrunning.Operation hasil dari FirestoreAdmin.UpdateField.

Kolom
start_time

Timestamp

Waktu operasi ini dimulai.
end_time

Timestamp

Waktu operasi ini selesai. Akan dibatalkan penetapannya jika operasi masih berlangsung.
field

string

Resource kolom yang ditindaklanjuti oleh operasi ini. Contoh: projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}
index_config_deltas[]

IndexConfigDelta

Daftar IndexConfigDelta, yang menjelaskan intent operasi ini.
state

OperationState

Status operasi.
document_progress

Progress

Progres operasi ini, dalam dokumen.
bytes_progress

Progress

Progres operasi ini, dalam byte.

IndexConfigDelta

Informasi tentang perubahan konfigurasi indeks.

Kolom
change_type

ChangeType

Menentukan perubahan indeks.
index

Index

Indeks sedang diubah.

ChangeType

Menentukan perubahan indeks.

Enum
CHANGE_TYPE_UNSPECIFIED Jenis perubahan tidak ditentukan atau diketahui.
ADD Indeks kolom tunggal sedang ditambahkan.
REMOVE Indeks kolom tunggal sedang dihapus.

GetFieldRequest

Permintaan untuk FirestoreAdmin.GetField.

Kolom
name

string

Nama formulir projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_id}

GetIndexRequest

Permintaan untuk FirestoreAdmin.GetIndex.

Kolom
name

string

Nama formulir projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}

ImportDocumentsMetadata

Metadata untuk google.longrunning.Operation hasil dari FirestoreAdmin.ImportDocuments.

Kolom
start_time

Timestamp

Waktu operasi ini dimulai.
end_time

Timestamp

Waktu operasi ini selesai. Akan dibatalkan penetapannya jika operasi masih berlangsung.
operation_state

OperationState

Status operasi impor.
progress_documents

Progress

Progres operasi ini, dalam dokumen.
progress_bytes

Progress

Progres operasi ini, dalam byte.
collection_ids[]

string

ID koleksi mana yang diimpor.
input_uri_prefix

string

Lokasi dokumen yang diimpor.

ImportDocumentsRequest

Permintaan untuk FirestoreAdmin.ImportDocuments.

Kolom
name

string

Database yang akan diimpor. Harus dalam bentuk: projects/{project_id}/databases/{database_id}.
collection_ids[]

string

ID koleksi yang akan diimpor. Tidak ditentukan berarti semua koleksi yang disertakan dalam impor.
input_uri_prefix

string

Lokasi file yang diekspor. Nilai ini harus cocok dengan output_uri_prefix dari ExportDocumentsResponse dari ekspor yang telah berhasil diselesaikan. Lihat: google.firestore.admin.v1beta2.ExportDocumentsResponse.output_uri_prefix.

Indeks

Indeks Cloud Firestore memungkinkan kueri sederhana dan kompleks terhadap dokumen dalam database.

Kolom
name

string

Hanya output. Nama yang ditentukan server untuk indeks ini. Bentuk nama untuk indeks komposit ini adalah: projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{composite_index_id} Untuk indeks kolom tunggal, kolom ini akan kosong.
query_scope

QueryScope

Indeks dengan cakupan kueri koleksi yang ditentukan memungkinkan kueri terhadap koleksi yang merupakan turunan dokumen tertentu, ditentukan pada waktu kueri, dan yang memiliki ID koleksi yang sama.

Indeks dengan cakupan kueri grup koleksi yang ditentukan memungkinkan kueri terhadap semua koleksi yang berasal dari dokumen tertentu, ditentukan pada waktu kueri, dan yang memiliki ID koleksi yang sama dengan indeks ini.
fields[]

IndexField

Kolom yang didukung oleh indeks ini.

Untuk indeks komposit, kolom ini selalu berisi 2 kolom atau lebih. Entri kolom terakhir selalu untuk jalur kolom __name__. Jika saat pembuatan, __name__ tidak ditetapkan sebagai kolom terakhir, kolom tersebut akan otomatis ditambahkan dengan arah yang sama seperti kolom terakhir yang ditentukan. Jika kolom akhir dalam indeks komposit tidak terarah, __name__ akan diurutkan ASCENDING (kecuali ditentukan secara eksplisit).

Untuk indeks kolom tunggal, ini akan selalu tepat satu entri dengan jalur kolom yang sama dengan jalur kolom dari kolom terkait.
state

State

Hanya output. Status penayangan indeks.

IndexField

Kolom dalam indeks. Kolom_path menjelaskan kolom mana yang diindeks, value_mode menjelaskan cara nilai kolom diindeks.

Kolom
field_path

string

Dapat berupa name. Untuk indeks kolom tunggal, ini harus cocok dengan nama kolom atau dapat dihilangkan.
Kolom union value_mode. Cara nilai kolom diindeks. value_mode hanya ada berupa salah satu diantara berikut:
order

Order

Menunjukkan bahwa kolom ini mendukung pengurutan berdasarkan urutan yang ditentukan, atau membandingkan menggunakan =, <, <=, >, >=.
array_config

ArrayConfig

Menunjukkan bahwa kolom ini mendukung operasi pada array_value.

ArrayConfig

Konfigurasi nilai array yang didukung.

Enum
ARRAY_CONFIG_UNSPECIFIED Indeks tidak mendukung kueri array tambahan.
CONTAINS Indeks mendukung kueri pembatasan array.

Pesan

Pengurutan yang didukung.

Enum
ORDER_UNSPECIFIED Urutan tidak ditentukan. Bukan opsi yang valid.
ASCENDING Kolom ini diurutkan berdasarkan nilai kolom menaik.
DESCENDING Kolom ini diurutkan berdasarkan nilai kolom menurun.

QueryScope

Cakupan Kueri menentukan cakupan tempat kueri dijalankan. Ini ditentukan di kolom from StructuredQuery.

Enum
QUERY_SCOPE_UNSPECIFIED Cakupan kueri tidak ditentukan. Bukan opsi yang valid.
COLLECTION Indeks dengan cakupan kueri koleksi yang ditentukan memungkinkan kueri terhadap koleksi yang merupakan turunan dokumen tertentu, ditentukan pada waktu kueri, dan yang memiliki ID koleksi yang ditentukan oleh indeks.
COLLECTION_GROUP Indeks dengan cakupan kueri grup koleksi yang ditentukan memungkinkan kueri terhadap semua koleksi yang memiliki ID koleksi yang ditentukan oleh indeks.

Negara Bagian

Status indeks. Selama pembuatan indeks, indeks akan berada dalam status CREATING. Jika berhasil dibuat, indeks akan beralih ke status READY. Jika pembuatan indeks mengalami masalah, indeks akan bertransisi ke status NEEDS_REPAIR.

Enum
STATE_UNSPECIFIED Status tidak ditentukan.
CREATING Indeks sedang dibuat. Ada operasi jangka panjang yang aktif untuk indeks. Indeks diperbarui saat menulis dokumen. Beberapa data indeks mungkin ada.
READY Indeks siap digunakan. Indeks diperbarui saat menulis dokumen. Indeks terisi penuh dari semua dokumen tersimpan yang berlaku untuknya.
NEEDS_REPAIR Indeks sedang dibuat, tetapi terjadi masalah. Tidak ada operasi jangka panjang yang aktif untuk indeks, dan operasi jangka panjang yang baru saja diselesaikan gagal. Indeks tidak diperbarui saat menulis dokumen. Beberapa data indeks mungkin ada. Gunakan google.longrunning.Operations API untuk mengetahui alasan kegagalan operasi yang terakhir kali mencoba membuat indeks ini, lalu buat ulang indeks.

IndexOperationMetadata

Metadata untuk google.longrunning.Operation hasil dari FirestoreAdmin.CreateIndex.

Kolom
start_time

Timestamp

Waktu operasi ini dimulai.
end_time

Timestamp

Waktu operasi ini selesai. Akan dibatalkan penetapannya jika operasi masih berlangsung.
index

string

Resource indeks yang ditindaklanjuti oleh operasi ini. Contoh: projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}
state

OperationState

Status operasi.
progress_documents

Progress

Progres operasi ini, dalam dokumen.
progress_bytes

Progress

Progres operasi ini, dalam byte.

ListFieldsRequest

Permintaan untuk FirestoreAdmin.ListFields.

Kolom
parent

string

Nama induk dari formulir projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}
filter

string

Filter yang akan diterapkan ke hasil daftar. Saat ini, FirestoreAdmin.ListFields hanya mendukung kolom listingan yang telah diganti secara eksplisit. Untuk mengeluarkan kueri ini, panggil FirestoreAdmin.ListFields dengan filter yang disetel ke indexConfig.usesAncestorConfig:false.
page_size

int32

Jumlah hasil yang akan ditampilkan.
page_token

string

Token halaman, yang ditampilkan dari panggilan sebelumnya ke FirestoreAdmin.ListFields, yang dapat digunakan untuk mendapatkan halaman hasil berikutnya.

ListFieldsResponse

Respons untuk FirestoreAdmin.ListFields.

Kolom
fields[]

Field

Kolom yang diminta.
next_page_token

string

Token halaman yang dapat digunakan untuk meminta halaman hasil lainnya. Jika kosong, ini adalah halaman terakhir.

ListIndexesRequest

Permintaan untuk FirestoreAdmin.ListIndexes.

Kolom
parent

string

Nama induk dari formulir projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}
filter

string

Filter yang akan diterapkan ke hasil daftar.
page_size

int32

Jumlah hasil yang akan ditampilkan.
page_token

string

Token halaman, yang ditampilkan dari panggilan sebelumnya ke FirestoreAdmin.ListIndexes, yang dapat digunakan untuk mendapatkan halaman hasil berikutnya.

ListIndexesResponse

Respons untuk FirestoreAdmin.ListIndexes.

Kolom
indexes[]

Index

Indeks yang diminta.
next_page_token

string

Token halaman yang dapat digunakan untuk meminta halaman hasil lainnya. Jika kosong, ini adalah halaman terakhir.

OperationState

Menjelaskan status operasi.

Enum
OPERATION_STATE_UNSPECIFIED Tidak ditentukan.
INITIALIZING Permintaan sedang disiapkan untuk diproses.
PROCESSING Permintaan sedang aktif diproses.
CANCELLING Permintaan sedang dalam proses dibatalkan setelah pengguna memanggil google.longrunning.Operations.CancelOperation di operasi.
FINALIZING Permintaan telah diproses dan sedang dalam tahap finalisasi.
SUCCESSFUL Permintaan berhasil diselesaikan.
FAILED Permintaan telah selesai diproses, tetapi mengalami error.
CANCELLED Permintaan telah selesai dibatalkan setelah pengguna memanggil google.longrunning.Operations.CancelOperation.

Progres

Menjelaskan kemajuan operasi. Unit kerja bersifat generik dan harus ditafsirkan berdasarkan tempat Progress digunakan.

Kolom
estimated_work

int64

Estimasi jumlah pekerjaan.
completed_work

int64

Jumlah pekerjaan yang diselesaikan.

UpdateFieldRequest

Permintaan untuk FirestoreAdmin.UpdateField.

Kolom
field

Field

Kolom yang akan diperbarui.
update_mask

FieldMask

Mask, relatif terhadap kolom. Jika ditentukan, hanya konfigurasi yang ditentukan oleh field_mask ini yang akan diperbarui di kolom tersebut.