Reference documentation and code samples for the Google Cloud Discovery Engine V1 Client class DeleteSitemapRequest.
Request message for SiteSearchEngineService.DeleteSitemap method.
Generated from protobuf message google.cloud.discoveryengine.v1.DeleteSitemapRequest
Namespace
Google \ Cloud \ DiscoveryEngine \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Required. Full resource name of Sitemap, such as |
getName
Required. Full resource name of
Sitemap, such as
projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/sitemaps/{sitemap}.
If the caller does not have permission to access the Sitemap, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested Sitemap does not exist, a NOT_FOUND error is returned.
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Required. Full resource name of
Sitemap, such as
projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/sitemaps/{sitemap}.
If the caller does not have permission to access the Sitemap, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested Sitemap 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
Sitemap, such as
If the caller does not have permission to access the Sitemap, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested Sitemap does not exist, a NOT_FOUND error is returned. Please see SiteSearchEngineServiceClient::sitemapName() for help formatting this field. |
| Returns | |
|---|---|
| Type | Description |
DeleteSitemapRequest |
|