Method: projects.locations.collections.engines.patch

Engine を更新します

HTTP リクエスト

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

この URL では gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
engine.name

string

変更不可。ID。エンジンの完全修飾リソース名。

このフィールドは、長さの上限が 1,024 文字の UTF-8 でエンコードされた文字列にする必要があります。

形式: projects/{project}/locations/{location}/collections/{collection}/engines/{engine} エンジンは 1 ～ 63 文字で、有効な文字は /[a-z0-9][a-z0-9-_]*/ です。それ以外の場合は、INVALID_ARGUMENT エラーが返されます。

クエリ パラメータ

パラメータ
updateMask

string (FieldMask format)

指定された Engine で更新するフィールドを示します。

サポートされていないフィールドや不明なフィールドを指定すると、INVALID_ARGUMENT エラーが返されます。

完全修飾フィールド名のカンマ区切りリスト。例: "user.displayName,photo"。

リクエストの本文

リクエストの本文には Engine のインスタンスが含まれます。

レスポンスの本文

成功した場合、レスポンスの本文には Engine のインスタンスが含まれます。

認可スコープ

次の OAuth スコープのいずれかが必要です。

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

詳細については、Authentication Overview をご覧ください。

IAM 権限

name リソースに対する次の IAM 権限が必要です。

  • discoveryengine.engines.update

詳細については、IAM のドキュメントをご覧ください。