Class EngineServiceGrpc.EngineServiceFutureStub (0.90.0)

public static final class EngineServiceGrpc.EngineServiceFutureStub extends AbstractFutureStub<EngineServiceGrpc.EngineServiceFutureStub>

A stub to allow clients to do ListenableFuture-style rpc calls to service EngineService.

Service for managing Engine configuration.

Inheritance

java.lang.Object > io.grpc.stub.AbstractStub > io.grpc.stub.AbstractFutureStub > EngineServiceGrpc.EngineServiceFutureStub

Methods

build(Channel channel, CallOptions callOptions)

protected EngineServiceGrpc.EngineServiceFutureStub build(Channel channel, CallOptions callOptions)
Parameters
Name Description
channel io.grpc.Channel
callOptions io.grpc.CallOptions
Returns
Type Description
EngineServiceGrpc.EngineServiceFutureStub
Overrides
io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

createEngine(CreateEngineRequest request)

public ListenableFuture<Operation> createEngine(CreateEngineRequest request)

Creates an Engine.

Parameter
Name Description
request CreateEngineRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Operation>

deleteEngine(DeleteEngineRequest request)

public ListenableFuture<Operation> deleteEngine(DeleteEngineRequest request)

Deletes an Engine.

Parameter
Name Description
request DeleteEngineRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Operation>

getEngine(GetEngineRequest request)

public ListenableFuture<Engine> getEngine(GetEngineRequest request)

Gets an Engine.

Parameter
Name Description
request GetEngineRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Engine>

getIamPolicy(GetIamPolicyRequest request)

public ListenableFuture<Policy> getIamPolicy(GetIamPolicyRequest request)

Gets the IAM access control policy for an 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.

Parameter
Name Description
request com.google.iam.v1.GetIamPolicyRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<com.google.iam.v1.Policy>

listEngines(ListEnginesRequest request)

public ListenableFuture<ListEnginesResponse> listEngines(ListEnginesRequest request)

Lists all the Engines associated with the project.

Parameter
Name Description
request ListEnginesRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ListEnginesResponse>

pauseEngine(PauseEngineRequest request)

public ListenableFuture<Engine> pauseEngine(PauseEngineRequest request)

Pauses the training of an existing Engine. Only applicable if SolutionType is SOLUTION_TYPE_RECOMMENDATION.

Parameter
Name Description
request PauseEngineRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Engine>

resumeEngine(ResumeEngineRequest request)

public ListenableFuture<Engine> resumeEngine(ResumeEngineRequest request)

Resumes the training of an existing Engine. Only applicable if SolutionType is SOLUTION_TYPE_RECOMMENDATION.

Parameter
Name Description
request ResumeEngineRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Engine>

setIamPolicy(SetIamPolicyRequest request)

public ListenableFuture<Policy> setIamPolicy(SetIamPolicyRequest request)

Sets the IAM access control policy for an 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.

Parameter
Name Description
request com.google.iam.v1.SetIamPolicyRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<com.google.iam.v1.Policy>

tuneEngine(TuneEngineRequest request)

public ListenableFuture<Operation> tuneEngine(TuneEngineRequest request)

Tunes an existing Engine. Only applicable if SolutionType is SOLUTION_TYPE_RECOMMENDATION.

Parameter
Name Description
request TuneEngineRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Operation>

updateEngine(UpdateEngineRequest request)

public ListenableFuture<Engine> updateEngine(UpdateEngineRequest request)

Updates an Engine

Parameter
Name Description
request UpdateEngineRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Engine>