Google Cloud Discovery Engine V1 Client - Class GetTargetSiteRequest (1.7.0)

Reference documentation and code samples for the Google Cloud Discovery Engine V1 Client class GetTargetSiteRequest.

Request message for SiteSearchEngineService.GetTargetSite method.

Generated from protobuf message google.cloud.discoveryengine.v1.GetTargetSiteRequest

Namespace

Google \ Cloud \ DiscoveryEngine \ V1

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ name
string

Required. Full resource name of TargetSite , such as projects/{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.

getName

Required. Full resource name of TargetSite , such as projects/{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.

Returns
Type
Description
string

setName

Required. Full resource name of TargetSite , such as projects/{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.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

static::build

Parameter
Name
Description
name
string

Required. Full resource name of TargetSite , such as projects/{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. Please see SiteSearchEngineServiceClient::targetSiteName() for help formatting this field.

Returns
Type
Description
Design a Mobile Site
View Site in Mobile | Classic
Share by: