Method: projects.locations.collections.engines.delete

Engine を削除します。

HTTP リクエスト

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

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

パスパラメータ

パラメータ
name

string

必須。Engine の完全なリソース名（projects/{project}/locations/{location}/collections/{collectionId}/engines/{engineId} など）。

呼び出し元に Engine を削除する権限がない場合、Engine が存在するかどうかにかかわらず、PERMISSION_DENIED エラーが返されます。

削除する Engine が存在しない場合は、NOT_FOUND エラーが返されます。

リクエストの本文

リクエストの本文は空にする必要があります。

レスポンスの本文

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

認可スコープ

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

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

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

IAM 権限

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

  • discoveryengine.engines.delete

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