Method: projects.locations.collections.engines.controls.create

Creates a Control.

By default 1000 controls are allowed for a data store. A request can be submitted to adjust this limit. If the Control to create already exists, an ALREADY_EXISTS error is returned.

HTTP request

POST https://discoveryengine.googleapis.com/v1/{parent=projects/*/locations/*/collections/*/engines/*}/controls

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. Full resource name of parent data store. Format: projects/{project}/locations/{location}/collections/{collectionId}/dataStores/{dataStoreId} or projects/{project}/locations/{location}/collections/{collectionId}/engines/{engineId}.

Query parameters

Parameters
controlId

string

Required. The ID to use for the Control, which will become the final component of the Control's resource name.

This value must be within 1-63 characters. Valid characters are /[a-z][0-9]-_/.

Request body

The request body contains an instance of Control.

Response body

If successful, the response body contains a newly created instance of Control.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • discoveryengine.controls.create

For more information, see the IAM documentation.