Package google.firestore.admin.v1beta1

Indeks

FirestoreAdmin

Cloud Firestore Admin API.

API ini menyediakan beberapa layanan administratif untuk Cloud Firestore.

Konsep

Project, Database, Namespace, Koleksi, dan Dokumen digunakan seperti yang ditentukan dalam Google Cloud Firestore API.

Operasi: Operasi mewakili pekerjaan yang sedang dilakukan di latar belakang.

Layanan

Indeks

Layanan indeks mengelola indeks Cloud Firestore.

Pembuatan indeks dilakukan secara asinkron. Resource Operation dibuat untuk setiap operasi asinkron tersebut. Status operasi (termasuk error yang ditemukan) dapat dikueri melalui resource Operation.

Metadata

Memberikan metadata dan informasi statistik tentang data di Cloud Firestore. Data yang diberikan sebagai bagian dari API ini mungkin sudah tidak berlaku.

Operasi

Kumpulan Operasi menyediakan catatan tindakan yang dilakukan untuk Project yang ditentukan (termasuk Operasi apa pun yang sedang berlangsung). Operasi tidak dibuat secara langsung, tetapi melalui panggilan pada koleksi atau resource lain.

Operasi yang belum dilakukan dapat dibatalkan. Permintaan untuk membatalkan bersifat asinkron dan Operasi dapat terus berjalan selama beberapa waktu setelah permintaan untuk membatalkan dibuat.

Operasi yang telah selesai dapat dihapus sehingga tidak lagi terdaftar sebagai bagian dari kumpulan Operasi.

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

CreateIndex

rpc CreateIndex(CreateIndexRequest) returns (Operation)

Membuat indeks yang ditentukan. Status awal indeks yang baru dibuat adalah CREATING. Setelah menyelesaikan google.longrunning.Operation yang ditampilkan, statusnya akan menjadi READY. Jika indeks sudah ada, panggilan akan menampilkan status ALREADY_EXISTS.

Selama pembuatan, proses ini dapat menghasilkan error, yang dalam hal ini indeks akan berpindah ke status ERROR. Proses ini dapat dipulihkan dengan memperbaiki data yang menyebabkan error, menghapus indeks dengan delete, lalu membuat ulang indeks dengan create.

Indeks dengan satu kolom tidak dapat dibuat.

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.

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

rpc GetIndex(GetIndexRequest) returns (Index)

Mendapatkan indeks.

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

rpc ListIndexes(ListIndexesRequest) returns (ListIndexesResponse)

Mencantumkan indeks yang cocok dengan filter yang ditentukan.

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 database tempat indeks ini akan diterapkan. Contoh: projects/{project_id}/databases/{database_id}
index

Index

Indeks yang akan dibuat. Kolom nama dan status hanya merupakan output dan akan diabaikan. Indeks kolom tunggal tertentu tidak dapat dibuat atau dihapus.

DeleteIndexRequest

Permintaan untuk FirestoreAdmin.DeleteIndex.

Kolom
name

string

Nama indeks. Contoh: projects/{project_id}/databases/{database_id}/indexes/{index_id}

ExportDocumentsMetadata

Metadata untuk operasi ExportDocuments.

Kolom
start_time

Timestamp

Waktu operasi dimulai.
end_time

Timestamp

Waktu operasi berakhir, baik berhasil maupun tidak. Batalkan penetapan jika operasi masih aktif.
operation_state

OperationState

Status operasi ekspor.
progress_documents

Progress

Perkiraan jumlah dokumen yang diproses.
progress_bytes

Progress

Perkiraan jumlah byte yang diproses.
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.

GetIndexRequest

Permintaan untuk FirestoreAdmin.GetIndex.

Kolom
name

string

Nama indeks. Contoh: projects/{project_id}/databases/{database_id}/indexes/{index_id}

ImportDocumentsMetadata

Metadata untuk operasi ImportDocuments.

Kolom
start_time

Timestamp

Waktu operasi dimulai.
end_time

Timestamp

Waktu operasi berakhir, baik berhasil maupun tidak. Batalkan penetapan jika operasi masih aktif.
operation_state

