Discovery Engine v1 API - Class SearchTuningServiceClientImpl (1.5.0)

public sealed class SearchTuningServiceClientImpl : SearchTuningServiceClient

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

SearchTuningService client wrapper implementation, for convenient use.

Inheritance

object > SearchTuningServiceClient > SearchTuningServiceClientImpl

Inherited Members

SearchTuningServiceClient.DefaultEndpoint

SearchTuningServiceClient.DefaultScopes

SearchTuningServiceClient.ServiceMetadata

SearchTuningServiceClient.CreateAsync(CancellationToken)

SearchTuningServiceClient.Create()

SearchTuningServiceClient.ShutdownDefaultChannelsAsync()

SearchTuningServiceClient.TrainCustomModelAsync(TrainCustomModelRequest, CancellationToken)

SearchTuningServiceClient.PollOnceTrainCustomModel(string, CallSettings)

SearchTuningServiceClient.PollOnceTrainCustomModelAsync(string, CallSettings)

SearchTuningServiceClient.ListCustomModelsAsync(ListCustomModelsRequest, CancellationToken)

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.DiscoveryEngine.V1

Assembly

Google.Cloud.DiscoveryEngine.V1.dll

Remarks

Service for search tuning.

Constructors

SearchTuningServiceClientImpl(SearchTuningServiceClient, SearchTuningServiceSettings, ILogger)

public SearchTuningServiceClientImpl(SearchTuningService.SearchTuningServiceClient grpcClient, SearchTuningServiceSettings settings, ILogger logger)

Constructs a client wrapper for the SearchTuningService service, with the specified gRPC client and settings.

Parameters
Name	Description
`grpcClient`	`SearchTuningServiceSearchTuningServiceClient` The underlying gRPC client.
`settings`	`SearchTuningServiceSettings` The base SearchTuningServiceSettings used within this client.
`logger`	`ILogger` Optional ILogger to use within this client.

Properties

GrpcClient

public override SearchTuningService.SearchTuningServiceClient GrpcClient { get; }

The underlying gRPC SearchTuningService client

Property Value
Type	Description
`SearchTuningServiceSearchTuningServiceClient`

Overrides

SearchTuningServiceClient.GrpcClient

LocationsClient

public override LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
Type	Description
`LocationsClient`

Overrides

SearchTuningServiceClient.LocationsClient

TrainCustomModelOperationsClient

public override OperationsClient TrainCustomModelOperationsClient { get; }

The long-running operations client for TrainCustomModel.

Property Value
Type	Description
`OperationsClient`

Overrides

SearchTuningServiceClient.TrainCustomModelOperationsClient

Methods

ListCustomModels(ListCustomModelsRequest, CallSettings)

public override ListCustomModelsResponse ListCustomModels(ListCustomModelsRequest request, CallSettings callSettings = null)

Gets a list of all the custom models.

Parameters
Name	Description
`request`	`ListCustomModelsRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`ListCustomModelsResponse`	The RPC response.

Overrides

SearchTuningServiceClient.ListCustomModels(ListCustomModelsRequest, CallSettings)

ListCustomModelsAsync(ListCustomModelsRequest, CallSettings)

public override Task<ListCustomModelsResponse> ListCustomModelsAsync(ListCustomModelsRequest request, CallSettings callSettings = null)

Gets a list of all the custom models.

Parameters
Name	Description
`request`	`ListCustomModelsRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`TaskListCustomModelsResponse`	A Task containing the RPC response.

Overrides

SearchTuningServiceClient.ListCustomModelsAsync(ListCustomModelsRequest, CallSettings)

TrainCustomModel(TrainCustomModelRequest, CallSettings)

public override Operation<TrainCustomModelResponse, TrainCustomModelMetadata> TrainCustomModel(TrainCustomModelRequest request, CallSettings callSettings = null)

Trains a custom model.

Parameters
Name	Description
`request`	`TrainCustomModelRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`OperationTrainCustomModelResponseTrainCustomModelMetadata`	The RPC response.

Overrides

SearchTuningServiceClient.TrainCustomModel(TrainCustomModelRequest, CallSettings)

TrainCustomModelAsync(TrainCustomModelRequest, CallSettings)

public override Task<Operation<TrainCustomModelResponse, TrainCustomModelMetadata>> TrainCustomModelAsync(TrainCustomModelRequest request, CallSettings callSettings = null)

Trains a custom model.

Parameters
Name	Description
`request`	`TrainCustomModelRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`TaskOperationTrainCustomModelResponseTrainCustomModelMetadata`	A Task containing the RPC response.

Overrides

SearchTuningServiceClient.TrainCustomModelAsync(TrainCustomModelRequest, CallSettings)