Generated from protobuf messagegoogle.cloud.discoveryengine.v1.ListTargetSitesRequest
Namespace
Google \ Cloud \ DiscoveryEngine \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ parent
string
Required. The parent site search engine resource name, such asprojects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine. If the caller does not have permission to listTargetSites under this site search engine, regardless of whether or not this branch exists, a PERMISSION_DENIED error is returned.
↳ page_size
int
Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. The maximum value is 1000; values above 1000 will be coerced to 1000. If this field is negative, an INVALID_ARGUMENT error is returned.
↳ page_token
string
A page token, received from a previousListTargetSitescall. Provide this to retrieve the subsequent page. When paginating, all other parameters provided toListTargetSitesmust match the call that provided the page token.
getParent
Required. The parent site search engine resource name, such asprojects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine.
If the caller does not have permission to listTargetSites under this site
search engine, regardless of whether or not this branch exists, a
PERMISSION_DENIED error is returned.
Returns
Type
Description
string
setParent
Required. The parent site search engine resource name, such asprojects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine.
If the caller does not have permission to listTargetSites under this site
search engine, regardless of whether or not this branch exists, a
PERMISSION_DENIED error is returned.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getPageSize
Requested page size. Server may return fewer items than requested. If
unspecified, server will pick an appropriate default. The maximum value is
1000; values above 1000 will be coerced to 1000.
If this field is negative, an INVALID_ARGUMENT error is returned.
Returns
Type
Description
int
setPageSize
Requested page size. Server may return fewer items than requested. If
unspecified, server will pick an appropriate default. The maximum value is
1000; values above 1000 will be coerced to 1000.
If this field is negative, an INVALID_ARGUMENT error is returned.
Parameter
Name
Description
var
int
Returns
Type
Description
$this
getPageToken
A page token, received from a previousListTargetSitescall.
Provide this to retrieve the subsequent page.
When paginating, all other parameters provided toListTargetSitesmust match the call that provided the page token.
Returns
Type
Description
string
setPageToken
A page token, received from a previousListTargetSitescall.
Provide this to retrieve the subsequent page.
When paginating, all other parameters provided toListTargetSitesmust match the call that provided the page token.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
static::build
Parameter
Name
Description
parent
string
Required. The parent site search engine resource name, such asprojects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine.
If the caller does not have permission to listTargetSites under this site
search engine, regardless of whether or not this branch exists, a
PERMISSION_DENIED error is returned. Please seeSiteSearchEngineServiceClient::siteSearchEngineName()for help formatting this field.
[[["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 ListTargetSitesRequest (1.7.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.7.0 (latest)](/php/docs/reference/cloud-discoveryengine/latest/V1.ListTargetSitesRequest)\n- [1.6.1](/php/docs/reference/cloud-discoveryengine/1.6.1/V1.ListTargetSitesRequest)\n- [1.5.1](/php/docs/reference/cloud-discoveryengine/1.5.1/V1.ListTargetSitesRequest)\n- [1.4.0](/php/docs/reference/cloud-discoveryengine/1.4.0/V1.ListTargetSitesRequest)\n- [1.3.3](/php/docs/reference/cloud-discoveryengine/1.3.3/V1.ListTargetSitesRequest)\n- [1.2.0](/php/docs/reference/cloud-discoveryengine/1.2.0/V1.ListTargetSitesRequest)\n- [1.1.0](/php/docs/reference/cloud-discoveryengine/1.1.0/V1.ListTargetSitesRequest)\n- [1.0.0](/php/docs/reference/cloud-discoveryengine/1.0.0/V1.ListTargetSitesRequest)\n- [0.11.3](/php/docs/reference/cloud-discoveryengine/0.11.3/V1.ListTargetSitesRequest)\n- [0.8.0](/php/docs/reference/cloud-discoveryengine/0.8.0/V1.ListTargetSitesRequest)\n- [0.7.1](/php/docs/reference/cloud-discoveryengine/0.7.1/V1.ListTargetSitesRequest)\n- [0.6.0](/php/docs/reference/cloud-discoveryengine/0.6.0/V1.ListTargetSitesRequest)\n- [0.5.0](/php/docs/reference/cloud-discoveryengine/0.5.0/V1.ListTargetSitesRequest)\n- [0.4.0](/php/docs/reference/cloud-discoveryengine/0.4.0/V1.ListTargetSitesRequest)\n- [0.3.0](/php/docs/reference/cloud-discoveryengine/0.3.0/V1.ListTargetSitesRequest)\n- [0.2.0](/php/docs/reference/cloud-discoveryengine/0.2.0/V1.ListTargetSitesRequest)\n- [0.1.1](/php/docs/reference/cloud-discoveryengine/0.1.1/V1.ListTargetSitesRequest) \nReference documentation and code samples for the Google Cloud Discovery Engine V1 Client class ListTargetSitesRequest.\n\nRequest message for\n[SiteSearchEngineService.ListTargetSites](/php/docs/reference/cloud-discoveryengine/latest/V1.Client.SiteSearchEngineServiceClient#_Google_Cloud_DiscoveryEngine_V1_Client_SiteSearchEngineServiceClient__listTargetSites__)\nmethod.\n\nGenerated from protobuf message `google.cloud.discoveryengine.v1.ListTargetSitesRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ DiscoveryEngine \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getParent\n\nRequired. The parent site search engine resource name, such as\n`projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`.\n\nIf the caller does not have permission to list\n[TargetSite](/php/docs/reference/cloud-discoveryengine/latest/V1.TargetSite)s under this site\nsearch engine, regardless of whether or not this branch exists, a\nPERMISSION_DENIED error is returned.\n\n### setParent\n\nRequired. The parent site search engine resource name, such as\n`projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`.\n\nIf the caller does not have permission to list\n[TargetSite](/php/docs/reference/cloud-discoveryengine/latest/V1.TargetSite)s under this site\nsearch engine, regardless of whether or not this branch exists, a\nPERMISSION_DENIED error is returned.\n\n### getPageSize\n\nRequested page size. Server may return fewer items than requested. If\nunspecified, server will pick an appropriate default. The maximum value is\n1000; values above 1000 will be coerced to 1000.\n\nIf this field is negative, an INVALID_ARGUMENT error is returned.\n\n### setPageSize\n\nRequested page size. Server may return fewer items than requested. If\nunspecified, server will pick an appropriate default. The maximum value is\n1000; values above 1000 will be coerced to 1000.\n\nIf this field is negative, an INVALID_ARGUMENT error is returned.\n\n### getPageToken\n\nA page token, received from a previous `ListTargetSites` call.\n\nProvide this to retrieve the subsequent page.\nWhen paginating, all other parameters provided to `ListTargetSites`\nmust match the call that provided the page token.\n\n### setPageToken\n\nA page token, received from a previous `ListTargetSites` call.\n\nProvide this to retrieve the subsequent page.\nWhen paginating, all other parameters provided to `ListTargetSites`\nmust match the call that provided the page token.\n\n### static::build"]]
