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

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
NameDescription
dataarray

Optional. Data for populating the Message object.

↳ parentstring

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

↳ matcherFetchSitemapsRequest\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
TypeDescription
string

setParent

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

Parameter
NameDescription
varstring
Returns
TypeDescription
$this

getMatcher

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

Returns
TypeDescription
FetchSitemapsRequest\Matcher|null

hasMatcher

clearMatcher

setMatcher

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

Parameter
NameDescription
varFetchSitemapsRequest\Matcher
Returns
TypeDescription
$this

static::build

Parameter
NameDescription
parentstring

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

Returns
TypeDescription
FetchSitemapsRequest