Method: indexing.datasources.items.poll

Melakukan polling untuk item yang tidak direservasi dari antrean pengindeksan dan menandai kumpulan sebagai dicadangkan, dimulai dengan item yang memiliki stempel waktu terlama dari prioritas tertinggi ItemStatus. Urutan prioritasnya adalah sebagai berikut:

ERROR

MODIFIED

NEW_ITEM

ACCEPTED

Melakukan reservasi item memastikan bahwa polling dari thread lain tidak dapat membuat kumpulan yang tumpang-tindih.

Setelah menangani item yang dicadangkan, klien harus mengembalikan item ke status tidak dicadangkan, baik dengan memanggil index, maupun dengan memanggil push dengan jenis REQUEUE.

Item akan otomatis tersedia (tidak direservasi) setelah 4 jam meskipun tidak ada update atau metode push yang dipanggil.

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/{name=datasources/*}/items:poll

URL menggunakan sintaksis gRPC Transcoding.

Parameter jalur

Parameter
name

string

Nama Sumber Data untuk item polling. Format: datasources/{sourceId}

Isi permintaan

Isi permintaan memuat data dengan struktur berikut:

Representasi JSON 
{
  "connectorName": string,
  "statusCodes": [
    enum (ItemStatus.Code)
  ],
  "limit": integer,
  "queue": string,
  "debugOptions": {
    object (DebugOptions)
  }
}
Kolom
connectorName

string

Nama konektor yang melakukan panggilan ini.

Format: datasources/{sourceId}/connectors/{ID}
statusCodes[]

enum (ItemStatus.Code)

Batasi item yang disurvei pada item dengan status berikut.
limit

integer

Jumlah item maksimum untuk ditampilkan.

Nilai maksimum adalah 100 dan nilai defaultnya adalah 20.
queue

string

Nama antrean untuk mengambil item. Jika tidak ditentukan, items.poll akan mengambil dari antrean 'default'. Panjang maksimum adalah 100 karakter.
debugOptions

object (DebugOptions)

Opsi debug umum.

Isi respons

Jika berhasil, isi respons memuat data dengan struktur berikut:

Representasi JSON 
{
  "items": [
    {
      object (Item)
    }
  ]
}
Kolom
items[]

object (Item)

Kumpulan item dari antrean yang tersedia untuk diproses oleh konektor.

Item ini memiliki subkumpulan kolom yang terisi berikut:

version

metadata.hash

structuredData.hash

content.hash

payload

status

queue

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.