Retail v2 API - Class SearchServiceClientImpl (2.11.0)

public sealed class SearchServiceClientImpl : SearchServiceClient

Reference documentation and code samples for the Retail v2 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.Retail.V2

Assembly

Google.Cloud.Retail.V2.dll

Remarks

Service for search.

This feature is only available for users who have Retail Search enabled. Enable Retail Search on Cloud Console before using this feature.

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.

This feature is only available for users who have Retail Search enabled. Enable Retail Search on Cloud Console before using this feature.

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.

This feature is only available for users who have Retail Search enabled. Enable Retail Search on Cloud Console before using this feature.

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)