Discovery Engine v1beta API - Class SearchService.SearchServiceClient (1.0.0-beta18)

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

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

Client for SearchService

Inheritance

object > ClientBase > ClientBase SearchService SearchServiceClient > SearchService.SearchServiceClient

Inherited Members

ClientBase<SearchService.SearchServiceClient>.WithHost(string)

ClientBase.CallInvoker

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.DiscoveryEngine.V1Beta

Assembly

Google.Cloud.DiscoveryEngine.V1Beta.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

Grpc.Core.ClientBase<Google.Cloud.DiscoveryEngine.V1Beta.SearchService.SearchServiceClient>.NewInstance(Grpc.Core.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`	`System.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`	`System.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.

SearchLite(SearchRequest, CallOptions)

public virtual SearchResponse SearchLite(SearchRequest request, CallOptions options)

Performs a search. Similar to the [SearchService.Search][google.cloud.discoveryengine.v1beta.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.v1beta.SearchService.Search] instead with required OAuth and IAM checks to provide better data security.

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.

SearchLite(SearchRequest, Metadata, DateTime?, CancellationToken)

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

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.

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`	`System.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.

SearchLiteAsync(SearchRequest, CallOptions)

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

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.

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.

SearchLiteAsync(SearchRequest, Metadata, DateTime?, CancellationToken)

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

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.

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`	`System.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.