OperationState

Status operasi impor.
progress_documents

Progress

Perkiraan jumlah dokumen yang diproses.
progress_bytes

Progress

Perkiraan jumlah byte yang diproses.
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.v1beta1.ExportDocumentsResponse.output_uri_prefix.

Indeks

Definisi indeks.

Kolom
name

string

Nama resource indeks. Hanya output.
collection_id

string

ID koleksi yang akan diberlakukan indeks ini. Wajib.
fields[]

IndexField

Kolom yang akan diindeks.
state

State

Status indeks. Hanya output.

Negara Bagian

Status indeks. Selama pembuatan indeks, indeks akan berada dalam status CREATING. Jika berhasil dibuat, indeks akan beralih ke status READY. Jika tidak dapat dibuat, indeks akan bertransisi ke status ERROR.

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

IndexField

Kolom indeks.

Kolom
field_path

string

Jalur kolom. Harus cocok dengan spesifikasi jalur kolom yang dijelaskan oleh [google.firestore.v1beta1.Document.fields][fields]. Jalur kolom khusus __name__ dapat digunakan sendiri atau di akhir jalur. __type__ hanya dapat digunakan di akhir jalur.
mode

Mode

Mode kolom.

Mode

Mode ini menentukan cara kolom diindeks.

Enum
MODE_UNSPECIFIED Mode tidak ditentukan.
ASCENDING Nilai kolom diindeks untuk mendukung pengurutan dalam urutan menaik dan juga membuat kueri berdasarkan <, >, <=, >=, dan =.
DESCENDING Nilai kolom diindeks untuk mendukung pengurutan dalam urutan menurun dan juga membuat kueri berdasarkan <, >, <=, >=, dan =.
ARRAY_CONTAINS Nilai array kolom diindeks untuk mendukung keanggotaan menggunakan kueri ARRAY_CONTAINS.

IndexOperationMetadata

Metadata untuk operasi indeks. Metadata ini mengisi kolom metadata google.longrunning.Operation.

Kolom
start_time

Timestamp

Waktu operasi dimulai.
end_time

Timestamp

Waktu operasi berakhir, baik berhasil maupun tidak. Batalkan penetapan jika operasi masih aktif.
index

string

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

OperationType

Jenis operasi indeks.
cancelled

bool

True jika google.longrunning.Operation dibatalkan. Jika pembatalan sedang berlangsung, dibatalkan akan menjadi benar, tetapi google.longrunning.Operation.done akan salah.
document_progress

Progress

Progres operasi yang ada, diukur dalam jumlah dokumen.

OperationType

Jenis operasi indeks.

Enum
OPERATION_TYPE_UNSPECIFIED Tidak ditentukan. Jangan pernah disetel oleh server.
CREATING_INDEX Operasi sedang membuat indeks. Dimulai oleh panggilan CreateIndex.

ListIndexesRequest

Permintaan untuk FirestoreAdmin.ListIndexes.

Kolom
parent

string

Nama database. Contoh: projects/{project_id}/databases/{database_id}
filter

string
page_size

int32

Ukuran halaman Daftar standar.
page_token

string

Token halaman Daftar standar.

ListIndexesResponse

Respons untuk FirestoreAdmin.ListIndexes.

Kolom
indexes[]

Index

Indeks.
next_page_token

string

Daftar standar token halaman berikutnya.

LocationMetadata

Jenis ini tidak memiliki kolom.

Pesan metadata untuk google.cloud.location.Location.metadata.

OperationState

Berbagai kemungkinan status untuk Operasi yang sedang berlangsung.

Enum
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

Mengukur kemajuan metrik tertentu.

Kolom
work_completed

int64

Perkiraan berapa banyak pekerjaan yang telah diselesaikan. Perhatikan bahwa ini mungkin lebih besar dari work_estimated.
work_estimated

int64

Perkiraan jumlah pekerjaan yang perlu dilakukan. Nol jika estimasi pekerjaan tidak tersedia. Dapat berubah seiring kemajuan pekerjaan.