Discovery Engine v1beta API - Class SiteSearchEngineServiceClientImpl (1.0.0-beta17) 

public sealed class SiteSearchEngineServiceClientImpl : SiteSearchEngineServiceClient

Reference documentation and code samples for the Discovery Engine v1beta API class SiteSearchEngineServiceClientImpl.

SiteSearchEngineService client wrapper implementation, for convenient use.

Inheritance

object > SiteSearchEngineServiceClient > SiteSearchEngineServiceClientImpl

Namespace

Google.Cloud.DiscoveryEngine.V1Beta

Assembly

Google.Cloud.DiscoveryEngine.V1Beta.dll

Remarks

Service for managing site search related resources.

Constructors

SiteSearchEngineServiceClientImpl(SiteSearchEngineServiceClient, SiteSearchEngineServiceSettings, ILogger)

public SiteSearchEngineServiceClientImpl(SiteSearchEngineService.SiteSearchEngineServiceClient grpcClient, SiteSearchEngineServiceSettings settings, ILogger logger)

Constructs a client wrapper for the SiteSearchEngineService service, with the specified gRPC client and settings.

Parameters
Name Description
grpcClient SiteSearchEngineServiceSiteSearchEngineServiceClient

The underlying gRPC client.
settings SiteSearchEngineServiceSettings

The base SiteSearchEngineServiceSettings used within this client.
logger ILogger

Optional ILogger to use within this client.

Properties

BatchCreateTargetSitesOperationsClient

public override OperationsClient BatchCreateTargetSitesOperationsClient { get; }

The long-running operations client for BatchCreateTargetSites.

Property Value
Type Description
OperationsClient
Overrides

BatchVerifyTargetSitesOperationsClient

public override OperationsClient BatchVerifyTargetSitesOperationsClient { get; }

The long-running operations client for BatchVerifyTargetSites.

Property Value
Type Description
OperationsClient
Overrides

CreateTargetSiteOperationsClient

public override OperationsClient CreateTargetSiteOperationsClient { get; }

The long-running operations client for CreateTargetSite.

Property Value
Type Description
OperationsClient
Overrides

DeleteTargetSiteOperationsClient

public override OperationsClient DeleteTargetSiteOperationsClient { get; }

The long-running operations client for DeleteTargetSite.

Property Value
Type Description
OperationsClient
Overrides

DisableAdvancedSiteSearchOperationsClient

public override OperationsClient DisableAdvancedSiteSearchOperationsClient { get; }

The long-running operations client for DisableAdvancedSiteSearch.

Property Value
Type Description
OperationsClient
Overrides

EnableAdvancedSiteSearchOperationsClient

public override OperationsClient EnableAdvancedSiteSearchOperationsClient { get; }

The long-running operations client for EnableAdvancedSiteSearch.

Property Value
Type Description
OperationsClient
Overrides

GrpcClient

public override SiteSearchEngineService.SiteSearchEngineServiceClient GrpcClient { get; }

The underlying gRPC SiteSearchEngineService client

Property Value
Type Description
SiteSearchEngineServiceSiteSearchEngineServiceClient
Overrides

LocationsClient

public override LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
Type Description
LocationsClient
Overrides

RecrawlUrisOperationsClient

public override OperationsClient RecrawlUrisOperationsClient { get; }

The long-running operations client for RecrawlUris.

Property Value
Type Description
OperationsClient
Overrides

UpdateTargetSiteOperationsClient

public override OperationsClient UpdateTargetSiteOperationsClient { get; }

The long-running operations client for UpdateTargetSite.

Property Value
Type Description
OperationsClient
Overrides

Methods

BatchCreateTargetSites(BatchCreateTargetSitesRequest, CallSettings)

