Discovery Engine v1 API - Class SearchService.SearchServiceClient (1.2.0)

Version 1.2.0

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

public class SearchService.SearchServiceClient : ClientBase<SearchService.SearchServiceClient>

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

Client for SearchService

Inheritance

object > ClientBase > ClientBaseSearchServiceSearchServiceClient > SearchService.SearchServiceClient

Inherited Members

ClientBase<SearchService.SearchServiceClient>.WithHost(string)

ClientBase.CallInvoker

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.DiscoveryEngine.V1

Assembly

Google.Cloud.DiscoveryEngine.V1.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
Name	Description
callInvoker	CallInvoker The callInvoker to use to make remote calls.

SearchServiceClient(ChannelBase)

public SearchServiceClient(ChannelBase channel)

Creates a new client for SearchService

Parameter
Name	Description
channel	ChannelBase The channel to use to make remote calls.

SearchServiceClient(ClientBaseConfiguration)

protected SearchServiceClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration The client configuration.

Methods

CreateLocationsClient()

public virtual Locations.LocationsClient CreateLocationsClient()

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

Returns
Type	Description
LocationsLocationsClient	A new Locations.LocationsClient for the same target as this client.

NewInstance(ClientBaseConfiguration)

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

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration

Returns
Type	Description
SearchServiceSearchServiceClient

Overrides

ClientBase<SearchService.SearchServiceClient>.NewInstance(ClientBase.ClientBaseConfiguration)

Search(SearchRequest, CallOptions)

public virtual SearchResponse Search(SearchRequest request, CallOptions options)

Performs a search.

Parameters
Name	Description
request	SearchRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
SearchResponse	The response received from the server.

Search(SearchRequest, Metadata, DateTime?, CancellationToken)

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

Performs a search.

Parameters
Name	Description
request	SearchRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
SearchResponse	The response received from the server.

SearchAsync(SearchRequest, CallOptions)

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

Performs a search.

Parameters
Name	Description
request	SearchRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallSearchResponse	The call object.

SearchAsync(SearchRequest, Metadata, DateTime?, CancellationToken)

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

Performs a search.

Parameters
Name	Description
request	SearchRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallSearchResponse	The call object.