Reference documentation and code samples for the Google Cloud Discovery Engine V1 Client class ListTargetSitesRequest.
Request message for SiteSearchEngineService.ListTargetSites method.
Generated from protobuf message google.cloud.discoveryengine.v1.ListTargetSitesRequest
Namespace
Google \ Cloud \ DiscoveryEngine \ V1Methods
__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 as |
↳ 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 previous |
getParent
Required. The parent site search engine resource name, such as
projects/{project}/locations/{location}/collections/{collection}/dataStores/{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.
| Returns | |
|---|---|
| Type | Description |
string |
|
setParent
Required. The parent site search engine resource name, such as
projects/{project}/locations/{location}/collections/{collection}/dataStores/{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.
| 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 previous ListTargetSites call.
Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to ListTargetSites
must match the call that provided the page token.
| Returns | |
|---|---|
| Type | Description |
string |
|
setPageToken
A page token, received from a previous ListTargetSites call.
Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to ListTargetSites
must 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 as
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. Please see Google\Cloud\DiscoveryEngine\V1\SiteSearchEngineServiceClient::siteSearchEngineName() for help formatting this field. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\DiscoveryEngine\V1\ListTargetSitesRequest |
|