Class protos.google.cloud.discoveryengine.v1.SiteSearchEngineService (2.2.0)

Represents a SiteSearchEngineService

Inheritance

$protobuf.rpc.Service > protos.google.cloud.discoveryengine.v1.SiteSearchEngineService

Package

@google-cloud/discoveryengine

Constructors

(constructor)(rpcImpl, requestDelimited, responseDelimited)

constructor(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean);

Constructs a new SiteSearchEngineService service.

Parameters
Name Description
rpcImpl $protobuf.RPCImpl

RPC implementation
requestDelimited boolean

Whether requests are length-delimited
responseDelimited boolean

Whether responses are length-delimited

Methods

batchCreateTargetSites(request, callback)

public batchCreateTargetSites(request: google.cloud.discoveryengine.v1.IBatchCreateTargetSitesRequest, callback: google.cloud.discoveryengine.v1.SiteSearchEngineService.BatchCreateTargetSitesCallback): void;

Calls BatchCreateTargetSites.

Parameters
Name Description
request IBatchCreateTargetSitesRequest

BatchCreateTargetSitesRequest message or plain object
callback BatchCreateTargetSitesCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

batchCreateTargetSites(request)

public batchCreateTargetSites(request: google.cloud.discoveryengine.v1.IBatchCreateTargetSitesRequest): Promise<google.longrunning.Operation>;

Calls BatchCreateTargetSites.

Parameter
Name Description
request IBatchCreateTargetSitesRequest

BatchCreateTargetSitesRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise

batchVerifyTargetSites(request, callback)

public batchVerifyTargetSites(request: google.cloud.discoveryengine.v1.IBatchVerifyTargetSitesRequest, callback: google.cloud.discoveryengine.v1.SiteSearchEngineService.BatchVerifyTargetSitesCallback): void;

Calls BatchVerifyTargetSites.

Parameters
Name Description
request IBatchVerifyTargetSitesRequest

BatchVerifyTargetSitesRequest message or plain object
callback BatchVerifyTargetSitesCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

batchVerifyTargetSites(request)

public batchVerifyTargetSites(request: google.cloud.discoveryengine.v1.IBatchVerifyTargetSitesRequest): Promise<google.longrunning.Operation>;

Calls BatchVerifyTargetSites.

Parameter
Name Description
request IBatchVerifyTargetSitesRequest

BatchVerifyTargetSitesRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise

create(rpcImpl, requestDelimited, responseDelimited)

public static create(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean): SiteSearchEngineService;

Creates new SiteSearchEngineService service using the specified rpc implementation.

Parameters
Name Description
rpcImpl $protobuf.RPCImpl

RPC implementation
requestDelimited boolean

Whether requests are length-delimited
responseDelimited boolean

Whether responses are length-delimited
Returns
Type Description
SiteSearchEngineService

RPC service. Useful where requests and/or responses are streamed.

createSitemap(request, callback)

public createSitemap(request: google.cloud.discoveryengine.v1.ICreateSitemapRequest, callback: google.cloud.discoveryengine.v1.SiteSearchEngineService.CreateSitemapCallback): void;

Calls CreateSitemap.

Parameters
Name Description
request ICreateSitemapRequest

CreateSitemapRequest message or plain object
callback CreateSitemapCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

createSitemap(request)

public createSitemap(request: google.cloud.discoveryengine.v1.ICreateSitemapRequest): Promise<google.longrunning.Operation>;

Calls CreateSitemap.

Parameter
Name Description
request ICreateSitemapRequest

CreateSitemapRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise

createTargetSite(request, callback)

public createTargetSite(request: google.cloud.discoveryengine.v1.ICreateTargetSiteRequest, callback: google.cloud.discoveryengine.v1.SiteSearchEngineService.CreateTargetSiteCallback): void;

Calls CreateTargetSite.

Parameters
Name Description
request ICreateTargetSiteRequest

CreateTargetSiteRequest message or plain object
callback CreateTargetSiteCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

createTargetSite(request)

public createTargetSite(request: google.cloud.discoveryengine.v1.ICreateTargetSiteRequest): Promise<google.longrunning.Operation>;

Calls CreateTargetSite.

Parameter
Name Description
request ICreateTargetSiteRequest

CreateTargetSiteRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise

deleteSitemap(request, callback)

public deleteSitemap(request: google.cloud.discoveryengine.v1.IDeleteSitemapRequest, callback: google.cloud.discoveryengine.v1.SiteSearchEngineService.DeleteSitemapCallback): void;

Calls DeleteSitemap.

Parameters
Name Description
request IDeleteSitemapRequest

DeleteSitemapRequest message or plain object
callback DeleteSitemapCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

deleteSitemap(request)

