Discovery Engine v1 API - Class SiteSearchEngineService.SiteSearchEngineServiceClient (1.0.0-beta03)

public class SiteSearchEngineService.SiteSearchEngineServiceClient : ClientBase<SiteSearchEngineService.SiteSearchEngineServiceClient>

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

Client for SiteSearchEngineService

Inheritance

object > ClientBase > ClientBaseSiteSearchEngineServiceSiteSearchEngineServiceClient > SiteSearchEngineService.SiteSearchEngineServiceClient

Namespace

Google.Cloud.DiscoveryEngine.V1

Assembly

Google.Cloud.DiscoveryEngine.V1.dll

Constructors

SiteSearchEngineServiceClient()

protected SiteSearchEngineServiceClient()

Protected parameterless constructor to allow creation of test doubles.

SiteSearchEngineServiceClient(CallInvoker)

public SiteSearchEngineServiceClient(CallInvoker callInvoker)

Creates a new client for SiteSearchEngineService that uses a custom CallInvoker.

Parameter
NameDescription
callInvokerCallInvoker

The callInvoker to use to make remote calls.

SiteSearchEngineServiceClient(ChannelBase)

public SiteSearchEngineServiceClient(ChannelBase channel)

Creates a new client for SiteSearchEngineService

Parameter
NameDescription
channelChannelBase

The channel to use to make remote calls.

SiteSearchEngineServiceClient(ClientBaseConfiguration)

protected SiteSearchEngineServiceClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
NameDescription
configurationClientBaseClientBaseConfiguration

The client configuration.

Methods

BatchCreateTargetSites(BatchCreateTargetSitesRequest, CallOptions)

public virtual Operation BatchCreateTargetSites(BatchCreateTargetSitesRequest request, CallOptions options)

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

Parameters
NameDescription
requestBatchCreateTargetSitesRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

