Discovery Engine V1BETA API - Module Google::Cloud::DiscoveryEngine::V1beta::SiteSearchEngineService::Paths (v0.17.0)

Reference documentation and code samples for the Discovery Engine V1BETA API module Google::Cloud::DiscoveryEngine::V1beta::SiteSearchEngineService::Paths.

Path helper methods for the SiteSearchEngineService API.

Extended By

Methods

#site_search_engine_path

def site_search_engine_path(project:, location:, data_store:) -> ::String
def site_search_engine_path(project:, location:, collection:, data_store:) -> ::String

Create a fully-qualified SiteSearchEngine resource string.

Overloads 
def site_search_engine_path(project:, location:, data_store:) -> ::String
The resource will be in the following format:

projects/{project}/locations/{location}/dataStores/{data_store}/siteSearchEngine

Parameters
  • project (String)
  • location (String)
  • data_store (String) 
def site_search_engine_path(project:, location:, collection:, data_store:) -> ::String
The resource will be in the following format:

projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine

Parameters
  • project (String)
  • location (String)
  • collection (String)
  • data_store (String)
Returns
  • (::String)
Raises
  • (::ArgumentError)

#sitemap_path

def sitemap_path(project:, location:, data_store:, sitemap:) -> ::String
def sitemap_path(project:, location:, collection:, data_store:, sitemap:) -> ::String

Create a fully-qualified Sitemap resource string.

Overloads 
def sitemap_path(project:, location:, data_store:, sitemap:) -> ::String
The resource will be in the following format:

projects/{project}/locations/{location}/dataStores/{data_store}/siteSearchEngine/sitemaps/{sitemap}

Parameters
  • project (String)
  • location (String)
  • data_store (String)
  • sitemap (String) 
def sitemap_path(project:, location:, collection:, data_store:, sitemap:) -> ::String
The resource will be in the following format:

projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/sitemaps/{sitemap}

Parameters
  • project (String)
  • location (String)
  • collection (String)
  • data_store (String)
  • sitemap (String)
Returns
  • (::String)
Raises
  • (::ArgumentError)

#target_site_path

def target_site_path(project:, location:, data_store:, target_site:) -> ::String
def target_site_path(project:, location:, collection:, data_store:, target_site:) -> ::String

Create a fully-qualified TargetSite resource string.

Overloads 
def target_site_path(project:, location:, data_store:, target_site:) -> ::String
The resource will be in the following format:

projects/{project}/locations/{location}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}

Parameters
  • project (String)
  • location (String)
  • data_store (String)
  • target_site (String) 
def target_site_path(project:, location:, collection:, data_store:, target_site:) -> ::String
The resource will be in the following format:

projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}

Parameters
  • project (String)
  • location (String)
  • collection (String)
  • data_store (String)
  • target_site (String)
Returns
  • (::String)
Raises
  • (::ArgumentError)