Retail v2 API - Class ModelService.ModelServiceBase (2.8.0)

[BindServiceMethod(typeof(ModelService), "BindService")]
public abstract class ModelService.ModelServiceBase

Reference documentation and code samples for the Retail v2 API class ModelService.ModelServiceBase.

Base class for server-side implementations of ModelService

Inheritance

object > ModelService.ModelServiceBase

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.Retail.V2

Assembly

Google.Cloud.Retail.V2.dll

Methods

CreateModel(CreateModelRequest, ServerCallContext)

public virtual Task<Operation> CreateModel(CreateModelRequest request, ServerCallContext context)

Creates a new model.

Parameters
Name	Description
`request`	`CreateModelRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskOperation`	The response to send back to the client (wrapped by a task).

DeleteModel(DeleteModelRequest, ServerCallContext)

public virtual Task<Empty> DeleteModel(DeleteModelRequest request, ServerCallContext context)

Deletes an existing model.

Parameters
Name	Description
`request`	`DeleteModelRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskEmpty`	The response to send back to the client (wrapped by a task).

GetModel(GetModelRequest, ServerCallContext)

public virtual Task<Model> GetModel(GetModelRequest request, ServerCallContext context)

Gets a model.

Parameters
Name	Description
`request`	`GetModelRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskModel`	The response to send back to the client (wrapped by a task).

ListModels(ListModelsRequest, ServerCallContext)

public virtual Task<ListModelsResponse> ListModels(ListModelsRequest request, ServerCallContext context)

Lists all the models linked to this event store.

Parameters
Name	Description
`request`	`ListModelsRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskListModelsResponse`	The response to send back to the client (wrapped by a task).

PauseModel(PauseModelRequest, ServerCallContext)

public virtual Task<Model> PauseModel(PauseModelRequest request, ServerCallContext context)

Pauses the training of an existing model.

Parameters
Name	Description
`request`	`PauseModelRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskModel`	The response to send back to the client (wrapped by a task).

ResumeModel(ResumeModelRequest, ServerCallContext)

public virtual Task<Model> ResumeModel(ResumeModelRequest request, ServerCallContext context)

Resumes the training of an existing model.

Parameters
Name	Description
`request`	`ResumeModelRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskModel`	The response to send back to the client (wrapped by a task).

TuneModel(TuneModelRequest, ServerCallContext)

public virtual Task<Operation> TuneModel(TuneModelRequest request, ServerCallContext context)

Tunes an existing model.

Parameters
Name	Description
`request`	`TuneModelRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskOperation`	The response to send back to the client (wrapped by a task).

UpdateModel(UpdateModelRequest, ServerCallContext)

public virtual Task<Model> UpdateModel(UpdateModelRequest request, ServerCallContext context)

Update of model metadata. Only fields that currently can be updated are: filtering_option and periodic_tuning_state. If other values are provided, this API method ignores them.

Parameters
Name	Description
`request`	`UpdateModelRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskModel`	The response to send back to the client (wrapped by a task).