Google Cloud Discovery Engine V1 Client - Class FetchSitemapsRequest (1.5.0)

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

Request message for SiteSearchEngineService.FetchSitemaps method.

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

Namespace

Google \ Cloud \ DiscoveryEngine \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ parent string

Required. Parent resource name of the SiteSearchEngine, such as projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine.
↳ matcher FetchSitemapsRequest\Matcher

Optional. If specified, fetches the matching Sitemaps. If not specified, fetches all Sitemaps in the DataStore.

getParent

Required. Parent resource name of the SiteSearchEngine, such as projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine.

Returns
Type Description
string

setParent

Required. Parent resource name of the SiteSearchEngine, such as projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine.

Parameter
Name Description
var string
Returns
Type Description
$this

getMatcher

Optional. If specified, fetches the matching Sitemaps. If not specified, fetches all Sitemaps in the DataStore.

Returns
Type Description
FetchSitemapsRequest\Matcher|null

hasMatcher

clearMatcher

setMatcher

Optional. If specified, fetches the matching Sitemaps. If not specified, fetches all Sitemaps in the DataStore.

Parameter
Name Description
var FetchSitemapsRequest\Matcher
Returns
Type Description
$this

static::build

Parameter
Name Description
parent string

Required. Parent resource name of the SiteSearchEngine, such as projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine. Please see SiteSearchEngineServiceClient::siteSearchEngineName() for help formatting this field.
Returns
Type Description
FetchSitemapsRequest