Method: projects.locations.collections.indexes.patch

Memperbarui parameter satu Indeks.

Permintaan HTTP

PATCH https://vectorsearch.googleapis.com/v1/{index.name}

Parameter jalur

Parameter
index.name

string

ID. nama resource

Parameter kueri

Parameter
updateMask

string (FieldMask format)

Opsional. Menentukan kolom yang akan ditimpa dalam resource Indeks oleh pembaruan. Kolom yang ditentukan dalam updateMask bersifat relatif terhadap resource, bukan permintaan lengkap. Kolom akan ditimpa jika berada dalam mask. Jika pengguna tidak memberikan mask, semua kolom yang ada dalam permintaan dengan nilai yang tidak kosong akan ditimpa.

Kolom berikut mendukung pembaruan: * displayName * description * labels * dedicatedInfrastructure.autoscaling_spec.min_replica_count * dedicatedInfrastructure.autoscaling_spec.max_replica_count

Jika * diberikan di updateMask, penggantian penuh kolom yang dapat diubah akan dilakukan.

Ini adalah comma-separated list berisi nama kolom yang sepenuhnya memenuhi syarat. Contoh: "user.displayName,photo".

requestId

string

Opsional. ID permintaan opsional untuk mengidentifikasi permintaan. Tentukan ID permintaan unik sehingga jika Anda harus mencoba lagi permintaan, server akan tahu untuk mengabaikan permintaan jika sudah selesai. Server akan menjamin hal tersebut setidaknya selama 60 menit sejak permintaan pertama.

Misalnya, pertimbangkan situasi saat Anda membuat permintaan awal dan waktu permintaan habis. Jika Anda membuat permintaan lagi dengan ID permintaan yang sama, server dapat memeriksa apakah operasi asli dengan ID permintaan yang sama telah diterima, dan jika iya, akan mengabaikan permintaan kedua. Tindakan ini mencegah klien membuat komitmen duplikat secara tidak sengaja.

ID permintaan harus berupa UUID yang valid, kecuali UUID nol tidak didukung (00000000-0000-0000-0000-000000000000).

Isi permintaan

Isi permintaan memuat instance Index.

Isi respons

Jika berhasil, isi respons akan memuat instance Operation.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut:

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

Untuk mengetahui informasi selengkapnya, lihat Authentication Overview.

Izin IAM

Memerlukan izin IAM berikut pada resource name:

  • vectorsearch.indexes.update

Untuk mengetahui informasi selengkapnya, baca dokumentasi IAM.