Reference documentation and code samples for the Google Cloud Discovery Engine V1 Client class TargetSite.
A target site for the SiteSearchEngine.
Generated from protobuf messagegoogle.cloud.discoveryengine.v1.TargetSite
Namespace
Google \ Cloud \ DiscoveryEngine \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ name
string
Output only. The fully qualified resource name of the target site.projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}Thetarget_site_idis system-generated.
↳ provided_uri_pattern
string
Required. Input only. The user provided URI pattern from which thegenerated_uri_patternis generated.
↳ type
int
The type of the target site, e.g., whether the site is to be included or excluded.
↳ exact_match
bool
Immutable. If set to false, a uri_pattern is generated to include all pages whose address contains the provided_uri_pattern. If set to true, an uri_pattern is generated to try to be an exact match of the provided_uri_pattern or just the specific page if the provided_uri_pattern is a specific one. provided_uri_pattern is always normalized to generate the URI pattern to be used by the search engine.
↳ generated_uri_pattern
string
Output only. This is system-generated based on the provided_uri_pattern.
↳ root_domain_uri
string
Output only. Root domain of the provided_uri_pattern.
Required. Input only. The user provided URI pattern from which thegenerated_uri_patternis generated.
Returns
Type
Description
string
setProvidedUriPattern
Required. Input only. The user provided URI pattern from which thegenerated_uri_patternis generated.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getType
The type of the target site, e.g., whether the site is to be included or
excluded.
Returns
Type
Description
int
setType
The type of the target site, e.g., whether the site is to be included or
excluded.
Parameter
Name
Description
var
int
Returns
Type
Description
$this
getExactMatch
Immutable. If set to false, a uri_pattern is generated to include all pages
whose address contains the provided_uri_pattern. If set to true, an
uri_pattern is generated to try to be an exact match of the
provided_uri_pattern or just the specific page if the provided_uri_pattern
is a specific one. provided_uri_pattern is always normalized to
generate the URI pattern to be used by the search engine.
Returns
Type
Description
bool
setExactMatch
Immutable. If set to false, a uri_pattern is generated to include all pages
whose address contains the provided_uri_pattern. If set to true, an
uri_pattern is generated to try to be an exact match of the
provided_uri_pattern or just the specific page if the provided_uri_pattern
is a specific one. provided_uri_pattern is always normalized to
generate the URI pattern to be used by the search engine.
Parameter
Name
Description
var
bool
Returns
Type
Description
$this
getGeneratedUriPattern
Output only. This is system-generated based on the provided_uri_pattern.
Returns
Type
Description
string
setGeneratedUriPattern
Output only. This is system-generated based on the provided_uri_pattern.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getRootDomainUri
Output only. Root domain of the provided_uri_pattern.
Returns
Type
Description
string
setRootDomainUri
Output only. Root domain of the provided_uri_pattern.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getSiteVerificationInfo
Output only. Site ownership and validity verification status.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Cloud Discovery Engine V1 Client - Class TargetSite (1.7.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.7.0 (latest)](/php/docs/reference/cloud-discoveryengine/latest/V1.TargetSite)\n- [1.6.1](/php/docs/reference/cloud-discoveryengine/1.6.1/V1.TargetSite)\n- [1.5.1](/php/docs/reference/cloud-discoveryengine/1.5.1/V1.TargetSite)\n- [1.4.0](/php/docs/reference/cloud-discoveryengine/1.4.0/V1.TargetSite)\n- [1.3.3](/php/docs/reference/cloud-discoveryengine/1.3.3/V1.TargetSite)\n- [1.2.0](/php/docs/reference/cloud-discoveryengine/1.2.0/V1.TargetSite)\n- [1.1.0](/php/docs/reference/cloud-discoveryengine/1.1.0/V1.TargetSite)\n- [1.0.0](/php/docs/reference/cloud-discoveryengine/1.0.0/V1.TargetSite)\n- [0.11.3](/php/docs/reference/cloud-discoveryengine/0.11.3/V1.TargetSite)\n- [0.8.0](/php/docs/reference/cloud-discoveryengine/0.8.0/V1.TargetSite)\n- [0.7.1](/php/docs/reference/cloud-discoveryengine/0.7.1/V1.TargetSite)\n- [0.6.0](/php/docs/reference/cloud-discoveryengine/0.6.0/V1.TargetSite)\n- [0.5.0](/php/docs/reference/cloud-discoveryengine/0.5.0/V1.TargetSite)\n- [0.4.0](/php/docs/reference/cloud-discoveryengine/0.4.0/V1.TargetSite)\n- [0.3.0](/php/docs/reference/cloud-discoveryengine/0.3.0/V1.TargetSite)\n- [0.2.0](/php/docs/reference/cloud-discoveryengine/0.2.0/V1.TargetSite)\n- [0.1.1](/php/docs/reference/cloud-discoveryengine/0.1.1/V1.TargetSite) \nReference documentation and code samples for the Google Cloud Discovery Engine V1 Client class TargetSite.\n\nA target site for the SiteSearchEngine.\n\nGenerated from protobuf message `google.cloud.discoveryengine.v1.TargetSite`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ DiscoveryEngine \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getName\n\nOutput only. The fully qualified resource name of the target site.\n\n`projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}`\nThe `target_site_id` is system-generated.\n\n### setName\n\nOutput only. The fully qualified resource name of the target site.\n\n`projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}`\nThe `target_site_id` is system-generated.\n\n### getProvidedUriPattern\n\nRequired. Input only. The user provided URI pattern from which the\n`generated_uri_pattern` is generated.\n\n### setProvidedUriPattern\n\nRequired. Input only. The user provided URI pattern from which the\n`generated_uri_pattern` is generated.\n\n### getType\n\nThe type of the target site, e.g., whether the site is to be included or\nexcluded.\n\n### setType\n\nThe type of the target site, e.g., whether the site is to be included or\nexcluded.\n\n### getExactMatch\n\nImmutable. If set to false, a uri_pattern is generated to include all pages\nwhose address contains the provided_uri_pattern. If set to true, an\nuri_pattern is generated to try to be an exact match of the\nprovided_uri_pattern or just the specific page if the provided_uri_pattern\nis a specific one. provided_uri_pattern is always normalized to\ngenerate the URI pattern to be used by the search engine.\n\n### setExactMatch\n\nImmutable. If set to false, a uri_pattern is generated to include all pages\nwhose address contains the provided_uri_pattern. If set to true, an\nuri_pattern is generated to try to be an exact match of the\nprovided_uri_pattern or just the specific page if the provided_uri_pattern\nis a specific one. provided_uri_pattern is always normalized to\ngenerate the URI pattern to be used by the search engine.\n\n### getGeneratedUriPattern\n\nOutput only. This is system-generated based on the provided_uri_pattern.\n\n### setGeneratedUriPattern\n\nOutput only. This is system-generated based on the provided_uri_pattern.\n\n### getRootDomainUri\n\nOutput only. Root domain of the provided_uri_pattern.\n\n### setRootDomainUri\n\nOutput only. Root domain of the provided_uri_pattern.\n\n### getSiteVerificationInfo\n\nOutput only. Site ownership and validity verification status.\n\n### hasSiteVerificationInfo\n\n### clearSiteVerificationInfo\n\n### setSiteVerificationInfo\n\nOutput only. Site ownership and validity verification status.\n\n### getIndexingStatus\n\nOutput only. Indexing status.\n\n### setIndexingStatus\n\nOutput only. Indexing status.\n\n### getUpdateTime\n\nOutput only. The target site's last updated time.\n\n### hasUpdateTime\n\n### clearUpdateTime\n\n### setUpdateTime\n\nOutput only. The target site's last updated time.\n\n### getFailureReason\n\nOutput only. Failure reason.\n\n### hasFailureReason\n\n### clearFailureReason\n\n### setFailureReason\n\nOutput only. Failure reason."]]
