1. class
  2. Google
  3. \
  4. Service
  5. \
  6. DiscoveryEngine
  7. \
  8. Resource
  9. \
  10. ProjectsLocationsCollectionsDataStoresSiteSearchEngine

ProjectsLocationsCollectionsDataStoresSiteSearchEngine

class ProjectsLocationsCollectionsDataStoresSiteSearchEngine extends Resource (View source)

The "siteSearchEngine" collection of methods.

Typical usage is:

 $discoveryengineService = new Google\Service\DiscoveryEngine(...);
 $siteSearchEngine = $discoveryengineService->projects_locations_collections_dataStores_siteSearchEngine;

Methods

GoogleLongrunningOperation
batchVerifyTargetSites(string $parent, GoogleCloudDiscoveryengineV1BatchVerifyTargetSitesRequest $postBody, array $optParams = [])

Verify target sites' ownership and validity. This API sends all the target sites under site search engine for verification.

GoogleLongrunningOperation
disableAdvancedSiteSearch(string $siteSearchEngine, GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchRequest $postBody, array $optParams = [])

Downgrade from advanced site search to basic site search.

GoogleLongrunningOperation
enableAdvancedSiteSearch(string $siteSearchEngine, GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchRequest $postBody, array $optParams = [])

Upgrade from basic site search to advanced site search.

GoogleCloudDiscoveryengineV1FetchDomainVerificationStatusResponse
fetchDomainVerificationStatus(string $siteSearchEngine, array $optParams = [])

Returns list of target sites with its domain verification status. This method can only be called under data store with BASIC_SITE_SEARCH state at the moment. (siteSearchEngine.fetchDomainVerificationStatus)

GoogleLongrunningOperation
recrawlUris(string $siteSearchEngine, GoogleCloudDiscoveryengineV1RecrawlUrisRequest $postBody, array $optParams = [])

Request on-demand recrawl for a list of URIs. (siteSearchEngine.recrawlUris)

Details

at line 50
GoogleLongrunningOperation batchVerifyTargetSites(string $parent, GoogleCloudDiscoveryengineV1BatchVerifyTargetSitesRequest $postBody, array $optParams = [])

Verify target sites' ownership and validity. This API sends all the target sites under site search engine for verification.

(siteSearchEngine.batchVerifyTargetSites)

Parameters

string $parent

Required. The parent resource shared by all TargetSites being verified. projects/{project}/locations/{location}/collections/{collect ion}/dataStores/{data_store}/siteSearchEngine.
GoogleCloudDiscoveryengineV1BatchVerifyTargetSitesRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleLongrunningOperation

Exceptions

Exception

at line 68
GoogleLongrunningOperation disableAdvancedSiteSearch(string $siteSearchEngine, GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchRequest $postBody, array $optParams = [])

Downgrade from advanced site search to basic site search.

(siteSearchEngine.disableAdvancedSiteSearch)

Parameters

string $siteSearchEngine

Required. Full resource name of the SiteSearchEngine, such as projects/{project}/locations/{location}/dataStores /{data_store_id}/siteSearchEngine.
GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleLongrunningOperation

Exceptions

Exception

at line 86
GoogleLongrunningOperation enableAdvancedSiteSearch(string $siteSearchEngine, GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchRequest $postBody, array $optParams = [])

Upgrade from basic site search to advanced site search.

(siteSearchEngine.enableAdvancedSiteSearch)

Parameters

string $siteSearchEngine

Required. Full resource name of the SiteSearchEngine, such as projects/{project}/locations/{location}/dataStores /{data_store_id}/siteSearchEngine.
GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleLongrunningOperation

Exceptions

Exception

at line 115
GoogleCloudDiscoveryengineV1FetchDomainVerificationStatusResponse fetchDomainVerificationStatus(string $siteSearchEngine, array $optParams = [])

Returns list of target sites with its domain verification status. This method can only be called under data store with BASIC_SITE_SEARCH state at the moment. (siteSearchEngine.fetchDomainVerificationStatus)

Parameters

string $siteSearchEngine

Required. The site search engine resource under which we fetch all the domain verification status. projects/{project}/ locations/{location}/collections/{collection}/dataStores/{data_store}/siteSea rchEngine.
array $optParams

Optional parameters.

Return Value

GoogleCloudDiscoveryengineV1FetchDomainVerificationStatusResponse

Exceptions

Exception

at line 132
GoogleLongrunningOperation recrawlUris(string $siteSearchEngine, GoogleCloudDiscoveryengineV1RecrawlUrisRequest $postBody, array $optParams = [])

Request on-demand recrawl for a list of URIs. (siteSearchEngine.recrawlUris)

Parameters

string $siteSearchEngine

Required. Full resource name of the SiteSearchEngine, such as projects/locations/collections/dataStores/siteSearchEngine.
GoogleCloudDiscoveryengineV1RecrawlUrisRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleLongrunningOperation

Exceptions

Exception