Some or all of the information on this page might not apply to Cloud de Confiance by S3NS. See Differences from Google Cloud for more details.

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

[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 an [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 an [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 an [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).

GetIamPolicy(GetIamPolicyRequest, ServerCallContext)

public virtual Task<Policy> GetIamPolicy(GetIamPolicyRequest request, ServerCallContext context)

Gets the IAM access control policy for an [Engine][google.cloud.discoveryengine.v1beta.Engine]. A NOT_FOUND error is returned if the resource does not exist. An empty policy is returned if the resource exists but does not have a policy set on it.

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

Returns
Type	Description
`TaskPolicy`	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][google.cloud.discoveryengine.v1beta.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][google.cloud.discoveryengine.v1beta.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).

SetIamPolicy(SetIamPolicyRequest, ServerCallContext)

public virtual Task<Policy> SetIamPolicy(SetIamPolicyRequest request, ServerCallContext context)

Sets the IAM access control policy for an [Engine][google.cloud.discoveryengine.v1beta.Engine]. A NOT_FOUND error is returned if the resource does not exist.

Important: When setting a policy directly on an Engine resource, the only recommended roles in the bindings are: roles/discoveryengine.admin, roles/discoveryengine.agentspaceAdmin, roles/discoveryengine.user, roles/discoveryengine.agentspaceUser, roles/discoveryengine.viewer, roles/discoveryengine.agentspaceViewer. Attempting to grant any other role will result in a warning in logging.

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

Returns
Type	Description
`TaskPolicy`	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][google.cloud.discoveryengine.v1beta.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).