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

ProjectsLocationsDataStoresSiteSearchEngineTargetSites

class ProjectsLocationsDataStoresSiteSearchEngineTargetSites extends Resource (View source)

The "targetSites" collection of methods.

Typical usage is:

 $discoveryengineService = new Google\Service\DiscoveryEngine(...);
 $targetSites = $discoveryengineService->projects_locations_dataStores_siteSearchEngine_targetSites;

Methods

GoogleLongrunningOperation
batchCreate(string $parent, GoogleCloudDiscoveryengineV1BatchCreateTargetSitesRequest $postBody, array $optParams = [])

Creates TargetSite in a batch. (targetSites.batchCreate)

GoogleLongrunningOperation
create(string $parent, GoogleCloudDiscoveryengineV1TargetSite $postBody, array $optParams = [])

Creates a TargetSite. (targetSites.create)

GoogleLongrunningOperation
delete(string $name, array $optParams = [])

Deletes a TargetSite. (targetSites.delete)

GoogleCloudDiscoveryengineV1TargetSite
get(string $name, array $optParams = [])

Gets a TargetSite. (targetSites.get)

GoogleCloudDiscoveryengineV1ListTargetSitesResponse
listProjectsLocationsDataStoresSiteSearchEngineTargetSites(string $parent, array $optParams = [])

Gets a list of TargetSites.

GoogleLongrunningOperation
patch(string $name, GoogleCloudDiscoveryengineV1TargetSite $postBody, array $optParams = [])

Updates a TargetSite. (targetSites.patch)

Details

at line 47
GoogleLongrunningOperation batchCreate(string $parent, GoogleCloudDiscoveryengineV1BatchCreateTargetSitesRequest $postBody, array $optParams = [])

Creates TargetSite in a batch. (targetSites.batchCreate)

Parameters

string $parent

Required. The parent resource shared by all TargetSites being created. projects/{project}/locations/{location}/collections/{collecti on}/dataStores/{data_store}/siteSearchEngine. The parent field in the CreateBookRequest messages must either be empty or match this field.
GoogleCloudDiscoveryengineV1BatchCreateTargetSitesRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleLongrunningOperation

Exceptions

Exception

at line 64
GoogleLongrunningOperation create(string $parent, GoogleCloudDiscoveryengineV1TargetSite $postBody, array $optParams = [])

Creates a TargetSite. (targetSites.create)

Parameters

string $parent

Required. Parent resource name of TargetSite, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{ data_store}/siteSearchEngine.
GoogleCloudDiscoveryengineV1TargetSite $postBody
array $optParams

Optional parameters.

Return Value

GoogleLongrunningOperation

Exceptions

Exception

at line 83
GoogleLongrunningOperation delete(string $name, array $optParams = [])

Deletes a TargetSite. (targetSites.delete)

Parameters

string $name

Required. Full resource name of TargetSite, such as proj ects/{project}/locations/{location}/collections/{collection}/dataStores/{data _store}/siteSearchEngine/targetSites/{target_site}. If the caller does not have permission to access the TargetSite, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested TargetSite does not exist, a NOT_FOUND error is returned.
array $optParams

Optional parameters.

Return Value

GoogleLongrunningOperation

Exceptions

Exception

at line 102
GoogleCloudDiscoveryengineV1TargetSite get(string $name, array $optParams = [])

Gets a TargetSite. (targetSites.get)

Parameters

string $name

Required. Full resource name of TargetSite, such as proj ects/{project}/locations/{location}/collections/{collection}/dataStores/{data _store}/siteSearchEngine/targetSites/{target_site}. If the caller does not have permission to access the TargetSite, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested TargetSite does not exist, a NOT_FOUND error is returned.
array $optParams

Optional parameters.

Return Value

GoogleCloudDiscoveryengineV1TargetSite

Exceptions

Exception

at line 130
GoogleCloudDiscoveryengineV1ListTargetSitesResponse listProjectsLocationsDataStoresSiteSearchEngineTargetSites(string $parent, array $optParams = [])

Gets a list of TargetSites.

(targetSites.listProjectsLocationsDataStoresSiteSearchEngineTargetSites)

Parameters

string $parent

Required. The parent site search engine resource name, such as projects/{project}/locations/{location}/collections/{collection}/dat aStores/{data_store}/siteSearchEngine. If the caller does not have permission to list TargetSites under this site search engine, regardless of whether or not this branch exists, a PERMISSION_DENIED error is returned.
array $optParams

Optional parameters.

Return Value

GoogleCloudDiscoveryengineV1ListTargetSitesResponse

Exceptions

Exception

at line 148
GoogleLongrunningOperation patch(string $name, GoogleCloudDiscoveryengineV1TargetSite $postBody, array $optParams = [])

Updates a TargetSite. (targetSites.patch)

Parameters

string $name

Output only. The fully qualified resource name of the target site. projects/{project}/locations/{location}/collections/{collection }/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site} The target_site_id is system-generated.
GoogleCloudDiscoveryengineV1TargetSite $postBody
array $optParams

Optional parameters.

Return Value

GoogleLongrunningOperation

Exceptions

Exception