Method: projects.locations.collections.engines.patch

Memperbarui Engine

Permintaan HTTP

PATCH https://discoveryengine.googleapis.com/v1beta/{engine.name=projects/*/locations/*/collections/*/engines/*}

URL menggunakan sintaks gRPC Transcoding.

Parameter jalur

Parameter
engine.name

string

Tidak dapat diubah. ID. Nama resource yang sepenuhnya memenuhi syarat dari mesin.

Kolom ini harus berupa string berenkode UTF-8 dengan batas panjang 1024 karakter.

Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine} engine harus terdiri dari 1-63 karakter, dan karakter yang valid adalah /[a-z0-9][a-z0-9-_]*/. Jika tidak, error INVALID_ARGUMENT akan ditampilkan.

Parameter kueri

Parameter
updateMask

string (FieldMask format)

Menunjukkan kolom mana di Engine yang disediakan untuk diperbarui.

Jika kolom yang tidak didukung atau tidak diketahui diberikan, error INVALID_ARGUMENT akan ditampilkan.

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

Isi permintaan

Isi permintaan memuat instance Engine.

Isi respons

Jika berhasil, isi respons akan memuat instance Engine.

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

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

Untuk mengetahui informasi selengkapnya, lihat Authentication Overview.

Izin IAM

Memerlukan izin IAM berikut pada resource name:

  • discoveryengine.engines.update

Untuk mengetahui informasi selengkapnya, baca dokumentasi IAM.