Method: projects.locations.collections.dataStores.getSiteSearchEngine

Gets the SiteSearchEngine.

HTTP request

GET https://discoveryengine.googleapis.com/v1beta/{name=projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. Resource name of SiteSearchEngine, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/siteSearchEngine.

If the caller does not have permission to access the [SiteSearchEngine], regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

Request body

The request body must be empty.

Response body

If successful, the response body contains an instance of SiteSearchEngine.

Authorization scopes

Requires one of the following OAuth scopes:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • discoveryengine.siteSearchEngines.get

For more information, see the IAM documentation.