Class VizierServiceGrpc.VizierServiceBlockingStub (3.16.0)

Version 3.16.0

• 3.52.0 (latest)
• 3.50.0
• 3.49.0
• 3.48.0
• 3.47.0
• 3.46.0
• 3.45.0
• 3.44.0
• 3.43.0
• 3.42.0
• 3.41.0
• 3.40.0
• 3.38.0
• 3.37.0
• 3.36.0
• 3.35.0
• 3.34.0
• 3.33.0
• 3.32.0
• 3.31.0
• 3.30.0
• 3.29.0
• 3.28.0
• 3.25.0
• 3.24.0
• 3.23.0
• 3.22.0
• 3.21.0
• 3.20.0
• 3.19.0
• 3.18.0
• 3.17.0
• 3.16.0
• 3.15.0
• 3.14.0
• 3.13.0
• 3.12.0
• 3.11.0
• 3.10.0
• 3.9.0
• 3.8.0
• 3.7.0
• 3.6.0
• 3.5.0
• 3.4.2
• 3.3.0
• 3.2.0
• 3.0.0
• 2.9.8
• 2.8.9
• 2.7.4
• 2.5.3
• 2.4.0

public static final class VizierServiceGrpc.VizierServiceBlockingStub extends AbstractBlockingStub<VizierServiceGrpc.VizierServiceBlockingStub>

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

Vertex AI Vizier API. Vertex AI Vizier is a service to solve blackbox optimization problems, such as tuning machine learning hyperparameters and searching over deep learning architectures.

Inheritance

java.lang.Object > io.grpc.stub.AbstractStub > io.grpc.stub.AbstractBlockingStub > VizierServiceGrpc.VizierServiceBlockingStub

Inherited Members

io.grpc.stub.AbstractBlockingStub.<T>newStub(io.grpc.stub.AbstractStub.StubFactory<T>,io.grpc.Channel)

io.grpc.stub.AbstractBlockingStub.<T>newStub(io.grpc.stub.AbstractStub.StubFactory<T>,io.grpc.Channel,io.grpc.CallOptions)

io.grpc.stub.AbstractStub.<T>withOption(io.grpc.CallOptions.Key<T>,T)

io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

io.grpc.stub.AbstractStub.getCallOptions()

io.grpc.stub.AbstractStub.getChannel()

io.grpc.stub.AbstractStub.withCallCredentials(io.grpc.CallCredentials)

io.grpc.stub.AbstractStub.withChannel(io.grpc.Channel)

io.grpc.stub.AbstractStub.withCompression(java.lang.String)

io.grpc.stub.AbstractStub.withDeadline(io.grpc.Deadline)

io.grpc.stub.AbstractStub.withDeadlineAfter(long,java.util.concurrent.TimeUnit)

io.grpc.stub.AbstractStub.withExecutor(java.util.concurrent.Executor)

io.grpc.stub.AbstractStub.withInterceptors(io.grpc.ClientInterceptor...)

io.grpc.stub.AbstractStub.withMaxInboundMessageSize(int)

io.grpc.stub.AbstractStub.withMaxOutboundMessageSize(int)

io.grpc.stub.AbstractStub.withWaitForReady()

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Methods

addTrialMeasurement(AddTrialMeasurementRequest request)

public Trial addTrialMeasurement(AddTrialMeasurementRequest request)

Adds a measurement of the objective metrics to a Trial. This measurement is assumed to have been taken before the Trial is complete.

Parameter
Name	Description
request	AddTrialMeasurementRequest

Returns
Type	Description
Trial

build(Channel channel, CallOptions callOptions)

protected VizierServiceGrpc.VizierServiceBlockingStub build(Channel channel, CallOptions callOptions)

Parameters
Name	Description
channel	io.grpc.Channel
callOptions	io.grpc.CallOptions

Returns
Type	Description
VizierServiceGrpc.VizierServiceBlockingStub

Overrides

io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

