Discovery Engine v1 API - Class RankService.RankServiceClient (1.10.0)

public class RankService.RankServiceClient : ClientBase<RankService.RankServiceClient>

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

Client for RankService

Inheritance

object > ClientBase > ClientBase RankService RankServiceClient > RankService.RankServiceClient

Inherited Members

ClientBase<RankService.RankServiceClient>.WithHost(string)

ClientBase.CallInvoker

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.DiscoveryEngine.V1

Assembly

Google.Cloud.DiscoveryEngine.V1.dll

Constructors

RankServiceClient()

protected RankServiceClient()

Protected parameterless constructor to allow creation of test doubles.

RankServiceClient(CallInvoker)

public RankServiceClient(CallInvoker callInvoker)

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

Parameter
Name	Description
`callInvoker`	`CallInvoker` The callInvoker to use to make remote calls.

RankServiceClient(ChannelBase)

public RankServiceClient(ChannelBase channel)

Creates a new client for RankService

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

RankServiceClient(ClientBaseConfiguration)

protected RankServiceClient(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 RankService.RankServiceClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name	Description
`configuration`	`ClientBaseClientBaseConfiguration`

Returns
Type	Description
`RankServiceRankServiceClient`

Overrides

Grpc.Core.ClientBase<Google.Cloud.DiscoveryEngine.V1.RankService.RankServiceClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

Rank(RankRequest, CallOptions)

public virtual RankResponse Rank(RankRequest request, CallOptions options)

Ranks a list of text records based on the given input query.

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

Returns
Type	Description
`RankResponse`	The response received from the server.

Rank(RankRequest, Metadata, DateTime?, CancellationToken)

public virtual RankResponse Rank(RankRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Ranks a list of text records based on the given input query.

Parameters
Name	Description
`request`	`RankRequest` 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
`RankResponse`	The response received from the server.

RankAsync(RankRequest, CallOptions)

public virtual AsyncUnaryCall<RankResponse> RankAsync(RankRequest request, CallOptions options)

Ranks a list of text records based on the given input query.

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

Returns
Type	Description
`AsyncUnaryCallRankResponse`	The call object.

RankAsync(RankRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<RankResponse> RankAsync(RankRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Ranks a list of text records based on the given input query.

Parameters
Name	Description
`request`	`RankRequest` 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
`AsyncUnaryCallRankResponse`	The call object.