Method: projects.locations.collections.engines.controls.create
Stay organized with collections
Save and categorize content based on your preferences.
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/v1beta/{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.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-03-03 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-03-03 UTC."],[[["This endpoint allows for the creation of a Control, which is limited to 1000 per data store by default, with the option to request an increase."],["The HTTP request to create a Control uses a POST method with a specific URL structure that includes dynamic parameters for project, location, collection, and engine."],["The `controlId` query parameter is mandatory, dictating the Control's resource name and must be a string of 1-63 characters in length, composed of lowercase letters, numbers, hyphens, or underscores."],["Creating a Control requires the `discoveryengine.controls.create` IAM permission on the parent resource, and authorization scopes including `https://www.googleapis.com/auth/cloud-platform`."],["Upon success, a newly created Control instance will be returned in the response body, while requesting to create an existing control will return an ALREADY_EXISTS error."]]],[]]
