site_search_engine

Creates, updates, deletes, gets or lists a site_search_engine resource.

Overview

Name	site_search_engine
Type	Resource
Id	google.discoveryengine.site_search_engine

Fields

The following fields are returned by SELECT queries:

SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
projects_locations_collections_data_stores_site_search_engine_enable_advanced_site_search	exec	projectsId, locationsId, collectionsId, dataStoresId		Upgrade from basic site search to advanced site search.
projects_locations_collections_data_stores_site_search_engine_disable_advanced_site_search	exec	projectsId, locationsId, collectionsId, dataStoresId		Downgrade from advanced site search to basic site search.
projects_locations_collections_data_stores_site_search_engine_recrawl_uris	exec	projectsId, locationsId, collectionsId, dataStoresId		Request on-demand recrawl for a list of URIs.
projects_locations_collections_data_stores_site_search_engine_batch_verify_target_sites	exec	projectsId, locationsId, collectionsId, dataStoresId		Verify target sites' ownership and validity. This API sends all the target sites under site search engine for verification.
projects_locations_data_stores_site_search_engine_enable_advanced_site_search	exec	projectsId, locationsId, dataStoresId		Upgrade from basic site search to advanced site search.
projects_locations_data_stores_site_search_engine_disable_advanced_site_search	exec	projectsId, locationsId, dataStoresId		Downgrade from advanced site search to basic site search.
projects_locations_data_stores_site_search_engine_recrawl_uris	exec	projectsId, locationsId, dataStoresId		Request on-demand recrawl for a list of URIs.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
collectionsId	string
dataStoresId	string
locationsId	string
projectsId	string

Lifecycle Methods

projects_locations_collections_data_stores_site_search_engine_enable_advanced_site_search

Upgrade from basic site search to advanced site search.

EXEC google.discoveryengine.site_search_engine.projects_locations_collections_data_stores_site_search_engine_enable_advanced_site_search 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@collectionsId='{{ collectionsId }}' --required, 
@dataStoresId='{{ dataStoresId }}' --required;

projects_locations_collections_data_stores_site_search_engine_disable_advanced_site_search

Downgrade from advanced site search to basic site search.

EXEC google.discoveryengine.site_search_engine.projects_locations_collections_data_stores_site_search_engine_disable_advanced_site_search 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@collectionsId='{{ collectionsId }}' --required, 
@dataStoresId='{{ dataStoresId }}' --required;

projects_locations_collections_data_stores_site_search_engine_recrawl_uris

Request on-demand recrawl for a list of URIs.

EXEC google.discoveryengine.site_search_engine.projects_locations_collections_data_stores_site_search_engine_recrawl_uris 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@collectionsId='{{ collectionsId }}' --required, 
@dataStoresId='{{ dataStoresId }}' --required 
@@json=
'{
"uris": "{{ uris }}", 
"siteCredential": "{{ siteCredential }}"
}';

projects_locations_collections_data_stores_site_search_engine_batch_verify_target_sites

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

EXEC google.discoveryengine.site_search_engine.projects_locations_collections_data_stores_site_search_engine_batch_verify_target_sites 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@collectionsId='{{ collectionsId }}' --required, 
@dataStoresId='{{ dataStoresId }}' --required;

projects_locations_data_stores_site_search_engine_enable_advanced_site_search

Upgrade from basic site search to advanced site search.

EXEC google.discoveryengine.site_search_engine.projects_locations_data_stores_site_search_engine_enable_advanced_site_search 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@dataStoresId='{{ dataStoresId }}' --required;

projects_locations_data_stores_site_search_engine_disable_advanced_site_search

Downgrade from advanced site search to basic site search.

EXEC google.discoveryengine.site_search_engine.projects_locations_data_stores_site_search_engine_disable_advanced_site_search 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@dataStoresId='{{ dataStoresId }}' --required;

projects_locations_data_stores_site_search_engine_recrawl_uris

Request on-demand recrawl for a list of URIs.

EXEC google.discoveryengine.site_search_engine.projects_locations_data_stores_site_search_engine_recrawl_uris 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@dataStoresId='{{ dataStoresId }}' --required 
@@json=
'{
"uris": "{{ uris }}", 
"siteCredential": "{{ siteCredential }}"
}';