Discovery Engine v1 API - Class SearchTuningService.SearchTuningServiceClient (1.5.0)

Version 1.5.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 SearchTuningService.SearchTuningServiceClient : ClientBase<SearchTuningService.SearchTuningServiceClient>

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

Client for SearchTuningService

Inheritance

object > ClientBase > ClientBaseSearchTuningServiceSearchTuningServiceClient > SearchTuningService.SearchTuningServiceClient

Inherited Members

ClientBase<SearchTuningService.SearchTuningServiceClient>.WithHost(string)

ClientBase.CallInvoker

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.DiscoveryEngine.V1

Assembly

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

SearchTuningServiceClient(ChannelBase)

public SearchTuningServiceClient(ChannelBase channel)

Creates a new client for SearchTuningService

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

SearchTuningServiceClient(ClientBaseConfiguration)

protected SearchTuningServiceClient(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.

CreateOperationsClient()

public virtual Operations.OperationsClient CreateOperationsClient()

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

Returns
Type	Description
OperationsOperationsClient	A new Operations client for the same target as this client.

ListCustomModels(ListCustomModelsRequest, CallOptions)

public virtual ListCustomModelsResponse ListCustomModels(ListCustomModelsRequest request, CallOptions options)

Gets a list of all the custom models.

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

Returns
Type	Description
ListCustomModelsResponse	The response received from the server.

ListCustomModels(ListCustomModelsRequest, Metadata, DateTime?, CancellationToken)

public virtual ListCustomModelsResponse ListCustomModels(ListCustomModelsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets a list of all the custom models.

Parameters
Name	Description
request	ListCustomModelsRequest 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
ListCustomModelsResponse	The response received from the server.

ListCustomModelsAsync(ListCustomModelsRequest, CallOptions)

public virtual AsyncUnaryCall<ListCustomModelsResponse> ListCustomModelsAsync(ListCustomModelsRequest request, CallOptions options)

Gets a list of all the custom models.

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

Returns
Type	Description
AsyncUnaryCallListCustomModelsResponse	The call object.

ListCustomModelsAsync(ListCustomModelsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListCustomModelsResponse> ListCustomModelsAsync(ListCustomModelsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets a list of all the custom models.

Parameters
Name	Description
request	ListCustomModelsRequest 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
AsyncUnaryCallListCustomModelsResponse	The call object.

NewInstance(ClientBaseConfiguration)

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

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration

Returns
Type	Description
SearchTuningServiceSearchTuningServiceClient

Overrides

Grpc.Core.ClientBase<Google.Cloud.DiscoveryEngine.V1.SearchTuningService.SearchTuningServiceClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

TrainCustomModel(TrainCustomModelRequest, CallOptions)

public virtual Operation TrainCustomModel(TrainCustomModelRequest request, CallOptions options)

Trains a custom model.

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

Returns
Type	Description
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
Name	Description
request	TrainCustomModelRequest 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
Operation	The response received from the server.

TrainCustomModelAsync(TrainCustomModelRequest, CallOptions)

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

Trains a custom model.

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

Returns
Type	Description
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
Name	Description
request	TrainCustomModelRequest 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
AsyncUnaryCallOperation	The call object.