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.

Class VizierServiceGrpc.VizierServiceStub (3.60.0)

public static final class VizierServiceGrpc.VizierServiceStub extends AbstractAsyncStub<VizierServiceGrpc.VizierServiceStub>

A stub to allow clients to do asynchronous 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.AbstractAsyncStub > VizierServiceGrpc.VizierServiceStub

Inherited Members

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

io.grpc.stub.AbstractAsyncStub.<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(java.time.Duration)

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.withOnReadyThreshold(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, StreamObserver<Trial> responseObserver)

public void addTrialMeasurement(AddTrialMeasurementRequest request, StreamObserver<Trial> responseObserver)

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

Parameters
Name	Description
`request`	`AddTrialMeasurementRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<Trial>`

build(Channel channel, CallOptions callOptions)

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

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

Returns
Type	Description
`VizierServiceGrpc.VizierServiceStub`

Overrides

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

checkTrialEarlyStoppingState(CheckTrialEarlyStoppingStateRequest request, StreamObserver<Operation> responseObserver)

public void checkTrialEarlyStoppingState(CheckTrialEarlyStoppingStateRequest request, StreamObserver<Operation> responseObserver)

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

Parameters
Name	Description
`request`	`CheckTrialEarlyStoppingStateRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<Operation>`

completeTrial(CompleteTrialRequest request, StreamObserver<Trial> responseObserver)

public void completeTrial(CompleteTrialRequest request, StreamObserver<Trial> responseObserver)

Marks a Trial as complete.

Parameters
Name	Description
`request`	`CompleteTrialRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<Trial>`

createStudy(CreateStudyRequest request, StreamObserver<Study> responseObserver)

public void createStudy(CreateStudyRequest request, StreamObserver<Study> responseObserver)

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

Parameters
Name	Description
`request`	`CreateStudyRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<Study>`

createTrial(CreateTrialRequest request, StreamObserver<Trial> responseObserver)

public void createTrial(CreateTrialRequest request, StreamObserver<Trial> responseObserver)

Adds a user provided Trial to a Study.

Parameters
Name	Description
`request`	`CreateTrialRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<Trial>`

deleteStudy(DeleteStudyRequest request, StreamObserver<Empty> responseObserver)

public void deleteStudy(DeleteStudyRequest request, StreamObserver<Empty> responseObserver)

Deletes a Study.

Parameters
Name	Description
`request`	`DeleteStudyRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<Empty>`

deleteTrial(DeleteTrialRequest request, StreamObserver<Empty> responseObserver)

public void deleteTrial(DeleteTrialRequest request, StreamObserver<Empty> responseObserver)

Deletes a Trial.

Parameters
Name	Description
`request`	`DeleteTrialRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<Empty>`

getStudy(GetStudyRequest request, StreamObserver<Study> responseObserver)

public void getStudy(GetStudyRequest request, StreamObserver<Study> responseObserver)

Gets a Study by name.

Parameters
Name	Description
`request`	`GetStudyRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<Study>`

getTrial(GetTrialRequest request, StreamObserver<Trial> responseObserver)

public void getTrial(GetTrialRequest request, StreamObserver<Trial> responseObserver)

Gets a Trial.

Parameters
Name	Description
`request`	`GetTrialRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<Trial>`

listOptimalTrials(ListOptimalTrialsRequest request, StreamObserver<ListOptimalTrialsResponse> responseObserver)

public void listOptimalTrials(ListOptimalTrialsRequest request, StreamObserver<ListOptimalTrialsResponse> responseObserver)

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

Parameters
Name	Description
`request`	`ListOptimalTrialsRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<ListOptimalTrialsResponse>`

listStudies(ListStudiesRequest request, StreamObserver<ListStudiesResponse> responseObserver)

public void listStudies(ListStudiesRequest request, StreamObserver<ListStudiesResponse> responseObserver)

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

Parameters
Name	Description
`request`	`ListStudiesRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<ListStudiesResponse>`

listTrials(ListTrialsRequest request, StreamObserver<ListTrialsResponse> responseObserver)

public void listTrials(ListTrialsRequest request, StreamObserver<ListTrialsResponse> responseObserver)

Lists the Trials associated with a Study.

Parameters
Name	Description
`request`	`ListTrialsRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<ListTrialsResponse>`

lookupStudy(LookupStudyRequest request, StreamObserver<Study> responseObserver)

public void lookupStudy(LookupStudyRequest request, StreamObserver<Study> responseObserver)

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

Parameters
Name	Description
`request`	`LookupStudyRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<Study>`

stopTrial(StopTrialRequest request, StreamObserver<Trial> responseObserver)

public void stopTrial(StopTrialRequest request, StreamObserver<Trial> responseObserver)

Stops a Trial.

Parameters
Name	Description
`request`	`StopTrialRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<Trial>`

suggestTrials(SuggestTrialsRequest request, StreamObserver<Operation> responseObserver)

public void suggestTrials(SuggestTrialsRequest request, StreamObserver<Operation> responseObserver)

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.

Parameters
Name	Description
`request`	`SuggestTrialsRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<Operation>`