com.google.cloud.aiplatform.v1beta1

Class VizierServiceGrpc.VizierServiceFutureStub

java.lang.Object

io.grpc.stub.AbstractStub<S>

io.grpc.stub.AbstractFutureStub<VizierServiceGrpc.VizierServiceFutureStub>

com.google.cloud.aiplatform.v1beta1.VizierServiceGrpc.VizierServiceFutureStub

Enclosing class:

VizierServiceGrpc

public static final class VizierServiceGrpc.VizierServiceFutureStub
extends io.grpc.stub.AbstractFutureStub<VizierServiceGrpc.VizierServiceFutureStub>

A stub to allow clients to do ListenableFuture-style 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.
 

Nested Class Summary

Nested classes/interfaces inherited from class io.grpc.stub.AbstractStub

io.grpc.stub.AbstractStub.StubFactory<T extends io.grpc.stub.AbstractStub<T>>

Method Summary

Modifier and Type	Method and Description
com.google.common.util.concurrent.ListenableFuture<Trial>	addTrialMeasurement(AddTrialMeasurementRequest request) Adds a measurement of the objective metrics to a Trial.
protected VizierServiceGrpc.VizierServiceFutureStub	build(io.grpc.Channel channel, io.grpc.CallOptions callOptions)
com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation>	checkTrialEarlyStoppingState(CheckTrialEarlyStoppingStateRequest request) Checks whether a Trial should stop or not.
com.google.common.util.concurrent.ListenableFuture<Trial>	completeTrial(CompleteTrialRequest request) Marks a Trial as complete.
com.google.common.util.concurrent.ListenableFuture<Study>	createStudy(CreateStudyRequest request) Creates a Study.
com.google.common.util.concurrent.ListenableFuture<Trial>	createTrial(CreateTrialRequest request) Adds a user provided Trial to a Study.
com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty>	deleteStudy(DeleteStudyRequest request) Deletes a Study.
com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty>	deleteTrial(DeleteTrialRequest request) Deletes a Trial.
com.google.common.util.concurrent.ListenableFuture<Study>	getStudy(GetStudyRequest request) Gets a Study by name.
com.google.common.util.concurrent.ListenableFuture<Trial>	getTrial(GetTrialRequest request) Gets a Trial.
com.google.common.util.concurrent.ListenableFuture<ListOptimalTrialsResponse>	listOptimalTrials(ListOptimalTrialsRequest request) Lists the pareto-optimal Trials for multi-objective Study or the optimal Trials for single-objective Study.
com.google.common.util.concurrent.ListenableFuture<ListStudiesResponse>	listStudies(ListStudiesRequest request) Lists all the studies in a region for an associated project.
com.google.common.util.concurrent.ListenableFuture<ListTrialsResponse>	listTrials(ListTrialsRequest request) Lists the Trials associated with a Study.
com.google.common.util.concurrent.ListenableFuture<Study>	lookupStudy(LookupStudyRequest request) Looks a study up using the user-defined display_name field instead of the fully qualified resource name.
com.google.common.util.concurrent.ListenableFuture<Trial>	stopTrial(StopTrialRequest request) Stops a Trial.
com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.Operation>	suggestTrials(SuggestTrialsRequest request) Adds one or more Trials to a Study, with parameter values suggested by Vertex AI Vizier.

Methods inherited from class io.grpc.stub.AbstractFutureStub

newStub, newStub

Methods inherited from class io.grpc.stub.AbstractStub

getCallOptions, getChannel, withCallCredentials, withChannel, withCompression, withDeadline, withDeadlineAfter, withExecutor, withInterceptors, withMaxInboundMessageSize, withMaxOutboundMessageSize, withOption, withWaitForReady

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

build

protected VizierServiceGrpc.VizierServiceFutureStub build(io.grpc.Channel channel,
                                                          io.grpc.CallOptions callOptions)

Specified by:

build in class io.grpc.stub.AbstractStub<VizierServiceGrpc.VizierServiceFutureStub>

createStudy

public com.google.common.util.concurrent.ListenableFuture<Study> createStudy(CreateStudyRequest request)

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

getStudy

public com.google.common.util.concurrent.ListenableFuture<Study> getStudy(GetStudyRequest request)

 Gets a Study by name.
 

listStudies

public com.google.common.util.concurrent.ListenableFuture<ListStudiesResponse> listStudies(ListStudiesRequest request)

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

deleteStudy

public com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> deleteStudy(DeleteStudyRequest request)

 Deletes a Study.
 

lookupStudy

public com.google.common.util.concurrent.ListenableFuture<Study> lookupStudy(LookupStudyRequest request)

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

suggestTrials

public com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.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][google.cloud.aiplatform.v1beta1.SuggestTrialsResponse].
 

createTrial

public com.google.common.util.concurrent.ListenableFuture<Trial> createTrial(CreateTrialRequest request)

 Adds a user provided Trial to a Study.
 

getTrial

public com.google.common.util.concurrent.ListenableFuture<Trial> getTrial(GetTrialRequest request)

 Gets a Trial.
 

listTrials

public com.google.common.util.concurrent.ListenableFuture<ListTrialsResponse> listTrials(ListTrialsRequest request)

 Lists the Trials associated with a Study.
 

addTrialMeasurement

public com.google.common.util.concurrent.ListenableFuture<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.
 

completeTrial

public com.google.common.util.concurrent.ListenableFuture<Trial> completeTrial(CompleteTrialRequest request)

 Marks a Trial as complete.
 

deleteTrial

public com.google.common.util.concurrent.ListenableFuture<com.google.protobuf.Empty> deleteTrial(DeleteTrialRequest request)

 Deletes a Trial.
 

checkTrialEarlyStoppingState

public com.google.common.util.concurrent.ListenableFuture<com.google.longrunning.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][google.cloud.aiplatform.v1beta1.CheckTrialEarlyStoppingStateResponse].
 

stopTrial

public com.google.common.util.concurrent.ListenableFuture<Trial> stopTrial(StopTrialRequest request)

 Stops a Trial.
 

listOptimalTrials

public com.google.common.util.concurrent.ListenableFuture<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