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

Gets a Control.

HTTP request

GET https://discoveryengine.googleapis.com/v1alpha/{name=projects/*/locations/*/collections/*/engines/*/controls/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. The resource name of the Control to get. Format: projects/{project}/locations/{location}/collections/{collectionId}/dataStores/{dataStoreId}/controls/{controlId}

Request body

The request body must be empty.

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
  • https://www.googleapis.com/auth/discoveryengine.serving.readwrite

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • discoveryengine.controls.get

For more information, see the IAM documentation.