- Permintaan HTTP
- Parameter lokasi
- Isi permintaan
- Isi respons
- Cakupan Otorisasi
- PushItem
- PushItem.Type
- Cobalah!
Mendorong item ke antrean untuk polling dan pembaruan di lain waktu.
API ini memerlukan admin atau akun layanan agar dapat dieksekusi. Akun layanan yang digunakan adalah akun yang diizinkan di sumber data yang sesuai.
Permintaan HTTP
POST https://cloudsearch.googleapis.com/v1/indexing/{item.name=datasources/*/items/*}:push
URL menggunakan sintaksis gRPC Transcoding.
Parameter jalur
Parameter | |
---|---|
item.name |
Nama Format: sumber data/{sourceId}/items/{ID} Bidang ini harus diisi. Panjang maksimum adalah 1.536 karakter. |
Isi permintaan
Isi permintaan memuat data dengan struktur berikut:
Representasi JSON |
---|
{ "item": { "name": string, "type": enum ( |
Kolom | |
---|---|
item.type |
Jenis operasi push yang menentukan perilaku push. |
item.metadataHash |
Hash metadata item sesuai dengan repositori. Jika ditentukan, atribut ini digunakan untuk menentukan cara mengubah status item ini. Menetapkan kolom ini dan kolom |
item.structuredDataHash |
Hash data terstruktur item sesuai dengan repositori. Jika ditentukan, atribut ini digunakan untuk menentukan cara mengubah status item ini. Menetapkan kolom ini dan kolom |
item.contentHash |
Hash konten item sesuai dengan repositori. Jika ditentukan, atribut ini digunakan untuk menentukan cara mengubah status item ini. Menetapkan kolom ini dan kolom |
item.payload |
Memberikan informasi status dokumen tambahan untuk konektor, seperti ID repositori alternatif dan metadata lainnya. Panjang maksimum adalah 8.192 byte. String berenkode base64. |
item.queue |
Antrean untuk tempat item ini berada. Antrean |
item.repositoryError |
Isi kolom ini untuk menyimpan detail error repositori atau Konektor. Informasi ini ditampilkan di Konsol Admin. Kolom ini hanya dapat diisi jika |
connectorName |
Nama konektor yang melakukan panggilan ini. Format: datasources/{sourceId}/connectors/{ID} |
debugOptions |
Opsi debug umum. |
Isi respons
Jika berhasil, isi respons akan berisi instance Item
.
Cakupan Otorisasi
Memerlukan salah satu cakupan OAuth berikut:
https://www.googleapis.com/auth/cloud_search.indexing
https://www.googleapis.com/auth/cloud_search
Untuk informasi selengkapnya, lihat Panduan otorisasi.
PushItem
Mewakili item yang akan didorong ke antrean pengindeksan.
Representasi JSON |
---|
{ "name": string, "type": enum ( |
Kolom | |
---|---|
name |
Nama Format: sumber data/{sourceId}/items/{ID} Bidang ini harus diisi. Panjang maksimum adalah 1.536 karakter. |
type |
Jenis operasi push yang menentukan perilaku push. |
metadataHash |
Hash metadata item sesuai dengan repositori. Jika ditentukan, atribut ini digunakan untuk menentukan cara mengubah status item ini. Menetapkan kolom ini dan kolom |
structuredDataHash |
Hash data terstruktur item sesuai dengan repositori. Jika ditentukan, atribut ini digunakan untuk menentukan cara mengubah status item ini. Menetapkan kolom ini dan kolom |
contentHash |
Hash konten item sesuai dengan repositori. Jika ditentukan, atribut ini digunakan untuk menentukan cara mengubah status item ini. Menetapkan kolom ini dan kolom |
payload |
Memberikan informasi status dokumen tambahan untuk konektor, seperti ID repositori alternatif dan metadata lainnya. Panjang maksimum adalah 8.192 byte. String berenkode base64. |
queue |
Antrean untuk tempat item ini berada. Antrean |
repositoryError |
Isi kolom ini untuk menyimpan detail error repositori atau Konektor. Informasi ini ditampilkan di Konsol Admin. Kolom ini hanya dapat diisi jika |
PushItem.Type
Jenis operasi push yang menentukan perilaku push.
Enum | |
---|---|
UNSPECIFIED |
Default TIDAK DITENTUKAN. Menentukan bahwa operasi push tidak boleh mengubah ItemStatus |
MODIFIED |
Menunjukkan bahwa dokumen repositori telah diubah atau diperbarui sejak panggilan update sebelumnya. Ini mengubah status menjadi status MODIFIED untuk item yang sudah ada. Jika panggilan ini dipanggil pada item yang tidak ada, statusnya akan diubah menjadi NEW_ITEM . |
NOT_MODIFIED |
Item dalam repositori belum diubah sejak panggilan update terakhir. Operasi push ini akan menetapkan status ke status ACCEPTED . |
REPOSITORY_ERROR |
Konektor mengalami error repositori terkait item ini. Ubah status menjadi status REPOSITORY_ERROR . Item tidak dicadangkan dan dijadwalkan ulang pada waktu mendatang yang ditentukan oleh backoff eksponensial. |
REQUEUE |
Panggil push dengan REQUEUE hanya untuk item yang telah dipesan. Tindakan ini membatalkan reservasi item dan mereset waktu yang tersedia ke waktu jam dinding. |