checkTrialEarlyStoppingState(CheckTrialEarlyStoppingStateRequest request)

public Operation checkTrialEarlyStoppingState(CheckTrialEarlyStoppingStateRequest request)

Checks whether a Trial should stop or not. Returns a long-running operation. When the operation is successful, it will contain a CheckTrialEarlyStoppingStateResponse.

Parameter
Name	Description
request	CheckTrialEarlyStoppingStateRequest

Returns
Type	Description
Operation

completeTrial(CompleteTrialRequest request)

public Trial completeTrial(CompleteTrialRequest request)

Marks a Trial as complete.

Parameter
Name	Description
request	CompleteTrialRequest

Returns
Type	Description
Trial

createStudy(CreateStudyRequest request)

public Study createStudy(CreateStudyRequest request)

Creates a Study. A resource name will be generated after creation of the Study.

Parameter
Name	Description
request	CreateStudyRequest

Returns
Type	Description
Study

createTrial(CreateTrialRequest request)

public Trial createTrial(CreateTrialRequest request)

Adds a user provided Trial to a Study.

Parameter
Name	Description
request	CreateTrialRequest

Returns
Type	Description
Trial

deleteStudy(DeleteStudyRequest request)

public Empty deleteStudy(DeleteStudyRequest request)

Deletes a Study.

Parameter
Name	Description
request	DeleteStudyRequest

Returns
Type	Description
Empty

deleteTrial(DeleteTrialRequest request)

public Empty deleteTrial(DeleteTrialRequest request)

Deletes a Trial.

Parameter
Name	Description
request	DeleteTrialRequest

Returns
Type	Description
Empty

getStudy(GetStudyRequest request)

public Study getStudy(GetStudyRequest request)

Gets a Study by name.

Parameter
Name	Description
request	GetStudyRequest

Returns
Type	Description
Study

getTrial(GetTrialRequest request)

public Trial getTrial(GetTrialRequest request)

Gets a Trial.

Parameter
Name	Description
request	GetTrialRequest

Returns
Type	Description
Trial

listOptimalTrials(ListOptimalTrialsRequest request)

public ListOptimalTrialsResponse listOptimalTrials(ListOptimalTrialsRequest request)

Lists the pareto-optimal Trials for multi-objective Study or the optimal Trials for single-objective Study. The definition of pareto-optimal can be checked in wiki page. https://en.wikipedia.org/wiki/Pareto_efficiency

Parameter
Name	Description
request	ListOptimalTrialsRequest

Returns
Type	Description
ListOptimalTrialsResponse

listStudies(ListStudiesRequest request)

public ListStudiesResponse listStudies(ListStudiesRequest request)

Lists all the studies in a region for an associated project.

Parameter
Name	Description
request	ListStudiesRequest

Returns
Type	Description
ListStudiesResponse

listTrials(ListTrialsRequest request)

public ListTrialsResponse listTrials(ListTrialsRequest request)

Lists the Trials associated with a Study.

Parameter
Name	Description
request	ListTrialsRequest

Returns
Type	Description
ListTrialsResponse

lookupStudy(LookupStudyRequest request)

public Study lookupStudy(LookupStudyRequest request)

Looks a study up using the user-defined display_name field instead of the fully qualified resource name.

Parameter
Name	Description
request	LookupStudyRequest

Returns
Type	Description
Study

stopTrial(StopTrialRequest request)

public Trial stopTrial(StopTrialRequest request)

Stops a Trial.

Parameter
Name	Description
request	StopTrialRequest

Returns
Type	Description
Trial

suggestTrials(SuggestTrialsRequest request)

public Operation suggestTrials(SuggestTrialsRequest request)

Adds one or more Trials to a Study, with parameter values suggested by Vertex AI Vizier. Returns a long-running operation associated with the generation of Trial suggestions. When this long-running operation succeeds, it will contain a SuggestTrialsResponse.

Parameter
Name	Description
request	SuggestTrialsRequest

Returns
Type	Description
Operation