Method: projects.locations.collections.engines.patch

• HTTP request
• Path parameters
• Query parameters
• Request body
• Response body
• Authorization scopes
• IAM Permissions

Updates an Engine

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
engine.name	string Immutable. Identifier. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine} engine should be 1-63 characters, and valid characters are /[a-z0-9][a-z0-9-_]*/. Otherwise, an INVALID_ARGUMENT error is returned.

Query parameters

Parameters
updateMask	string (FieldMask format) Indicates which fields in the provided Engine to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned. This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".

Request body

The request body contains an instance of Engine.

Response body

If successful, the response body contains an instance of Engine.

Authorization scopes

Requires one of the following OAuth scopes:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

• discoveryengine.engines.update

For more information, see the IAM documentation.