Method: projects.locations.dataStores.controls.patch

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

Updates a Control.

Control action type cannot be changed. If the Control to update does not exist, a NOT_FOUND error is returned.

HTTP request

PATCH https://discoveryengine.googleapis.com/v1alpha/{control.name=projects/*/locations/*/dataStores/*/controls/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
control.name	string Immutable. Fully qualified name projects/*/locations/global/dataStore/*/controls/*

Query parameters

Parameters
updateMask	string (FieldMask format) Optional. Indicates which fields in the provided Control to update. The following are NOT supported: Control.name Control.solution_type If not set or empty, all supported fields are updated. 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 Control.

Response body

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

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.controls.update

For more information, see the IAM documentation.