Discovery Engine v1beta API - Class EngineService.EngineServiceBase (1.0.0-beta20)

Version latest

• 1.0.0-beta20 (latest)
• 1.0.0-beta19

[BindServiceMethod(typeof(EngineService), "BindService")]
public abstract class EngineService.EngineServiceBase

Reference documentation and code samples for the Discovery Engine v1beta API class EngineService.EngineServiceBase.

Base class for server-side implementations of EngineService

Inheritance

object > EngineService.EngineServiceBase

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.DiscoveryEngine.V1Beta

Assembly

Google.Cloud.DiscoveryEngine.V1Beta.dll

Methods

CreateEngine(CreateEngineRequest, ServerCallContext)

public virtual Task<Operation> CreateEngine(CreateEngineRequest request, ServerCallContext context)

Creates a [Engine][google.cloud.discoveryengine.v1beta.Engine].

Parameters
Name	Description
request	CreateEngineRequest 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).

DeleteEngine(DeleteEngineRequest, ServerCallContext)

public virtual Task<Operation> DeleteEngine(DeleteEngineRequest request, ServerCallContext context)

Deletes a [Engine][google.cloud.discoveryengine.v1beta.Engine].

Parameters
Name	Description
request	DeleteEngineRequest 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).

GetEngine(GetEngineRequest, ServerCallContext)

public virtual Task<Engine> GetEngine(GetEngineRequest request, ServerCallContext context)

Gets a [Engine][google.cloud.discoveryengine.v1beta.Engine].

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

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

ListEngines(ListEnginesRequest, ServerCallContext)

public virtual Task<ListEnginesResponse> ListEngines(ListEnginesRequest request, ServerCallContext context)

Lists all the [Engine][google.cloud.discoveryengine.v1beta.Engine]s associated with the project.

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

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

PauseEngine(PauseEngineRequest, ServerCallContext)

public virtual Task<Engine> PauseEngine(PauseEngineRequest request, ServerCallContext context)

Pauses the training of an existing engine. Only applicable if [SolutionType][google.cloud.discoveryengine.v1beta.SolutionType] is [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_RECOMMENDATION].

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

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

ResumeEngine(ResumeEngineRequest, ServerCallContext)

public virtual Task<Engine> ResumeEngine(ResumeEngineRequest request, ServerCallContext context)

Resumes the training of an existing engine. Only applicable if [SolutionType][google.cloud.discoveryengine.v1beta.SolutionType] is [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_RECOMMENDATION].

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

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

TuneEngine(TuneEngineRequest, ServerCallContext)

public virtual Task<Operation> TuneEngine(TuneEngineRequest request, ServerCallContext context)

Tunes an existing engine. Only applicable if [SolutionType][google.cloud.discoveryengine.v1beta.SolutionType] is [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_RECOMMENDATION].

Parameters
Name	Description
request	TuneEngineRequest 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).

UpdateEngine(UpdateEngineRequest, ServerCallContext)

public virtual Task<Engine> UpdateEngine(UpdateEngineRequest request, ServerCallContext context)

Updates an [Engine][google.cloud.discoveryengine.v1beta.Engine]

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

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