Class GrpcVizierServiceStub (2.4.0)

public class GrpcVizierServiceStub extends VizierServiceStub

gRPC stub implementation for the VizierService service API.

This class is for advanced usage and reflects the underlying API directly.

Inheritance

java.lang.Object > VizierServiceStub > GrpcVizierServiceStub

Inherited Members

VizierServiceStub.addTrialMeasurementCallable()

VizierServiceStub.checkTrialEarlyStoppingStateCallable()

VizierServiceStub.checkTrialEarlyStoppingStateOperationCallable()

VizierServiceStub.close()

VizierServiceStub.completeTrialCallable()

VizierServiceStub.createStudyCallable()

VizierServiceStub.createTrialCallable()

VizierServiceStub.deleteStudyCallable()

VizierServiceStub.deleteTrialCallable()

VizierServiceStub.getOperationsStub()

VizierServiceStub.getStudyCallable()

VizierServiceStub.getTrialCallable()

VizierServiceStub.listOptimalTrialsCallable()

VizierServiceStub.listStudiesCallable()

VizierServiceStub.listStudiesPagedCallable()

VizierServiceStub.listTrialsCallable()

VizierServiceStub.listTrialsPagedCallable()

VizierServiceStub.lookupStudyCallable()

VizierServiceStub.stopTrialCallable()

VizierServiceStub.suggestTrialsCallable()

VizierServiceStub.suggestTrialsOperationCallable()

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)

Constructors

GrpcVizierServiceStub(VizierServiceStubSettings settings, ClientContext clientContext)

protected GrpcVizierServiceStub(VizierServiceStubSettings settings, ClientContext clientContext)

Constructs an instance of GrpcVizierServiceStub, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.

Parameters

Name	Description
settings	`VizierServiceStubSettings`
clientContext	`ClientContext`

GrpcVizierServiceStub(VizierServiceStubSettings settings, ClientContext clientContext, GrpcStubCallableFactory callableFactory)

protected GrpcVizierServiceStub(VizierServiceStubSettings settings, ClientContext clientContext, GrpcStubCallableFactory callableFactory)

Constructs an instance of GrpcVizierServiceStub, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.

Parameters

Name	Description
settings	`VizierServiceStubSettings`
clientContext	`ClientContext`
callableFactory	`GrpcStubCallableFactory`

Methods

addTrialMeasurementCallable()

public UnaryCallable<AddTrialMeasurementRequest,Trial> addTrialMeasurementCallable()

Returns

Type	Description
UnaryCallable<AddTrialMeasurementRequest,Trial>

Overrides

VizierServiceStub.addTrialMeasurementCallable()

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)

Parameters

Name	Description
duration	`long`
unit	`TimeUnit`

Returns

Type	Description
boolean

Exceptions

Type	Description
InterruptedException

checkTrialEarlyStoppingStateCallable()

public UnaryCallable<CheckTrialEarlyStoppingStateRequest,Operation> checkTrialEarlyStoppingStateCallable()

Returns

Type	Description
UnaryCallable<CheckTrialEarlyStoppingStateRequest,Operation>

Overrides

VizierServiceStub.checkTrialEarlyStoppingStateCallable()

checkTrialEarlyStoppingStateOperationCallable()

public OperationCallable<CheckTrialEarlyStoppingStateRequest,CheckTrialEarlyStoppingStateResponse,CheckTrialEarlyStoppingStateMetatdata> checkTrialEarlyStoppingStateOperationCallable()

Returns

Type	Description
OperationCallable<CheckTrialEarlyStoppingStateRequest,CheckTrialEarlyStoppingStateResponse,CheckTrialEarlyStoppingStateMetatdata>

Overrides

VizierServiceStub.checkTrialEarlyStoppingStateOperationCallable()

close()

public final void close()

Overrides

VizierServiceStub.close()

completeTrialCallable()

public UnaryCallable<CompleteTrialRequest,Trial> completeTrialCallable()

Returns

Type	Description
UnaryCallable<CompleteTrialRequest,Trial>

Overrides

VizierServiceStub.completeTrialCallable()

create(ClientContext clientContext)

public static final GrpcVizierServiceStub create(ClientContext clientContext)

Parameter

Name	Description
clientContext	`ClientContext`

Returns

Type	Description
GrpcVizierServiceStub

Exceptions

Type	Description
IOException

create(ClientContext clientContext, GrpcStubCallableFactory callableFactory)

public static final GrpcVizierServiceStub create(ClientContext clientContext, GrpcStubCallableFactory callableFactory)

Parameters

Name	Description
clientContext	`ClientContext`
callableFactory	`GrpcStubCallableFactory`

Returns

Type	Description
GrpcVizierServiceStub

Exceptions

Type	Description
IOException

create(VizierServiceStubSettings settings)