public deleteSitemap(request: google.cloud.discoveryengine.v1.IDeleteSitemapRequest): Promise<google.longrunning.Operation>;

Calls DeleteSitemap.

Parameter
Name Description
request IDeleteSitemapRequest

DeleteSitemapRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise

deleteTargetSite(request, callback)

public deleteTargetSite(request: google.cloud.discoveryengine.v1.IDeleteTargetSiteRequest, callback: google.cloud.discoveryengine.v1.SiteSearchEngineService.DeleteTargetSiteCallback): void;

Calls DeleteTargetSite.

Parameters
Name Description
request IDeleteTargetSiteRequest

DeleteTargetSiteRequest message or plain object
callback DeleteTargetSiteCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

deleteTargetSite(request)

public deleteTargetSite(request: google.cloud.discoveryengine.v1.IDeleteTargetSiteRequest): Promise<google.longrunning.Operation>;

Calls DeleteTargetSite.

Parameter
Name Description
request IDeleteTargetSiteRequest

DeleteTargetSiteRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise

disableAdvancedSiteSearch(request, callback)

public disableAdvancedSiteSearch(request: google.cloud.discoveryengine.v1.IDisableAdvancedSiteSearchRequest, callback: google.cloud.discoveryengine.v1.SiteSearchEngineService.DisableAdvancedSiteSearchCallback): void;

Calls DisableAdvancedSiteSearch.

Parameters
Name Description
request IDisableAdvancedSiteSearchRequest

DisableAdvancedSiteSearchRequest message or plain object
callback DisableAdvancedSiteSearchCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

disableAdvancedSiteSearch(request)

public disableAdvancedSiteSearch(request: google.cloud.discoveryengine.v1.IDisableAdvancedSiteSearchRequest): Promise<google.longrunning.Operation>;

Calls DisableAdvancedSiteSearch.

Parameter
Name Description
request IDisableAdvancedSiteSearchRequest

DisableAdvancedSiteSearchRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise

enableAdvancedSiteSearch(request, callback)

public enableAdvancedSiteSearch(request: google.cloud.discoveryengine.v1.IEnableAdvancedSiteSearchRequest, callback: google.cloud.discoveryengine.v1.SiteSearchEngineService.EnableAdvancedSiteSearchCallback): void;

Calls EnableAdvancedSiteSearch.

Parameters
Name Description
request IEnableAdvancedSiteSearchRequest

EnableAdvancedSiteSearchRequest message or plain object
callback EnableAdvancedSiteSearchCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

enableAdvancedSiteSearch(request)

public enableAdvancedSiteSearch(request: google.cloud.discoveryengine.v1.IEnableAdvancedSiteSearchRequest): Promise<google.longrunning.Operation>;

Calls EnableAdvancedSiteSearch.

Parameter
Name Description
request IEnableAdvancedSiteSearchRequest

EnableAdvancedSiteSearchRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise

fetchDomainVerificationStatus(request, callback)

public fetchDomainVerificationStatus(request: google.cloud.discoveryengine.v1.IFetchDomainVerificationStatusRequest, callback: google.cloud.discoveryengine.v1.SiteSearchEngineService.FetchDomainVerificationStatusCallback): void;

Calls FetchDomainVerificationStatus.

Parameters
Name Description
request IFetchDomainVerificationStatusRequest

FetchDomainVerificationStatusRequest message or plain object
callback FetchDomainVerificationStatusCallback

Node-style callback called with the error, if any, and FetchDomainVerificationStatusResponse
Returns
Type Description
void

fetchDomainVerificationStatus(request)

public fetchDomainVerificationStatus(request: google.cloud.discoveryengine.v1.IFetchDomainVerificationStatusRequest): Promise<google.cloud.discoveryengine.v1.FetchDomainVerificationStatusResponse>;

Calls FetchDomainVerificationStatus.

Parameter
Name Description
request IFetchDomainVerificationStatusRequest

FetchDomainVerificationStatusRequest message or plain object
Returns
Type Description
Promise<google.cloud.discoveryengine.v1.FetchDomainVerificationStatusResponse>

Promise

fetchSitemaps(request, callback)

public fetchSitemaps(request: google.cloud.discoveryengine.v1.IFetchSitemapsRequest, callback: google.cloud.discoveryengine.v1.SiteSearchEngineService.FetchSitemapsCallback): void;

Calls FetchSitemaps.

Parameters
Name Description
request IFetchSitemapsRequest

FetchSitemapsRequest message or plain object
callback FetchSitemapsCallback

Node-style callback called with the error, if any, and FetchSitemapsResponse
Returns
Type Description
void

fetchSitemaps(request)

public fetchSitemaps(request: google.cloud.discoveryengine.v1.IFetchSitemapsRequest): Promise<google.cloud.discoveryengine.v1.FetchSitemapsResponse>;

