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.
Namespace
Google.Cloud.DiscoveryEngine.V1BetaAssembly
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 |
BatchVerifyTargetSitesOperationsClient
public override OperationsClient BatchVerifyTargetSitesOperationsClient { get; }
The long-running operations client for BatchVerifyTargetSites
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
CreateSitemapOperationsClient
public override OperationsClient CreateSitemapOperationsClient { get; }
The long-running operations client for CreateSitemap
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
CreateTargetSiteOperationsClient
public override OperationsClient CreateTargetSiteOperationsClient { get; }
The long-running operations client for CreateTargetSite
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
DeleteSitemapOperationsClient
public override OperationsClient DeleteSitemapOperationsClient { get; }
The long-running operations client for DeleteSitemap
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
DeleteTargetSiteOperationsClient
public override OperationsClient DeleteTargetSiteOperationsClient { get; }
The long-running operations client for DeleteTargetSite
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
DisableAdvancedSiteSearchOperationsClient
public override OperationsClient DisableAdvancedSiteSearchOperationsClient { get; }
The long-running operations client for DisableAdvancedSiteSearch
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
EnableAdvancedSiteSearchOperationsClient
public override OperationsClient EnableAdvancedSiteSearchOperationsClient { get; }
The long-running operations client for EnableAdvancedSiteSearch
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
GrpcClient
public override SiteSearchEngineService.SiteSearchEngineServiceClient GrpcClient { get; }
The underlying gRPC SiteSearchEngineService client
Property Value | |
---|---|
Type | Description |
SiteSearchEngineServiceSiteSearchEngineServiceClient |
LocationsClient
public override LocationsClient LocationsClient { get; }
The LocationsClient associated with this client.
Property Value | |
---|---|
Type | Description |
LocationsClient |
RecrawlUrisOperationsClient
public override OperationsClient RecrawlUrisOperationsClient { get; }
The long-running operations client for RecrawlUris
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
UpdateTargetSiteOperationsClient
public override OperationsClient UpdateTargetSiteOperationsClient { get; }
The long-running operations client for UpdateTargetSite
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
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. |
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. |
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. |
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. |
CreateSitemap(CreateSitemapRequest, CallSettings)
public override Operation<Sitemap, CreateSitemapMetadata> CreateSitemap(CreateSitemapRequest request, CallSettings callSettings = null)
Creates a [Sitemap][google.cloud.discoveryengine.v1beta.Sitemap].
Parameters | |
---|---|
Name | Description |
request |
CreateSitemapRequest 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 |
OperationSitemapCreateSitemapMetadata |
The RPC response. |
CreateSitemapAsync(CreateSitemapRequest, CallSettings)
public override Task<Operation<Sitemap, CreateSitemapMetadata>> CreateSitemapAsync(CreateSitemapRequest request, CallSettings callSettings = null)
Creates a [Sitemap][google.cloud.discoveryengine.v1beta.Sitemap].
Parameters | |
---|---|
Name | Description |
request |
CreateSitemapRequest 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 |
TaskOperationSitemapCreateSitemapMetadata |
A Task containing the RPC response. |
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. |
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. |
DeleteSitemap(DeleteSitemapRequest, CallSettings)
public override Operation<Empty, DeleteSitemapMetadata> DeleteSitemap(DeleteSitemapRequest request, CallSettings callSettings = null)
Deletes a [Sitemap][google.cloud.discoveryengine.v1beta.Sitemap].
Parameters | |
---|---|
Name | Description |
request |
DeleteSitemapRequest 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 |
OperationEmptyDeleteSitemapMetadata |
The RPC response. |
DeleteSitemapAsync(DeleteSitemapRequest, CallSettings)
public override Task<Operation<Empty, DeleteSitemapMetadata>> DeleteSitemapAsync(DeleteSitemapRequest request, CallSettings callSettings = null)
Deletes a [Sitemap][google.cloud.discoveryengine.v1beta.Sitemap].
Parameters | |
---|---|
Name | Description |
request |
DeleteSitemapRequest 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 |
TaskOperationEmptyDeleteSitemapMetadata |
A Task containing the RPC response. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
FetchSitemaps(FetchSitemapsRequest, CallSettings)
public override FetchSitemapsResponse FetchSitemaps(FetchSitemapsRequest request, CallSettings callSettings = null)
Fetch [Sitemap][google.cloud.discoveryengine.v1beta.Sitemap]s in a [DataStore][google.cloud.discoveryengine.v1beta.DataStore].
Parameters | |
---|---|
Name | Description |
request |
FetchSitemapsRequest 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 |
FetchSitemapsResponse |
The RPC response. |
FetchSitemapsAsync(FetchSitemapsRequest, CallSettings)
public override Task<FetchSitemapsResponse> FetchSitemapsAsync(FetchSitemapsRequest request, CallSettings callSettings = null)
Fetch [Sitemap][google.cloud.discoveryengine.v1beta.Sitemap]s in a [DataStore][google.cloud.discoveryengine.v1beta.DataStore].
Parameters | |
---|---|
Name | Description |
request |
FetchSitemapsRequest 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 |
TaskFetchSitemapsResponse |
A Task containing the RPC response. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |
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. |