Discovery Engine v1 API - Class SearchServiceClientImpl (1.6.0)

Version latest

• 1.6.0 (latest)
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0-beta06

public sealed class SearchServiceClientImpl : SearchServiceClient

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

SearchService client wrapper implementation, for convenient use.

Inheritance

object > SearchServiceClient > SearchServiceClientImpl

Inherited Members

SearchServiceClient.DefaultEndpoint

SearchServiceClient.DefaultScopes

SearchServiceClient.ServiceMetadata

SearchServiceClient.CreateAsync(CancellationToken)

SearchServiceClient.Create()

SearchServiceClient.ShutdownDefaultChannelsAsync()

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.DiscoveryEngine.V1

Assembly

Google.Cloud.DiscoveryEngine.V1.dll

Remarks

Service for search.

Constructors

SearchServiceClientImpl(SearchServiceClient, SearchServiceSettings, ILogger)

public SearchServiceClientImpl(SearchService.SearchServiceClient grpcClient, SearchServiceSettings settings, ILogger logger)

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

Parameters
Name	Description
grpcClient	SearchServiceSearchServiceClient The underlying gRPC client.
settings	SearchServiceSettings The base SearchServiceSettings used within this client.
logger	ILogger Optional ILogger to use within this client.

Properties

GrpcClient

public override SearchService.SearchServiceClient GrpcClient { get; }

The underlying gRPC SearchService client

Property Value
Type	Description
SearchServiceSearchServiceClient

Overrides

SearchServiceClient.GrpcClient

LocationsClient

public override LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
Type	Description
LocationsClient

Overrides

SearchServiceClient.LocationsClient

Methods

Search(SearchRequest, CallSettings)

public override PagedEnumerable<SearchResponse, SearchResponse.Types.SearchResult> Search(SearchRequest request, CallSettings callSettings = null)

Performs a search.

Parameters
Name	Description
request	SearchRequest 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
PagedEnumerableSearchResponseSearchResponseTypesSearchResult	A pageable sequence of SearchResponse.Types.SearchResult resources.

Overrides

SearchServiceClient.Search(SearchRequest, CallSettings)

SearchAsync(SearchRequest, CallSettings)

public override PagedAsyncEnumerable<SearchResponse, SearchResponse.Types.SearchResult> SearchAsync(SearchRequest request, CallSettings callSettings = null)

Performs a search.

Parameters
Name	Description
request	SearchRequest 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
PagedAsyncEnumerableSearchResponseSearchResponseTypesSearchResult	A pageable asynchronous sequence of SearchResponse.Types.SearchResult resources.

Overrides

SearchServiceClient.SearchAsync(SearchRequest, CallSettings)

SearchLite(SearchRequest, CallSettings)

public override PagedEnumerable<SearchResponse, SearchResponse.Types.SearchResult> SearchLite(SearchRequest request, CallSettings callSettings = null)

Performs a search. Similar to the [SearchService.Search][google.cloud.discoveryengine.v1.SearchService.Search] method, but a lite version that allows API key for authentication, where OAuth and IAM checks are not required.

Only public website search is supported by this method. If data stores and engines not associated with public website search are specified, a FAILED_PRECONDITION error is returned.

This method can be used for easy onboarding without having to implement an authentication backend. However, it is strongly recommended to use [SearchService.Search][google.cloud.discoveryengine.v1.SearchService.Search] instead with required OAuth and IAM checks to provide better data security.

Parameters
Name	Description
request	SearchRequest 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
PagedEnumerableSearchResponseSearchResponseTypesSearchResult	A pageable sequence of SearchResponse.Types.SearchResult resources.

Overrides

SearchServiceClient.SearchLite(SearchRequest, CallSettings)

SearchLiteAsync(SearchRequest, CallSettings)

public override PagedAsyncEnumerable<SearchResponse, SearchResponse.Types.SearchResult> SearchLiteAsync(SearchRequest request, CallSettings callSettings = null)

Performs a search. Similar to the [SearchService.Search][google.cloud.discoveryengine.v1.SearchService.Search] method, but a lite version that allows API key for authentication, where OAuth and IAM checks are not required.

Only public website search is supported by this method. If data stores and engines not associated with public website search are specified, a FAILED_PRECONDITION error is returned.

This method can be used for easy onboarding without having to implement an authentication backend. However, it is strongly recommended to use [SearchService.Search][google.cloud.discoveryengine.v1.SearchService.Search] instead with required OAuth and IAM checks to provide better data security.

Parameters
Name	Description
request	SearchRequest 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
PagedAsyncEnumerableSearchResponseSearchResponseTypesSearchResult	A pageable asynchronous sequence of SearchResponse.Types.SearchResult resources.

Overrides

SearchServiceClient.SearchLiteAsync(SearchRequest, CallSettings)