Calls FetchSitemaps.

Parameter
Name Description
request IFetchSitemapsRequest

FetchSitemapsRequest message or plain object
Returns
Type Description
Promise<google.cloud.discoveryengine.v1.FetchSitemapsResponse>

Promise

getSiteSearchEngine(request, callback)

public getSiteSearchEngine(request: google.cloud.discoveryengine.v1.IGetSiteSearchEngineRequest, callback: google.cloud.discoveryengine.v1.SiteSearchEngineService.GetSiteSearchEngineCallback): void;

Calls GetSiteSearchEngine.

Parameters
Name Description
request IGetSiteSearchEngineRequest

GetSiteSearchEngineRequest message or plain object
callback GetSiteSearchEngineCallback

Node-style callback called with the error, if any, and SiteSearchEngine
Returns
Type Description
void

getSiteSearchEngine(request)

public getSiteSearchEngine(request: google.cloud.discoveryengine.v1.IGetSiteSearchEngineRequest): Promise<google.cloud.discoveryengine.v1.SiteSearchEngine>;

Calls GetSiteSearchEngine.

Parameter
Name Description
request IGetSiteSearchEngineRequest

GetSiteSearchEngineRequest message or plain object
Returns
Type Description
Promise<google.cloud.discoveryengine.v1.SiteSearchEngine>

Promise

getTargetSite(request, callback)

public getTargetSite(request: google.cloud.discoveryengine.v1.IGetTargetSiteRequest, callback: google.cloud.discoveryengine.v1.SiteSearchEngineService.GetTargetSiteCallback): void;

Calls GetTargetSite.

Parameters
Name Description
request IGetTargetSiteRequest

GetTargetSiteRequest message or plain object
callback GetTargetSiteCallback

Node-style callback called with the error, if any, and TargetSite
Returns
Type Description
void

getTargetSite(request)

public getTargetSite(request: google.cloud.discoveryengine.v1.IGetTargetSiteRequest): Promise<google.cloud.discoveryengine.v1.TargetSite>;

Calls GetTargetSite.

Parameter
Name Description
request IGetTargetSiteRequest

GetTargetSiteRequest message or plain object
Returns
Type Description
Promise<google.cloud.discoveryengine.v1.TargetSite>

Promise

listTargetSites(request, callback)

public listTargetSites(request: google.cloud.discoveryengine.v1.IListTargetSitesRequest, callback: google.cloud.discoveryengine.v1.SiteSearchEngineService.ListTargetSitesCallback): void;

Calls ListTargetSites.

Parameters
Name Description
request IListTargetSitesRequest

ListTargetSitesRequest message or plain object
callback ListTargetSitesCallback

Node-style callback called with the error, if any, and ListTargetSitesResponse
Returns
Type Description
void

listTargetSites(request)

public listTargetSites(request: google.cloud.discoveryengine.v1.IListTargetSitesRequest): Promise<google.cloud.discoveryengine.v1.ListTargetSitesResponse>;

Calls ListTargetSites.

Parameter
Name Description
request IListTargetSitesRequest

ListTargetSitesRequest message or plain object
Returns
Type Description
Promise<google.cloud.discoveryengine.v1.ListTargetSitesResponse>

Promise

recrawlUris(request, callback)

public recrawlUris(request: google.cloud.discoveryengine.v1.IRecrawlUrisRequest, callback: google.cloud.discoveryengine.v1.SiteSearchEngineService.RecrawlUrisCallback): void;

Calls RecrawlUris.

Parameters
Name Description
request IRecrawlUrisRequest

RecrawlUrisRequest message or plain object
callback RecrawlUrisCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

recrawlUris(request)

public recrawlUris(request: google.cloud.discoveryengine.v1.IRecrawlUrisRequest): Promise<google.longrunning.Operation>;

Calls RecrawlUris.

Parameter
Name Description
request IRecrawlUrisRequest

RecrawlUrisRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise

updateTargetSite(request, callback)

public updateTargetSite(request: google.cloud.discoveryengine.v1.IUpdateTargetSiteRequest, callback: google.cloud.discoveryengine.v1.SiteSearchEngineService.UpdateTargetSiteCallback): void;

Calls UpdateTargetSite.

Parameters
Name Description
request IUpdateTargetSiteRequest

UpdateTargetSiteRequest message or plain object
callback UpdateTargetSiteCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

updateTargetSite(request)

public updateTargetSite(request: google.cloud.discoveryengine.v1.IUpdateTargetSiteRequest): Promise<google.longrunning.Operation>;

Calls UpdateTargetSite.

Parameter
Name Description
request IUpdateTargetSiteRequest

UpdateTargetSiteRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise