Discovery Engine v1 API - Class SiteSearchEngineService.SiteSearchEngineServiceBase (1.1.0)

[BindServiceMethod(typeof(SiteSearchEngineService), "BindService")]
public abstract class SiteSearchEngineService.SiteSearchEngineServiceBase

Reference documentation and code samples for the Discovery Engine v1 API class SiteSearchEngineService.SiteSearchEngineServiceBase.

Base class for server-side implementations of SiteSearchEngineService

Inheritance

object > SiteSearchEngineService.SiteSearchEngineServiceBase

Namespace

Google.Cloud.DiscoveryEngine.V1

Assembly

Google.Cloud.DiscoveryEngine.V1.dll

Methods

BatchCreateTargetSites(BatchCreateTargetSitesRequest, ServerCallContext)

public virtual Task<Operation> BatchCreateTargetSites(BatchCreateTargetSitesRequest request, ServerCallContext context)

Creates [TargetSite][google.cloud.discoveryengine.v1.TargetSite] in a batch.

Parameters
Name Description
request BatchCreateTargetSitesRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskOperation

The response to send back to the client (wrapped by a task).

BatchVerifyTargetSites(BatchVerifyTargetSitesRequest, ServerCallContext)

public virtual Task<Operation> BatchVerifyTargetSites(BatchVerifyTargetSitesRequest request, ServerCallContext context)

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

Parameters
Name Description
request BatchVerifyTargetSitesRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskOperation

The response to send back to the client (wrapped by a task).

CreateTargetSite(CreateTargetSiteRequest, ServerCallContext)

public virtual Task<Operation> CreateTargetSite(CreateTargetSiteRequest request, ServerCallContext context)

Creates a [TargetSite][google.cloud.discoveryengine.v1.TargetSite].

Parameters
Name Description
request CreateTargetSiteRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskOperation

The response to send back to the client (wrapped by a task).

DeleteTargetSite(DeleteTargetSiteRequest, ServerCallContext)

public virtual Task<Operation> DeleteTargetSite(DeleteTargetSiteRequest request, ServerCallContext context)

Deletes a [TargetSite][google.cloud.discoveryengine.v1.TargetSite].

Parameters
Name Description
request DeleteTargetSiteRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskOperation

The response to send back to the client (wrapped by a task).

DisableAdvancedSiteSearch(DisableAdvancedSiteSearchRequest, ServerCallContext)

public virtual Task<Operation> DisableAdvancedSiteSearch(DisableAdvancedSiteSearchRequest request, ServerCallContext context)

Downgrade from advanced site search to basic site search.

Parameters
Name Description
request DisableAdvancedSiteSearchRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskOperation

The response to send back to the client (wrapped by a task).

EnableAdvancedSiteSearch(EnableAdvancedSiteSearchRequest, ServerCallContext)

public virtual Task<Operation> EnableAdvancedSiteSearch(EnableAdvancedSiteSearchRequest request, ServerCallContext context)

Upgrade from basic site search to advanced site search.

Parameters
Name Description
request EnableAdvancedSiteSearchRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskOperation

The response to send back to the client (wrapped by a task).

FetchDomainVerificationStatus(FetchDomainVerificationStatusRequest, ServerCallContext)

public virtual Task<FetchDomainVerificationStatusResponse> FetchDomainVerificationStatus(FetchDomainVerificationStatusRequest request, ServerCallContext context)

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.

Parameters
Name Description
request FetchDomainVerificationStatusRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskFetchDomainVerificationStatusResponse

The response to send back to the client (wrapped by a task).

GetSiteSearchEngine(GetSiteSearchEngineRequest, ServerCallContext)

public virtual Task<SiteSearchEngine> GetSiteSearchEngine(GetSiteSearchEngineRequest request, ServerCallContext context)

Gets the [SiteSearchEngine][google.cloud.discoveryengine.v1.SiteSearchEngine].

Parameters
Name Description
request GetSiteSearchEngineRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskSiteSearchEngine

The response to send back to the client (wrapped by a task).

GetTargetSite(GetTargetSiteRequest, ServerCallContext)

public virtual Task<TargetSite> GetTargetSite(GetTargetSiteRequest request, ServerCallContext context)

Gets a [TargetSite][google.cloud.discoveryengine.v1.TargetSite].

Parameters
Name Description
request GetTargetSiteRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskTargetSite

The response to send back to the client (wrapped by a task).

ListTargetSites(ListTargetSitesRequest, ServerCallContext)

public virtual Task<ListTargetSitesResponse> ListTargetSites(ListTargetSitesRequest request, ServerCallContext context)

Gets a list of [TargetSite][google.cloud.discoveryengine.v1.TargetSite]s.

Parameters
Name Description
request ListTargetSitesRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskListTargetSitesResponse

The response to send back to the client (wrapped by a task).

RecrawlUris(RecrawlUrisRequest, ServerCallContext)

public virtual Task<Operation> RecrawlUris(RecrawlUrisRequest request, ServerCallContext context)

Request on-demand recrawl for a list of URIs.

Parameters
Name Description
request RecrawlUrisRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskOperation

The response to send back to the client (wrapped by a task).

UpdateTargetSite(UpdateTargetSiteRequest, ServerCallContext)

public virtual Task<Operation> UpdateTargetSite(UpdateTargetSiteRequest request, ServerCallContext context)

Updates a [TargetSite][google.cloud.discoveryengine.v1.TargetSite].

Parameters
Name Description
request UpdateTargetSiteRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskOperation

The response to send back to the client (wrapped by a task).