public static final GrpcVizierServiceStub create(VizierServiceStubSettings settings)

Parameter

Name	Description
settings	`VizierServiceStubSettings`

Returns

Type	Description
GrpcVizierServiceStub

Exceptions

Type	Description
IOException

createStudyCallable()

public UnaryCallable<CreateStudyRequest,Study> createStudyCallable()

Returns

Type	Description
UnaryCallable<CreateStudyRequest,Study>

Overrides

VizierServiceStub.createStudyCallable()

createTrialCallable()

public UnaryCallable<CreateTrialRequest,Trial> createTrialCallable()

Returns

Type	Description
UnaryCallable<CreateTrialRequest,Trial>

Overrides

VizierServiceStub.createTrialCallable()

deleteStudyCallable()

public UnaryCallable<DeleteStudyRequest,Empty> deleteStudyCallable()

Returns

Type	Description
UnaryCallable<DeleteStudyRequest,Empty>

Overrides

VizierServiceStub.deleteStudyCallable()

deleteTrialCallable()

public UnaryCallable<DeleteTrialRequest,Empty> deleteTrialCallable()

Returns

Type	Description
UnaryCallable<DeleteTrialRequest,Empty>

Overrides

VizierServiceStub.deleteTrialCallable()

getOperationsStub()

public GrpcOperationsStub getOperationsStub()

Returns

Type	Description
GrpcOperationsStub

Overrides

VizierServiceStub.getOperationsStub()

getStudyCallable()

public UnaryCallable<GetStudyRequest,Study> getStudyCallable()

Returns

Type	Description
UnaryCallable<GetStudyRequest,Study>

Overrides

VizierServiceStub.getStudyCallable()

getTrialCallable()

public UnaryCallable<GetTrialRequest,Trial> getTrialCallable()

Returns

Type	Description
UnaryCallable<GetTrialRequest,Trial>

Overrides

VizierServiceStub.getTrialCallable()

isShutdown()

public boolean isShutdown()

Returns

Type	Description
boolean

isTerminated()

public boolean isTerminated()

Returns

Type	Description
boolean

listOptimalTrialsCallable()

public UnaryCallable<ListOptimalTrialsRequest,ListOptimalTrialsResponse> listOptimalTrialsCallable()

Returns

Type	Description
UnaryCallable<ListOptimalTrialsRequest,ListOptimalTrialsResponse>

Overrides

VizierServiceStub.listOptimalTrialsCallable()

listStudiesCallable()

public UnaryCallable<ListStudiesRequest,ListStudiesResponse> listStudiesCallable()

Returns

Type	Description
UnaryCallable<ListStudiesRequest,ListStudiesResponse>

Overrides

VizierServiceStub.listStudiesCallable()

listStudiesPagedCallable()

public UnaryCallable<ListStudiesRequest,VizierServiceClient.ListStudiesPagedResponse> listStudiesPagedCallable()

Returns

Type	Description
UnaryCallable<ListStudiesRequest,ListStudiesPagedResponse>

Overrides

VizierServiceStub.listStudiesPagedCallable()

listTrialsCallable()

public UnaryCallable<ListTrialsRequest,ListTrialsResponse> listTrialsCallable()

Returns

Type	Description
UnaryCallable<ListTrialsRequest,ListTrialsResponse>

Overrides

VizierServiceStub.listTrialsCallable()

listTrialsPagedCallable()

public UnaryCallable<ListTrialsRequest,VizierServiceClient.ListTrialsPagedResponse> listTrialsPagedCallable()

Returns

Type	Description
UnaryCallable<ListTrialsRequest,ListTrialsPagedResponse>

Overrides

VizierServiceStub.listTrialsPagedCallable()

lookupStudyCallable()

public UnaryCallable<LookupStudyRequest,Study> lookupStudyCallable()

Returns

Type	Description
UnaryCallable<LookupStudyRequest,Study>

Overrides

VizierServiceStub.lookupStudyCallable()

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

stopTrialCallable()

public UnaryCallable<StopTrialRequest,Trial> stopTrialCallable()

Returns

Type	Description
UnaryCallable<StopTrialRequest,Trial>

Overrides

VizierServiceStub.stopTrialCallable()

suggestTrialsCallable()

public UnaryCallable<SuggestTrialsRequest,Operation> suggestTrialsCallable()

Returns

Type	Description
UnaryCallable<SuggestTrialsRequest,Operation>

Overrides

VizierServiceStub.suggestTrialsCallable()

suggestTrialsOperationCallable()

public OperationCallable<SuggestTrialsRequest,SuggestTrialsResponse,SuggestTrialsMetadata> suggestTrialsOperationCallable()

Returns

Type	Description
OperationCallable<SuggestTrialsRequest,SuggestTrialsResponse,SuggestTrialsMetadata>

Overrides

VizierServiceStub.suggestTrialsOperationCallable()