com.google.api.services.discoveryengine.v1

Class DiscoveryEngine.Projects.Locations.Collections.DataStores.SiteSearchEngine

java.lang.Object

com.google.api.services.discoveryengine.v1.DiscoveryEngine.Projects.Locations.Collections.DataStores.SiteSearchEngine

Enclosing class:

DiscoveryEngine.Projects.Locations.Collections.DataStores

public class DiscoveryEngine.Projects.Locations.Collections.DataStores.SiteSearchEngine
extends Object

The "siteSearchEngine" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	DiscoveryEngine.Projects.Locations.Collections.DataStores.SiteSearchEngine.BatchVerifyTargetSites
class	DiscoveryEngine.Projects.Locations.Collections.DataStores.SiteSearchEngine.DisableAdvancedSiteSearch
class	DiscoveryEngine.Projects.Locations.Collections.DataStores.SiteSearchEngine.EnableAdvancedSiteSearch
class	DiscoveryEngine.Projects.Locations.Collections.DataStores.SiteSearchEngine.FetchDomainVerificationStatus
class	DiscoveryEngine.Projects.Locations.Collections.DataStores.SiteSearchEngine.Operations The "operations" collection of methods.
class	DiscoveryEngine.Projects.Locations.Collections.DataStores.SiteSearchEngine.RecrawlUris
class	DiscoveryEngine.Projects.Locations.Collections.DataStores.SiteSearchEngine.Sitemaps The "sitemaps" collection of methods.
class	DiscoveryEngine.Projects.Locations.Collections.DataStores.SiteSearchEngine.TargetSites The "targetSites" collection of methods.

Constructor Summary

Constructors

Constructor and Description
SiteSearchEngine()

Method Summary

Modifier and Type	Method and Description
DiscoveryEngine.Projects.Locations.Collections.DataStores.SiteSearchEngine.BatchVerifyTargetSites	batchVerifyTargetSites(String parent, GoogleCloudDiscoveryengineV1BatchVerifyTargetSitesRequest content) Verify target sites' ownership and validity.
DiscoveryEngine.Projects.Locations.Collections.DataStores.SiteSearchEngine.DisableAdvancedSiteSearch	disableAdvancedSiteSearch(String siteSearchEngine, GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchRequest content) Downgrade from advanced site search to basic site search.
DiscoveryEngine.Projects.Locations.Collections.DataStores.SiteSearchEngine.EnableAdvancedSiteSearch	enableAdvancedSiteSearch(String siteSearchEngine, GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchRequest content) Upgrade from basic site search to advanced site search.
DiscoveryEngine.Projects.Locations.Collections.DataStores.SiteSearchEngine.FetchDomainVerificationStatus	fetchDomainVerificationStatus(String siteSearchEngine) Returns list of target sites with its domain verification status.
DiscoveryEngine.Projects.Locations.Collections.DataStores.SiteSearchEngine.Operations	operations() An accessor for creating requests from the Operations collection.
DiscoveryEngine.Projects.Locations.Collections.DataStores.SiteSearchEngine.RecrawlUris	recrawlUris(String siteSearchEngine, GoogleCloudDiscoveryengineV1RecrawlUrisRequest content) Request on-demand recrawl for a list of URIs.
DiscoveryEngine.Projects.Locations.Collections.DataStores.SiteSearchEngine.Sitemaps	sitemaps() An accessor for creating requests from the Sitemaps collection.
DiscoveryEngine.Projects.Locations.Collections.DataStores.SiteSearchEngine.TargetSites	targetSites() An accessor for creating requests from the TargetSites collection.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SiteSearchEngine

public SiteSearchEngine()

Method Detail

batchVerifyTargetSites

public DiscoveryEngine.Projects.Locations.Collections.DataStores.SiteSearchEngine.BatchVerifyTargetSites batchVerifyTargetSites(String parent,
                                                                                                                                GoogleCloudDiscoveryengineV1BatchVerifyTargetSitesRequest content)
                                                                                                                         throws IOException

Verify target sites' ownership and validity. This API sends all the target sites under site search engine for verification. Create a request for the method "siteSearchEngine.batchVerifyTargetSites". This request holds the parameters needed by the discoveryengine server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

parent - Required. The parent resource shared by all TargetSites being verified. `projects/{project}/location s/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`.

