Google Cloud Discovery Engine V1 Client - Class GetSiteSearchEngineRequest (1.2.0)

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

Request message for SiteSearchEngineService.GetSiteSearchEngine method.

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

Namespace

Google \ Cloud \ DiscoveryEngine \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ name string

Required. Resource name of SiteSearchEngine, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/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.

getName

Required. Resource name of SiteSearchEngine, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/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.

Returns
Type Description
string

setName

Required. Resource name of SiteSearchEngine, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/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.

Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameter
Name Description
name string

Required. Resource name of SiteSearchEngine, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/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. Please see Google\Cloud\DiscoveryEngine\V1\SiteSearchEngineServiceClient::siteSearchEngineName() for help formatting this field.

Returns
Type Description
Google\Cloud\DiscoveryEngine\V1\GetSiteSearchEngineRequest