Class SearchService.SearchServiceClient (1.6.0)

public class SearchServiceClient : ClientBase<SearchService.SearchServiceClient>

Client for SearchService

Inheritance

Object > ClientBase > ClientBase<SearchService.SearchServiceClient> > SearchService.SearchServiceClient

Namespace

Google.Cloud.Retail.V2

Assembly

Google.Cloud.Retail.V2.dll

Constructors

SearchServiceClient()

protected SearchServiceClient()

Protected parameterless constructor to allow creation of test doubles.

SearchServiceClient(CallInvoker)

public SearchServiceClient(CallInvoker callInvoker)

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

Parameter
NameDescription
callInvokerCallInvoker

The callInvoker to use to make remote calls.

SearchServiceClient(ChannelBase)

public SearchServiceClient(ChannelBase channel)

Creates a new client for SearchService

Parameter
NameDescription
channelChannelBase

The channel to use to make remote calls.

SearchServiceClient(ClientBase.ClientBaseConfiguration)

protected SearchServiceClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
NameDescription
configurationClientBase.ClientBaseConfiguration

The client configuration.

Methods

NewInstance(ClientBase.ClientBaseConfiguration)

protected override SearchService.SearchServiceClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
NameDescription
configurationClientBase.ClientBaseConfiguration
Returns
TypeDescription
SearchService.SearchServiceClient
Overrides
Grpc.Core.ClientBase<Google.Cloud.Retail.V2.SearchService.SearchServiceClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

Search(SearchRequest, CallOptions)

public virtual SearchResponse Search(SearchRequest request, CallOptions options)

Performs a search.

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

Parameters
NameDescription
requestSearchRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
SearchResponse

The response received from the server.

Search(SearchRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual SearchResponse Search(SearchRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Performs a search.

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

Parameters
NameDescription
requestSearchRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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
SearchResponse

The response received from the server.

SearchAsync(SearchRequest, CallOptions)

public virtual AsyncUnaryCall<SearchResponse> SearchAsync(SearchRequest request, CallOptions options)

Performs a search.

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

Parameters
NameDescription
requestSearchRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCall<SearchResponse>

The call object.

SearchAsync(SearchRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<SearchResponse> SearchAsync(SearchRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))

Performs a search.

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

Parameters
NameDescription
requestSearchRequest

The request to send to the server.

headersMetadata

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

deadlineNullable<DateTime>

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
AsyncUnaryCall<SearchResponse>

The call object.