Method: projects.locations.collections.engines.controls.list
Stay organized with collections
Save and categorize content based on your preferences.
Lists all Controls by their parent DataStore.
HTTP request
GET https://discoveryengine.googleapis.com/v1/{parent=projects/*/locations/*/collections/*/engines/*}/controls
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
parent |
string
Required. The data store resource name. Format: projects/{project}/locations/{location}/collections/{collectionId}/dataStores/{dataStoreId} or projects/{project}/locations/{location}/collections/{collectionId}/engines/{engineId}.
|
Query parameters
| Parameters |
pageSize |
integer
Optional. Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.
|
pageToken |
string
Optional. A page token, received from a previous controls.list call. Provide this to retrieve the subsequent page.
|
filter |
string
Optional. A filter to apply on the list results. Supported features:
- List all the products under the parent branch if
filter is unset. Currently this field is unsupported.
|
Request body
The request body must be empty.
Response body
If successful, the response body contains an instance of ListControlsResponse.
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.list
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 API endpoint lists all Controls associated with a specified parent DataStore or Engine resource, defined by the `parent` path parameter."],["The `pageSize` and `pageToken` query parameters allow for pagination of the results, with a default page size of 50 and a maximum of 1000."],["An optional `filter` query parameter can be used, although it is currently unsupported, meaning all controls under the parent branch will be displayed if the filter is not specified."],["The HTTP request is a `GET` method that requires an empty request body, and the response will be a `ListControlsResponse` object when successful."],["To use this endpoint, the caller needs to be authenticated with the `https://www.googleapis.com/auth/cloud-platform` OAuth scope and have the `discoveryengine.controls.list` IAM permission on the parent resource."]]],[]]
