Discovery Engine v1beta API - Class SearchTuningService.SearchTuningServiceClient (1.0.0-beta10)

public class SearchTuningService.SearchTuningServiceClient : ClientBase<SearchTuningService.SearchTuningServiceClient>

Reference documentation and code samples for the Discovery Engine v1beta API class SearchTuningService.SearchTuningServiceClient.

Client for SearchTuningService

Inheritance

object > ClientBase > ClientBaseSearchTuningServiceSearchTuningServiceClient > SearchTuningService.SearchTuningServiceClient

Namespace

Google.Cloud.DiscoveryEngine.V1Beta

Assembly

Google.Cloud.DiscoveryEngine.V1Beta.dll

Constructors

SearchTuningServiceClient()

protected SearchTuningServiceClient()

Protected parameterless constructor to allow creation of test doubles.

SearchTuningServiceClient(CallInvoker)

public SearchTuningServiceClient(CallInvoker callInvoker)

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

Parameter
NameDescription
callInvokerCallInvoker

The callInvoker to use to make remote calls.

SearchTuningServiceClient(ChannelBase)

public SearchTuningServiceClient(ChannelBase channel)

Creates a new client for SearchTuningService

Parameter
NameDescription
channelChannelBase

The channel to use to make remote calls.

SearchTuningServiceClient(ClientBaseConfiguration)

protected SearchTuningServiceClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
NameDescription
configurationClientBaseClientBaseConfiguration

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
TypeDescription
LocationsLocationsClient

A new Locations.LocationsClient for the same target as this client.

CreateOperationsClient()

public virtual Operations.OperationsClient CreateOperationsClient()

Creates a new instance of Operations.OperationsClient using the same call invoker as this client.

Returns
TypeDescription
OperationsOperationsClient

A new Operations client for the same target as this client.

NewInstance(ClientBaseConfiguration)

protected override SearchTuningService.SearchTuningServiceClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
NameDescription
configurationClientBaseClientBaseConfiguration
Returns
TypeDescription
SearchTuningServiceSearchTuningServiceClient
Overrides

TrainCustomModel(TrainCustomModelRequest, CallOptions)

public virtual Operation TrainCustomModel(TrainCustomModelRequest request, CallOptions options)

Trains a custom model.

Parameters
NameDescription
requestTrainCustomModelRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

TrainCustomModel(TrainCustomModelRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation TrainCustomModel(TrainCustomModelRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Trains a custom model.

Parameters
NameDescription
requestTrainCustomModelRequest

The request to send to the server.

headersMetadata

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

deadlineDateTime

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
Operation

The response received from the server.

TrainCustomModelAsync(TrainCustomModelRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> TrainCustomModelAsync(TrainCustomModelRequest request, CallOptions options)

Trains a custom model.

Parameters
NameDescription
requestTrainCustomModelRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

TrainCustomModelAsync(TrainCustomModelRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> TrainCustomModelAsync(TrainCustomModelRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Trains a custom model.

Parameters
NameDescription
requestTrainCustomModelRequest

The request to send to the server.

headersMetadata

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

deadlineDateTime

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
AsyncUnaryCallOperation

The call object.