Struct SiteSearchEngineService 

pub struct SiteSearchEngineService { /* private fields */ }

Available on crate feature site-search-engine-service only.

Implements a client for the Discovery Engine API.

Example

let client = SiteSearchEngineService::builder().build().await?;
// use `client` to make requests to the Discovery Engine API.

Service Description

Service for managing site search related resources.

Configuration

To configure SiteSearchEngineService use the with_* methods in the type returned by builder(). The default configuration should work for most applications. Common configuration changes include

• with_endpoint(): by default this client uses the global default endpoint (https://discoveryengine.googleapis.com). Applications using regional endpoints or running in restricted networks (e.g. a network configured override this default.
• with_credentials(): by default this client uses Application Default Credentials. Applications using custom authentication may need to override this default.

Pooling and Cloning

SiteSearchEngineService holds a connection pool internally, it is advised to create one and the reuse it. You do not need to wrap SiteSearchEngineService in an Rc or Arc to reuse it, because it already uses an Arc internally.

Implementations

impl SiteSearchEngineService

pub fn builder() -> ClientBuilder

Returns a builder for SiteSearchEngineService.

let client = SiteSearchEngineService::builder().build().await?;

pub fn from_stub<T>(stub: T) -> Self

where T: SiteSearchEngineService + 'static,

Creates a new client from the provided stub.

The most common case for calling this function is in tests mocking the client’s behavior.

pub fn get_site_search_engine(&self) -> GetSiteSearchEngine

Gets the SiteSearchEngine.

pub fn create_target_site(&self) -> CreateTargetSite

Creates a TargetSite.

Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

pub fn batch_create_target_sites(&self) -> BatchCreateTargetSites

Creates TargetSite in a batch.

Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

pub fn get_target_site(&self) -> GetTargetSite

Gets a TargetSite.

pub fn update_target_site(&self) -> UpdateTargetSite

Updates a TargetSite.

Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

pub fn delete_target_site(&self) -> DeleteTargetSite

Deletes a TargetSite.

Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

pub fn list_target_sites(&self) -> ListTargetSites

Gets a list of TargetSites.

pub fn create_sitemap(&self) -> CreateSitemap

Creates a Sitemap.

Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

pub fn delete_sitemap(&self) -> DeleteSitemap

Deletes a Sitemap.

Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

pub fn fetch_sitemaps(&self) -> FetchSitemaps

Fetch Sitemaps in a DataStore.

pub fn enable_advanced_site_search(&self) -> EnableAdvancedSiteSearch

Upgrade from basic site search to advanced site search.

Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

pub fn disable_advanced_site_search(&self) -> DisableAdvancedSiteSearch

Downgrade from advanced site search to basic site search.

Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

pub fn recrawl_uris(&self) -> RecrawlUris

Request on-demand recrawl for a list of URIs.

Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

pub fn batch_verify_target_sites(&self) -> BatchVerifyTargetSites

Verify target sites’ ownership and validity. This API sends all the target sites under site search engine for verification.

Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

pub fn fetch_domain_verification_status(&self) -> FetchDomainVerificationStatus

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.

pub fn list_operations(&self) -> ListOperations

Provides the Operations service functionality in this service.

pub fn get_operation(&self) -> GetOperation

Provides the Operations service functionality in this service.

pub fn cancel_operation(&self) -> CancelOperation

Provides the Operations service functionality in this service.

Trait Implementations

impl Clone for SiteSearchEngineService

fn clone(&self) -> SiteSearchEngineService

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SiteSearchEngineService

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.