content - the GoogleCloudDiscoveryengineV1BatchVerifyTargetSitesRequest

Returns:

the request

Throws:

IOException

disableAdvancedSiteSearch

public DiscoveryEngine.Projects.Locations.Collections.DataStores.SiteSearchEngine.DisableAdvancedSiteSearch disableAdvancedSiteSearch(String siteSearchEngine,
                                                                                                                                      GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchRequest content)
                                                                                                                               throws IOException

Downgrade from advanced site search to basic site search. Create a request for the method "siteSearchEngine.disableAdvancedSiteSearch". This request holds the parameters needed by the discoveryengine server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

siteSearchEngine - Required. Full resource name of the SiteSearchEngine, such as `projects/{project}/locations/{location}/dataStores/{data_store_id}/siteSearchEngine`.

content - the GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchRequest

Returns:

the request

Throws:

IOException

enableAdvancedSiteSearch

public DiscoveryEngine.Projects.Locations.Collections.DataStores.SiteSearchEngine.EnableAdvancedSiteSearch enableAdvancedSiteSearch(String siteSearchEngine,
                                                                                                                                    GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchRequest content)
                                                                                                                             throws IOException

Upgrade from basic site search to advanced site search. Create a request for the method "siteSearchEngine.enableAdvancedSiteSearch". This request holds the parameters needed by the discoveryengine server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

siteSearchEngine - Required. Full resource name of the SiteSearchEngine, such as `projects/{project}/locations/{location}/dataStores/{data_store_id}/siteSearchEngine`.

content - the GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchRequest

Returns:

the request

Throws:

IOException

fetchDomainVerificationStatus

public DiscoveryEngine.Projects.Locations.Collections.DataStores.SiteSearchEngine.FetchDomainVerificationStatus fetchDomainVerificationStatus(String siteSearchEngine)
                                                                                                                                       throws IOException

Returns list of target sites with its domain verification status. This method can only be called under data store with BASIC_SITE_SEARCH state at the moment. Create a request for the method "siteSearchEngine.fetchDomainVerificationStatus". This request holds the parameters needed by the discoveryengine server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

siteSearchEngine - Required. The site search engine resource under which we fetch all the domain verification status. ` projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/s iteSearchEngine`.

Returns:

the request

Throws:

IOException

recrawlUris

public DiscoveryEngine.Projects.Locations.Collections.DataStores.SiteSearchEngine.RecrawlUris recrawlUris(String siteSearchEngine,
                                                                                                          GoogleCloudDiscoveryengineV1RecrawlUrisRequest content)
                                                                                                   throws IOException

Request on-demand recrawl for a list of URIs. Create a request for the method "siteSearchEngine.recrawlUris". This request holds the parameters needed by the discoveryengine server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

siteSearchEngine - Required. Full resource name of the SiteSearchEngine, such as `projects/locations/collections/dataStores/siteSearchEngine`.

content - the GoogleCloudDiscoveryengineV1RecrawlUrisRequest

Returns:

the request

Throws:

IOException

operations

public DiscoveryEngine.Projects.Locations.Collections.DataStores.SiteSearchEngine.Operations operations()

An accessor for creating requests from the Operations collection.

The typical use is:

    DiscoveryEngine discoveryengine = new DiscoveryEngine(...);
    DiscoveryEngine.Operations.List request = discoveryengine.operations().list(parameters ...)
 

Returns:

the resource collection

sitemaps

public DiscoveryEngine.Projects.Locations.Collections.DataStores.SiteSearchEngine.Sitemaps sitemaps()

An accessor for creating requests from the Sitemaps collection.

The typical use is:

    DiscoveryEngine discoveryengine = new DiscoveryEngine(...);
    DiscoveryEngine.Sitemaps.List request = discoveryengine.sitemaps().list(parameters ...)
 

Returns:

the resource collection

targetSites

public DiscoveryEngine.Projects.Locations.Collections.DataStores.SiteSearchEngine.TargetSites targetSites()

An accessor for creating requests from the TargetSites collection.

The typical use is:

    DiscoveryEngine discoveryengine = new DiscoveryEngine(...);
    DiscoveryEngine.TargetSites.List request = discoveryengine.targetSites().list(parameters ...)
 

Returns:

the resource collection