Class EngineServiceGrpc.EngineServiceBlockingV2Stub (0.90.0)

public static final class EngineServiceGrpc.EngineServiceBlockingV2Stub extends AbstractBlockingStub<EngineServiceGrpc.EngineServiceBlockingV2Stub>

A stub to allow clients to do synchronous rpc calls to service EngineService.

Service for managing Engine configuration.

Inheritance

java.lang.Object > io.grpc.stub.AbstractStub > io.grpc.stub.AbstractBlockingStub > EngineServiceGrpc.EngineServiceBlockingV2Stub

Methods

build(Channel channel, CallOptions callOptions)

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

createEngine(CreateEngineRequest request)

public Operation createEngine(CreateEngineRequest request)

Creates an Engine.

Parameter
Name Description
request CreateEngineRequest
Returns
Type Description
Operation
Exceptions
Type Description
io.grpc.StatusException

deleteEngine(DeleteEngineRequest request)

public Operation deleteEngine(DeleteEngineRequest request)

Deletes an Engine.

Parameter
Name Description
request DeleteEngineRequest
Returns
Type Description
Operation
Exceptions
Type Description
io.grpc.StatusException

getEngine(GetEngineRequest request)

public Engine getEngine(GetEngineRequest request)

Gets an Engine.

Parameter
Name Description
request GetEngineRequest
Returns
Type Description
Engine
Exceptions
Type Description
io.grpc.StatusException

getIamPolicy(GetIamPolicyRequest request)

public 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.iam.v1.Policy
Exceptions
Type Description
io.grpc.StatusException

listEngines(ListEnginesRequest request)

public ListEnginesResponse listEngines(ListEnginesRequest request)

Lists all the Engines associated with the project.

Parameter
Name Description
request ListEnginesRequest
Returns
Type Description
ListEnginesResponse
Exceptions
Type Description
io.grpc.StatusException

pauseEngine(PauseEngineRequest request)

public 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
Engine
Exceptions
Type Description
io.grpc.StatusException

resumeEngine(ResumeEngineRequest request)

public 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
Engine
Exceptions
Type Description
io.grpc.StatusException

setIamPolicy(SetIamPolicyRequest request)

public 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.iam.v1.Policy
Exceptions
Type Description
io.grpc.StatusException

tuneEngine(TuneEngineRequest request)

public Operation tuneEngine(TuneEngineRequest request)

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

Parameter
Name Description
request TuneEngineRequest
Returns
Type Description
Operation
Exceptions
Type Description
io.grpc.StatusException

updateEngine(UpdateEngineRequest request)

public Engine updateEngine(UpdateEngineRequest request)

Updates an Engine

Parameter
Name Description
request UpdateEngineRequest
Returns
Type Description
Engine
Exceptions
Type Description
io.grpc.StatusException