Method: indexing.datasources.items.push

Mendorong item ke antrean untuk polling dan update berikutnya.

API ini memerlukan admin atau akun layanan untuk 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

string

Nama item yang akan dimasukkan ke antrean pengindeksan.

Format: datasources/{sourceId}/items/{ID}

Bidang ini harus diisi. Panjang maksimumnya adalah 1.536 karakter.

Isi permintaan

Isi permintaan memuat data dengan struktur berikut:

Representasi JSON 
{
  "item": {
    "name": string,
    "type": enum (PushItem.Type),
    "metadataHash": string,
    "structuredDataHash": string,
    "contentHash": string,
    "payload": string,
    "queue": string,
    "repositoryError": {
      "type": enum (RepositoryError.Type),
      "httpStatusCode": integer,
      "errorMessage": string
    }
  },
  "connectorName": string,
  "debugOptions": {
    object (DebugOptions)
  }
}
Kolom
item.type

enum (PushItem.Type)

Jenis operasi push yang menentukan perilaku push.
item.metadataHash

string

Hash metadata item sesuai dengan repositori. Jika ditentukan, ini digunakan untuk menentukan cara mengubah status item ini. Menetapkan kolom ini dan kolom type akan menyebabkan error argumen. Panjang maksimumnya adalah 2048 karakter.
item.structuredDataHash

string

Hash data terstruktur item sesuai dengan repositori. Jika ditentukan, ini digunakan untuk menentukan cara mengubah status item ini. Menetapkan kolom ini dan kolom type akan menyebabkan error argumen. Panjang maksimumnya adalah 2048 karakter.
item.contentHash

string

Hash konten item sesuai dengan repositori. Jika ditentukan, ini digunakan untuk menentukan cara mengubah status item ini. Menetapkan kolom ini dan kolom type akan menyebabkan error argumen. Panjang maksimumnya adalah 2048 karakter.
item.payload

string (bytes format)

Memberikan informasi status dokumen tambahan untuk konektor, seperti ID repositori alternatif dan metadata lainnya. Panjang maksimumnya adalah 8.192 byte.

String berenkode base64.
item.queue

string

Antrean yang berisi item ini. Antrean default dipilih jika kolom ini tidak ditentukan. Panjang maksimumnya adalah 512 karakter.
item.repositoryError

object (RepositoryError)

Isi kolom ini untuk menyimpan detail error Konektor atau repositori. Informasi ini ditampilkan di Konsol Admin. Kolom ini hanya dapat diisi jika type adalah REPOSITORY_ERROR.
connectorName

string

Nama konektor yang melakukan panggilan ini.

Format: datasources/{sourceId}/connectors/{ID}
debugOptions

object (DebugOptions)

Opsi debug umum.

Isi respons

Jika berhasil, isi respons memuat 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 mengetahui informasi selengkapnya, lihat Panduan otorisasi.

PushItem

Merepresentasikan item yang akan dikirim ke antrean pengindeksan.

Representasi JSON 
{
  "name": string,
  "type": enum (PushItem.Type),
  "metadataHash": string,
  "structuredDataHash": string,
  "contentHash": string,
  "payload": string,
  "queue": string,
  "repositoryError": {
    object (RepositoryError)
  }
}
Kolom
name

string

Nama item yang akan dimasukkan ke antrean pengindeksan.

Format: datasources/{sourceId}/items/{ID}

Bidang ini harus diisi. Panjang maksimumnya adalah 1.536 karakter.
type

enum (PushItem.Type)

Jenis operasi push yang menentukan perilaku push.
metadataHash

string

Hash metadata item sesuai dengan repositori. Jika ditentukan, ini digunakan untuk menentukan cara mengubah status item ini. Menetapkan kolom ini dan kolom type akan menyebabkan error argumen. Panjang maksimumnya adalah 2048 karakter.
structuredDataHash

string

Hash data terstruktur item sesuai dengan repositori. Jika ditentukan, ini digunakan untuk menentukan cara mengubah status item ini. Menetapkan kolom ini dan kolom type akan menyebabkan error argumen. Panjang maksimumnya adalah 2048 karakter.
contentHash

string

Hash konten item sesuai dengan repositori. Jika ditentukan, ini digunakan untuk menentukan cara mengubah status item ini. Menetapkan kolom ini dan kolom type akan menyebabkan error argumen. Panjang maksimumnya adalah 2048 karakter.
payload

string (bytes format)

Memberikan informasi status dokumen tambahan untuk konektor, seperti ID repositori alternatif dan metadata lainnya. Panjang maksimumnya adalah 8.192 byte.

String berenkode base64.
queue

string

Antrean yang berisi item ini. Antrean default dipilih jika kolom ini tidak ditentukan. Panjang maksimumnya adalah 512 karakter.
repositoryError

object (RepositoryError)

Isi kolom ini untuk menyimpan detail error Konektor atau repositori. Informasi ini ditampilkan di Konsol Admin. Kolom ini hanya dapat diisi jika type adalah REPOSITORY_ERROR.

PushItem.Type

Jenis operasi push yang menentukan perilaku push.

Enum
UNSPECIFIED Default UNSPECIFIED. Menentukan bahwa operasi push tidak boleh mengubah ItemStatus
MODIFIED Menunjukkan bahwa dokumen repositori telah diubah atau diperbarui sejak panggilan update sebelumnya. Tindakan ini akan mengubah status menjadi status MODIFIED untuk item yang ada. Jika dipanggil pada item yang tidak ada, statusnya akan diubah menjadi NEW_ITEM.
NOT_MODIFIED Item di 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. Mengubah status menjadi status REPOSITORY_ERROR. Item tidak direservasi dan dijadwalkan ulang pada waktu mendatang yang ditentukan oleh backoff eksponensial.
REQUEUE Panggilan push dengan REQUEUE hanya untuk item yang telah direservasi. Tindakan ini membatalkan reservasi item dan mereset waktu tersedianya ke waktu jam dinding.