BatchCreateTargetSites(BatchCreateTargetSitesRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation BatchCreateTargetSites(BatchCreateTargetSitesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
NameDescription
requestBatchCreateTargetSitesRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

BatchCreateTargetSitesAsync(BatchCreateTargetSitesRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> BatchCreateTargetSitesAsync(BatchCreateTargetSitesRequest request, CallOptions options)

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

Parameters
NameDescription
requestBatchCreateTargetSitesRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

BatchCreateTargetSitesAsync(BatchCreateTargetSitesRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> BatchCreateTargetSitesAsync(BatchCreateTargetSitesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
NameDescription
requestBatchCreateTargetSitesRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

BatchVerifyTargetSites(BatchVerifyTargetSitesRequest, CallOptions)

public virtual Operation BatchVerifyTargetSites(BatchVerifyTargetSitesRequest request, CallOptions options)

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

Parameters
NameDescription
requestBatchVerifyTargetSitesRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

BatchVerifyTargetSites(BatchVerifyTargetSitesRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation BatchVerifyTargetSites(BatchVerifyTargetSitesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
NameDescription
requestBatchVerifyTargetSitesRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

BatchVerifyTargetSitesAsync(BatchVerifyTargetSitesRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> BatchVerifyTargetSitesAsync(BatchVerifyTargetSitesRequest request, CallOptions options)

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

Parameters
NameDescription
requestBatchVerifyTargetSitesRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

BatchVerifyTargetSitesAsync(BatchVerifyTargetSitesRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> BatchVerifyTargetSitesAsync(BatchVerifyTargetSitesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
NameDescription
requestBatchVerifyTargetSitesRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

CreateLocationsClient()

public virtual Locations.LocationsClient CreateLocationsClient()

Creates a new instance of Locations.LocationsClient using the same call invoker as this client.

Returns
TypeDescription
LocationsLocationsClient

A new Locations.LocationsClient for the same target as this client.

CreateOperationsClient()

public virtual Operations.OperationsClient CreateOperationsClient()

Creates a new instance of Operations.OperationsClient using the same call invoker as this client.

Returns
TypeDescription
OperationsOperationsClient

A new Operations client for the same target as this client.

CreateTargetSite(CreateTargetSiteRequest, CallOptions)

public virtual Operation CreateTargetSite(CreateTargetSiteRequest request, CallOptions options)

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

Parameters
NameDescription
requestCreateTargetSiteRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

CreateTargetSite(CreateTargetSiteRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation CreateTargetSite(CreateTargetSiteRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
NameDescription
requestCreateTargetSiteRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

CreateTargetSiteAsync(CreateTargetSiteRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> CreateTargetSiteAsync(CreateTargetSiteRequest request, CallOptions options)

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

Parameters
NameDescription
requestCreateTargetSiteRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

CreateTargetSiteAsync(CreateTargetSiteRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> CreateTargetSiteAsync(CreateTargetSiteRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
NameDescription
requestCreateTargetSiteRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

DeleteTargetSite(DeleteTargetSiteRequest, CallOptions)

public virtual Operation DeleteTargetSite(DeleteTargetSiteRequest request, CallOptions options)

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

Parameters
NameDescription
requestDeleteTargetSiteRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

DeleteTargetSite(DeleteTargetSiteRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation DeleteTargetSite(DeleteTargetSiteRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
NameDescription
requestDeleteTargetSiteRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

DeleteTargetSiteAsync(DeleteTargetSiteRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> DeleteTargetSiteAsync(DeleteTargetSiteRequest request, CallOptions options)

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

Parameters
NameDescription
requestDeleteTargetSiteRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

DeleteTargetSiteAsync(DeleteTargetSiteRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> DeleteTargetSiteAsync(DeleteTargetSiteRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
NameDescription
requestDeleteTargetSiteRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

DisableAdvancedSiteSearch(DisableAdvancedSiteSearchRequest, CallOptions)

public virtual Operation DisableAdvancedSiteSearch(DisableAdvancedSiteSearchRequest request, CallOptions options)

Downgrade from advanced site search to basic site search.

Parameters
NameDescription
requestDisableAdvancedSiteSearchRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

DisableAdvancedSiteSearch(DisableAdvancedSiteSearchRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation DisableAdvancedSiteSearch(DisableAdvancedSiteSearchRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Downgrade from advanced site search to basic site search.

Parameters
NameDescription
requestDisableAdvancedSiteSearchRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

DisableAdvancedSiteSearchAsync(DisableAdvancedSiteSearchRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> DisableAdvancedSiteSearchAsync(DisableAdvancedSiteSearchRequest request, CallOptions options)

Downgrade from advanced site search to basic site search.

Parameters
NameDescription
requestDisableAdvancedSiteSearchRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

DisableAdvancedSiteSearchAsync(DisableAdvancedSiteSearchRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> DisableAdvancedSiteSearchAsync(DisableAdvancedSiteSearchRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Downgrade from advanced site search to basic site search.

Parameters
NameDescription
requestDisableAdvancedSiteSearchRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

EnableAdvancedSiteSearch(EnableAdvancedSiteSearchRequest, CallOptions)

public virtual Operation EnableAdvancedSiteSearch(EnableAdvancedSiteSearchRequest request, CallOptions options)

Upgrade from basic site search to advanced site search.

Parameters
NameDescription
requestEnableAdvancedSiteSearchRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

EnableAdvancedSiteSearch(EnableAdvancedSiteSearchRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation EnableAdvancedSiteSearch(EnableAdvancedSiteSearchRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Upgrade from basic site search to advanced site search.

Parameters
NameDescription
requestEnableAdvancedSiteSearchRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

EnableAdvancedSiteSearchAsync(EnableAdvancedSiteSearchRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> EnableAdvancedSiteSearchAsync(EnableAdvancedSiteSearchRequest request, CallOptions options)

Upgrade from basic site search to advanced site search.

Parameters
NameDescription
requestEnableAdvancedSiteSearchRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

EnableAdvancedSiteSearchAsync(EnableAdvancedSiteSearchRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> EnableAdvancedSiteSearchAsync(EnableAdvancedSiteSearchRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Upgrade from basic site search to advanced site search.

Parameters
NameDescription
requestEnableAdvancedSiteSearchRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

FetchDomainVerificationStatus(FetchDomainVerificationStatusRequest, CallOptions)

public virtual FetchDomainVerificationStatusResponse FetchDomainVerificationStatus(FetchDomainVerificationStatusRequest request, CallOptions options)

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
NameDescription
requestFetchDomainVerificationStatusRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
FetchDomainVerificationStatusResponse

The response received from the server.

FetchDomainVerificationStatus(FetchDomainVerificationStatusRequest, Metadata, DateTime?, CancellationToken)

public virtual FetchDomainVerificationStatusResponse FetchDomainVerificationStatus(FetchDomainVerificationStatusRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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
NameDescription
requestFetchDomainVerificationStatusRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
FetchDomainVerificationStatusResponse

The response received from the server.

FetchDomainVerificationStatusAsync(FetchDomainVerificationStatusRequest, CallOptions)

public virtual AsyncUnaryCall<FetchDomainVerificationStatusResponse> FetchDomainVerificationStatusAsync(FetchDomainVerificationStatusRequest request, CallOptions options)

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
NameDescription
requestFetchDomainVerificationStatusRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallFetchDomainVerificationStatusResponse

The call object.

FetchDomainVerificationStatusAsync(FetchDomainVerificationStatusRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<FetchDomainVerificationStatusResponse> FetchDomainVerificationStatusAsync(FetchDomainVerificationStatusRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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
NameDescription
requestFetchDomainVerificationStatusRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallFetchDomainVerificationStatusResponse

The call object.

GetSiteSearchEngine(GetSiteSearchEngineRequest, CallOptions)

public virtual SiteSearchEngine GetSiteSearchEngine(GetSiteSearchEngineRequest request, CallOptions options)

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

Parameters
NameDescription
requestGetSiteSearchEngineRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
SiteSearchEngine

The response received from the server.

GetSiteSearchEngine(GetSiteSearchEngineRequest, Metadata, DateTime?, CancellationToken)

public virtual SiteSearchEngine GetSiteSearchEngine(GetSiteSearchEngineRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
NameDescription
requestGetSiteSearchEngineRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
SiteSearchEngine

The response received from the server.

GetSiteSearchEngineAsync(GetSiteSearchEngineRequest, CallOptions)

public virtual AsyncUnaryCall<SiteSearchEngine> GetSiteSearchEngineAsync(GetSiteSearchEngineRequest request, CallOptions options)

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

Parameters
NameDescription
requestGetSiteSearchEngineRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallSiteSearchEngine

The call object.

GetSiteSearchEngineAsync(GetSiteSearchEngineRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<SiteSearchEngine> GetSiteSearchEngineAsync(GetSiteSearchEngineRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
NameDescription
requestGetSiteSearchEngineRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallSiteSearchEngine

The call object.

GetTargetSite(GetTargetSiteRequest, CallOptions)

public virtual TargetSite GetTargetSite(GetTargetSiteRequest request, CallOptions options)

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

Parameters
NameDescription
requestGetTargetSiteRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
TargetSite

The response received from the server.

GetTargetSite(GetTargetSiteRequest, Metadata, DateTime?, CancellationToken)

public virtual TargetSite GetTargetSite(GetTargetSiteRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
NameDescription
requestGetTargetSiteRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
TargetSite

The response received from the server.

GetTargetSiteAsync(GetTargetSiteRequest, CallOptions)

public virtual AsyncUnaryCall<TargetSite> GetTargetSiteAsync(GetTargetSiteRequest request, CallOptions options)

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

Parameters
NameDescription
requestGetTargetSiteRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallTargetSite

The call object.

GetTargetSiteAsync(GetTargetSiteRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<TargetSite> GetTargetSiteAsync(GetTargetSiteRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
NameDescription
requestGetTargetSiteRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallTargetSite

The call object.

ListTargetSites(ListTargetSitesRequest, CallOptions)

public virtual ListTargetSitesResponse ListTargetSites(ListTargetSitesRequest request, CallOptions options)

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

Parameters
NameDescription
requestListTargetSitesRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
ListTargetSitesResponse

The response received from the server.

ListTargetSites(ListTargetSitesRequest, Metadata, DateTime?, CancellationToken)

public virtual ListTargetSitesResponse ListTargetSites(ListTargetSitesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
NameDescription
requestListTargetSitesRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
ListTargetSitesResponse

The response received from the server.

ListTargetSitesAsync(ListTargetSitesRequest, CallOptions)

public virtual AsyncUnaryCall<ListTargetSitesResponse> ListTargetSitesAsync(ListTargetSitesRequest request, CallOptions options)

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

Parameters
NameDescription
requestListTargetSitesRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallListTargetSitesResponse

The call object.

ListTargetSitesAsync(ListTargetSitesRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListTargetSitesResponse> ListTargetSitesAsync(ListTargetSitesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
NameDescription
requestListTargetSitesRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallListTargetSitesResponse

The call object.

NewInstance(ClientBaseConfiguration)

protected override SiteSearchEngineService.SiteSearchEngineServiceClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
NameDescription
configurationClientBaseClientBaseConfiguration
Returns
TypeDescription
SiteSearchEngineServiceSiteSearchEngineServiceClient
Overrides

RecrawlUris(RecrawlUrisRequest, CallOptions)

public virtual Operation RecrawlUris(RecrawlUrisRequest request, CallOptions options)

Request on-demand recrawl for a list of URIs.

Parameters
NameDescription
requestRecrawlUrisRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

RecrawlUris(RecrawlUrisRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation RecrawlUris(RecrawlUrisRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Request on-demand recrawl for a list of URIs.

Parameters
NameDescription
requestRecrawlUrisRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

RecrawlUrisAsync(RecrawlUrisRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> RecrawlUrisAsync(RecrawlUrisRequest request, CallOptions options)

Request on-demand recrawl for a list of URIs.

Parameters
NameDescription
requestRecrawlUrisRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

RecrawlUrisAsync(RecrawlUrisRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> RecrawlUrisAsync(RecrawlUrisRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Request on-demand recrawl for a list of URIs.

Parameters
NameDescription
requestRecrawlUrisRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

UpdateTargetSite(UpdateTargetSiteRequest, CallOptions)

public virtual Operation UpdateTargetSite(UpdateTargetSiteRequest request, CallOptions options)

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

Parameters
NameDescription
requestUpdateTargetSiteRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

UpdateTargetSite(UpdateTargetSiteRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation UpdateTargetSite(UpdateTargetSiteRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
NameDescription
requestUpdateTargetSiteRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

UpdateTargetSiteAsync(UpdateTargetSiteRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> UpdateTargetSiteAsync(UpdateTargetSiteRequest request, CallOptions options)

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

Parameters
NameDescription
requestUpdateTargetSiteRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

UpdateTargetSiteAsync(UpdateTargetSiteRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> UpdateTargetSiteAsync(UpdateTargetSiteRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
NameDescription
requestUpdateTargetSiteRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.