public override Operation<BatchCreateTargetSitesResponse, BatchCreateTargetSiteMetadata> BatchCreateTargetSites(BatchCreateTargetSitesRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request BatchCreateTargetSitesRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationBatchCreateTargetSitesResponseBatchCreateTargetSiteMetadata

The RPC response.
Overrides

BatchCreateTargetSitesAsync(BatchCreateTargetSitesRequest, CallSettings)

public override Task<Operation<BatchCreateTargetSitesResponse, BatchCreateTargetSiteMetadata>> BatchCreateTargetSitesAsync(BatchCreateTargetSitesRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request BatchCreateTargetSitesRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationBatchCreateTargetSitesResponseBatchCreateTargetSiteMetadata

A Task containing the RPC response.
Overrides

BatchVerifyTargetSites(BatchVerifyTargetSitesRequest, CallSettings)

public override Operation<BatchVerifyTargetSitesResponse, BatchVerifyTargetSitesMetadata> BatchVerifyTargetSites(BatchVerifyTargetSitesRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationBatchVerifyTargetSitesResponseBatchVerifyTargetSitesMetadata

The RPC response.
Overrides

BatchVerifyTargetSitesAsync(BatchVerifyTargetSitesRequest, CallSettings)

public override Task<Operation<BatchVerifyTargetSitesResponse, BatchVerifyTargetSitesMetadata>> BatchVerifyTargetSitesAsync(BatchVerifyTargetSitesRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationBatchVerifyTargetSitesResponseBatchVerifyTargetSitesMetadata

A Task containing the RPC response.
Overrides

CreateTargetSite(CreateTargetSiteRequest, CallSettings)

public override Operation<TargetSite, CreateTargetSiteMetadata> CreateTargetSite(CreateTargetSiteRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request CreateTargetSiteRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationTargetSiteCreateTargetSiteMetadata

The RPC response.
Overrides

CreateTargetSiteAsync(CreateTargetSiteRequest, CallSettings)

public override Task<Operation<TargetSite, CreateTargetSiteMetadata>> CreateTargetSiteAsync(CreateTargetSiteRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request CreateTargetSiteRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationTargetSiteCreateTargetSiteMetadata

A Task containing the RPC response.
Overrides

DeleteTargetSite(DeleteTargetSiteRequest, CallSettings)

public override Operation<Empty, DeleteTargetSiteMetadata> DeleteTargetSite(DeleteTargetSiteRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request DeleteTargetSiteRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationEmptyDeleteTargetSiteMetadata

The RPC response.
Overrides

DeleteTargetSiteAsync(DeleteTargetSiteRequest, CallSettings)

public override Task<Operation<Empty, DeleteTargetSiteMetadata>> DeleteTargetSiteAsync(DeleteTargetSiteRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request DeleteTargetSiteRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationEmptyDeleteTargetSiteMetadata

A Task containing the RPC response.
Overrides

DisableAdvancedSiteSearch(DisableAdvancedSiteSearchRequest, CallSettings)

public override Operation<DisableAdvancedSiteSearchResponse, DisableAdvancedSiteSearchMetadata> DisableAdvancedSiteSearch(DisableAdvancedSiteSearchRequest request, CallSettings callSettings = null)

Downgrade from advanced site search to basic site search.

Parameters
Name Description
request DisableAdvancedSiteSearchRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationDisableAdvancedSiteSearchResponseDisableAdvancedSiteSearchMetadata

The RPC response.
Overrides

DisableAdvancedSiteSearchAsync(DisableAdvancedSiteSearchRequest, CallSettings)

public override Task<Operation<DisableAdvancedSiteSearchResponse, DisableAdvancedSiteSearchMetadata>> DisableAdvancedSiteSearchAsync(DisableAdvancedSiteSearchRequest request, CallSettings callSettings = null)

Downgrade from advanced site search to basic site search.

Parameters
Name Description
request DisableAdvancedSiteSearchRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationDisableAdvancedSiteSearchResponseDisableAdvancedSiteSearchMetadata

A Task containing the RPC response.
Overrides

EnableAdvancedSiteSearch(EnableAdvancedSiteSearchRequest, CallSettings)

public override Operation<EnableAdvancedSiteSearchResponse, EnableAdvancedSiteSearchMetadata> EnableAdvancedSiteSearch(EnableAdvancedSiteSearchRequest request, CallSettings callSettings = null)

Upgrade from basic site search to advanced site search.

Parameters
Name Description
request EnableAdvancedSiteSearchRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationEnableAdvancedSiteSearchResponseEnableAdvancedSiteSearchMetadata

The RPC response.
Overrides

EnableAdvancedSiteSearchAsync(EnableAdvancedSiteSearchRequest, CallSettings)

public override Task<Operation<EnableAdvancedSiteSearchResponse, EnableAdvancedSiteSearchMetadata>> EnableAdvancedSiteSearchAsync(EnableAdvancedSiteSearchRequest request, CallSettings callSettings = null)

Upgrade from basic site search to advanced site search.

Parameters
Name Description
request EnableAdvancedSiteSearchRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationEnableAdvancedSiteSearchResponseEnableAdvancedSiteSearchMetadata

A Task containing the RPC response.
Overrides

FetchDomainVerificationStatus(FetchDomainVerificationStatusRequest, CallSettings)

public override PagedEnumerable<FetchDomainVerificationStatusResponse, TargetSite> FetchDomainVerificationStatus(FetchDomainVerificationStatusRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableFetchDomainVerificationStatusResponseTargetSite

A pageable sequence of TargetSite resources.
Overrides

FetchDomainVerificationStatusAsync(FetchDomainVerificationStatusRequest, CallSettings)

public override PagedAsyncEnumerable<FetchDomainVerificationStatusResponse, TargetSite> FetchDomainVerificationStatusAsync(FetchDomainVerificationStatusRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableFetchDomainVerificationStatusResponseTargetSite

A pageable asynchronous sequence of TargetSite resources.
Overrides

GetSiteSearchEngine(GetSiteSearchEngineRequest, CallSettings)

public override SiteSearchEngine GetSiteSearchEngine(GetSiteSearchEngineRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request GetSiteSearchEngineRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
SiteSearchEngine

The RPC response.
Overrides

GetSiteSearchEngineAsync(GetSiteSearchEngineRequest, CallSettings)

public override Task<SiteSearchEngine> GetSiteSearchEngineAsync(GetSiteSearchEngineRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request GetSiteSearchEngineRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskSiteSearchEngine

A Task containing the RPC response.
Overrides

GetTargetSite(GetTargetSiteRequest, CallSettings)

public override TargetSite GetTargetSite(GetTargetSiteRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request GetTargetSiteRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TargetSite

The RPC response.
Overrides

GetTargetSiteAsync(GetTargetSiteRequest, CallSettings)

public override Task<TargetSite> GetTargetSiteAsync(GetTargetSiteRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request GetTargetSiteRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskTargetSite

A Task containing the RPC response.
Overrides

ListTargetSites(ListTargetSitesRequest, CallSettings)

public override PagedEnumerable<ListTargetSitesResponse, TargetSite> ListTargetSites(ListTargetSitesRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request ListTargetSitesRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListTargetSitesResponseTargetSite

A pageable sequence of TargetSite resources.
Overrides

ListTargetSitesAsync(ListTargetSitesRequest, CallSettings)

public override PagedAsyncEnumerable<ListTargetSitesResponse, TargetSite> ListTargetSitesAsync(ListTargetSitesRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request ListTargetSitesRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListTargetSitesResponseTargetSite

A pageable asynchronous sequence of TargetSite resources.
Overrides

RecrawlUris(RecrawlUrisRequest, CallSettings)

public override Operation<RecrawlUrisResponse, RecrawlUrisMetadata> RecrawlUris(RecrawlUrisRequest request, CallSettings callSettings = null)

Request on-demand recrawl for a list of URIs.

Parameters
Name Description
request RecrawlUrisRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationRecrawlUrisResponseRecrawlUrisMetadata

The RPC response.
Overrides

RecrawlUrisAsync(RecrawlUrisRequest, CallSettings)

public override Task<Operation<RecrawlUrisResponse, RecrawlUrisMetadata>> RecrawlUrisAsync(RecrawlUrisRequest request, CallSettings callSettings = null)

Request on-demand recrawl for a list of URIs.

Parameters
Name Description
request RecrawlUrisRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationRecrawlUrisResponseRecrawlUrisMetadata

A Task containing the RPC response.
Overrides

UpdateTargetSite(UpdateTargetSiteRequest, CallSettings)

public override Operation<TargetSite, UpdateTargetSiteMetadata> UpdateTargetSite(UpdateTargetSiteRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request UpdateTargetSiteRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationTargetSiteUpdateTargetSiteMetadata

The RPC response.
Overrides

UpdateTargetSiteAsync(UpdateTargetSiteRequest, CallSettings)

public override Task<Operation<TargetSite, UpdateTargetSiteMetadata>> UpdateTargetSiteAsync(UpdateTargetSiteRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request UpdateTargetSiteRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationTargetSiteUpdateTargetSiteMetadata

A Task containing the RPC response.
Overrides