Method: projects.locations.collections.dataStores.controls.list

Lists all Controls by their parent DataStore.

HTTP request

GET https://discoveryengine.googleapis.com/v1/{parent=projects/*/locations/*/collections/*/dataStores/*}/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.