Class protos.google.cloud.aiplatform.v1beta1.VizierService (3.4.0)

Version 3.4.0

• 3.15.0 (latest)
• 3.13.0
• 3.11.0
• 3.10.1
• 3.9.0
• 3.7.0
• 3.6.0
• 3.4.0
• 3.3.0
• 3.0.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.7.0
• 2.6.1
• 2.5.0
• 2.3.0
• 1.19.0
• 1.18.0
• 1.17.0
• 1.16.0
• 1.15.0
• 1.14.1
• 1.13.0
• 1.11.0
• 1.7.2

Represents a VizierService

Inheritance

$protobuf.rpc.Service > protos.google.cloud.aiplatform.v1beta1.VizierService

Package

@google-cloud/aiplatform

Constructors

(constructor)(rpcImpl, requestDelimited, responseDelimited)

constructor(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean);

Constructs a new VizierService service.

Parameters
Name	Description
rpcImpl	$protobuf.RPCImpl RPC implementation
requestDelimited	boolean Whether requests are length-delimited
responseDelimited	boolean Whether responses are length-delimited

Methods

addTrialMeasurement(request, callback)

public addTrialMeasurement(request: google.cloud.aiplatform.v1beta1.IAddTrialMeasurementRequest, callback: google.cloud.aiplatform.v1beta1.VizierService.AddTrialMeasurementCallback): void;

Calls AddTrialMeasurement.

Parameters
Name	Description
request	IAddTrialMeasurementRequest AddTrialMeasurementRequest message or plain object
callback	AddTrialMeasurementCallback Node-style callback called with the error, if any, and Trial

Returns
Type	Description
void

addTrialMeasurement(request)

public addTrialMeasurement(request: google.cloud.aiplatform.v1beta1.IAddTrialMeasurementRequest): Promise<google.cloud.aiplatform.v1beta1.Trial>;

Calls AddTrialMeasurement.

Parameter
Name	Description
request	IAddTrialMeasurementRequest AddTrialMeasurementRequest message or plain object

Returns
Type	Description
Promise<google.cloud.aiplatform.v1beta1.Trial>	Promise

checkTrialEarlyStoppingState(request, callback)

public checkTrialEarlyStoppingState(request: google.cloud.aiplatform.v1beta1.ICheckTrialEarlyStoppingStateRequest, callback: google.cloud.aiplatform.v1beta1.VizierService.CheckTrialEarlyStoppingStateCallback): void;

Calls CheckTrialEarlyStoppingState.

Parameters
Name	Description
request	ICheckTrialEarlyStoppingStateRequest CheckTrialEarlyStoppingStateRequest message or plain object
callback	CheckTrialEarlyStoppingStateCallback Node-style callback called with the error, if any, and Operation

Returns
Type	Description
void

checkTrialEarlyStoppingState(request)

public checkTrialEarlyStoppingState(request: google.cloud.aiplatform.v1beta1.ICheckTrialEarlyStoppingStateRequest): Promise<google.longrunning.Operation>;

Calls CheckTrialEarlyStoppingState.

Parameter
Name	Description
request	ICheckTrialEarlyStoppingStateRequest CheckTrialEarlyStoppingStateRequest message or plain object

Returns
Type	Description
Promise<google.longrunning.Operation>	Promise

completeTrial(request, callback)

public completeTrial(request: google.cloud.aiplatform.v1beta1.ICompleteTrialRequest, callback: google.cloud.aiplatform.v1beta1.VizierService.CompleteTrialCallback): void;

Calls CompleteTrial.

Parameters
Name	Description
request	ICompleteTrialRequest CompleteTrialRequest message or plain object
callback	CompleteTrialCallback Node-style callback called with the error, if any, and Trial

Returns
Type	Description
void

completeTrial(request)

public completeTrial(request: google.cloud.aiplatform.v1beta1.ICompleteTrialRequest): Promise<google.cloud.aiplatform.v1beta1.Trial>;

Calls CompleteTrial.

Parameter
Name	Description
request	ICompleteTrialRequest CompleteTrialRequest message or plain object

Returns
Type	Description
Promise<google.cloud.aiplatform.v1beta1.Trial>	Promise

create(rpcImpl, requestDelimited, responseDelimited)

public static create(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean): VizierService;

Creates new VizierService service using the specified rpc implementation.

Parameters
Name	Description
rpcImpl	$protobuf.RPCImpl RPC implementation
requestDelimited	boolean Whether requests are length-delimited
responseDelimited	boolean Whether responses are length-delimited

Returns
Type	Description
VizierService	RPC service. Useful where requests and/or responses are streamed.

createStudy(request, callback)

public createStudy(request: google.cloud.aiplatform.v1beta1.ICreateStudyRequest, callback: google.cloud.aiplatform.v1beta1.VizierService.CreateStudyCallback): void;

Calls CreateStudy.

Parameters
Name	Description
request	ICreateStudyRequest CreateStudyRequest message or plain object
callback	CreateStudyCallback Node-style callback called with the error, if any, and Study

Returns
Type	Description
void

createStudy(request)

public createStudy(request: google.cloud.aiplatform.v1beta1.ICreateStudyRequest): Promise<google.cloud.aiplatform.v1beta1.Study>;

Calls CreateStudy.

Parameter
Name	Description
request	ICreateStudyRequest CreateStudyRequest message or plain object

Returns
Type	Description
Promise<google.cloud.aiplatform.v1beta1.Study>	Promise

createTrial(request, callback)

public createTrial(request: google.cloud.aiplatform.v1beta1.ICreateTrialRequest, callback: google.cloud.aiplatform.v1beta1.VizierService.CreateTrialCallback): void;

Calls CreateTrial.

Parameters
Name	Description
request	ICreateTrialRequest CreateTrialRequest message or plain object
callback	CreateTrialCallback Node-style callback called with the error, if any, and Trial

Returns
Type	Description
void

createTrial(request)

public createTrial(request: google.cloud.aiplatform.v1beta1.ICreateTrialRequest): Promise<google.cloud.aiplatform.v1beta1.Trial>;

Calls CreateTrial.

Parameter
Name	Description
request	ICreateTrialRequest CreateTrialRequest message or plain object

Returns
Type	Description
Promise<google.cloud.aiplatform.v1beta1.Trial>	Promise

deleteStudy(request, callback)

public deleteStudy(request: google.cloud.aiplatform.v1beta1.IDeleteStudyRequest, callback: google.cloud.aiplatform.v1beta1.VizierService.DeleteStudyCallback): void;

Calls DeleteStudy.

Parameters
Name	Description
request	IDeleteStudyRequest DeleteStudyRequest message or plain object
callback	DeleteStudyCallback Node-style callback called with the error, if any, and Empty

Returns
Type	Description
void

deleteStudy(request)

public deleteStudy(request: google.cloud.aiplatform.v1beta1.IDeleteStudyRequest): Promise<google.protobuf.Empty>;

Calls DeleteStudy.

Parameter
Name	Description
request	IDeleteStudyRequest DeleteStudyRequest message or plain object

Returns
Type	Description
Promise<google.protobuf.Empty>	Promise

deleteTrial(request, callback)

public deleteTrial(request: google.cloud.aiplatform.v1beta1.IDeleteTrialRequest, callback: google.cloud.aiplatform.v1beta1.VizierService.DeleteTrialCallback): void;

Calls DeleteTrial.

Parameters
Name	Description
request	IDeleteTrialRequest DeleteTrialRequest message or plain object
callback	DeleteTrialCallback Node-style callback called with the error, if any, and Empty

Returns
Type	Description
void

deleteTrial(request)

public deleteTrial(request: google.cloud.aiplatform.v1beta1.IDeleteTrialRequest): Promise<google.protobuf.Empty>;

Calls DeleteTrial.

Parameter
Name	Description
request	IDeleteTrialRequest DeleteTrialRequest message or plain object

Returns
Type	Description
Promise<google.protobuf.Empty>	Promise

getStudy(request, callback)

public getStudy(request: google.cloud.aiplatform.v1beta1.IGetStudyRequest, callback: google.cloud.aiplatform.v1beta1.VizierService.GetStudyCallback): void;

Calls GetStudy.

Parameters
Name	Description
request	IGetStudyRequest GetStudyRequest message or plain object
callback	GetStudyCallback Node-style callback called with the error, if any, and Study

Returns
Type	Description
void

getStudy(request)

public getStudy(request: google.cloud.aiplatform.v1beta1.IGetStudyRequest): Promise<google.cloud.aiplatform.v1beta1.Study>;

Calls GetStudy.

Parameter
Name	Description
request	IGetStudyRequest GetStudyRequest message or plain object

Returns
Type	Description
Promise<google.cloud.aiplatform.v1beta1.Study>	Promise

getTrial(request, callback)

public getTrial(request: google.cloud.aiplatform.v1beta1.IGetTrialRequest, callback: google.cloud.aiplatform.v1beta1.VizierService.GetTrialCallback): void;

Calls GetTrial.

Parameters
Name	Description
request	IGetTrialRequest GetTrialRequest message or plain object
callback	GetTrialCallback Node-style callback called with the error, if any, and Trial

Returns
Type	Description
void

getTrial(request)

public getTrial(request: google.cloud.aiplatform.v1beta1.IGetTrialRequest): Promise<google.cloud.aiplatform.v1beta1.Trial>;

Calls GetTrial.

Parameter
Name	Description
request	IGetTrialRequest GetTrialRequest message or plain object

Returns
Type	Description
Promise<google.cloud.aiplatform.v1beta1.Trial>	Promise

listOptimalTrials(request, callback)

public listOptimalTrials(request: google.cloud.aiplatform.v1beta1.IListOptimalTrialsRequest, callback: google.cloud.aiplatform.v1beta1.VizierService.ListOptimalTrialsCallback): void;

Calls ListOptimalTrials.

Parameters
Name	Description
request	IListOptimalTrialsRequest ListOptimalTrialsRequest message or plain object
callback	ListOptimalTrialsCallback Node-style callback called with the error, if any, and ListOptimalTrialsResponse

Returns
Type	Description
void

listOptimalTrials(request)

public listOptimalTrials(request: google.cloud.aiplatform.v1beta1.IListOptimalTrialsRequest): Promise<google.cloud.aiplatform.v1beta1.ListOptimalTrialsResponse>;

Calls ListOptimalTrials.

Parameter
Name	Description
request	IListOptimalTrialsRequest ListOptimalTrialsRequest message or plain object

Returns
Type	Description
Promise<google.cloud.aiplatform.v1beta1.ListOptimalTrialsResponse>	Promise

listStudies(request, callback)

public listStudies(request: google.cloud.aiplatform.v1beta1.IListStudiesRequest, callback: google.cloud.aiplatform.v1beta1.VizierService.ListStudiesCallback): void;

Calls ListStudies.

Parameters
Name	Description
request	IListStudiesRequest ListStudiesRequest message or plain object
callback	ListStudiesCallback Node-style callback called with the error, if any, and ListStudiesResponse

Returns
Type	Description
void

listStudies(request)

public listStudies(request: google.cloud.aiplatform.v1beta1.IListStudiesRequest): Promise<google.cloud.aiplatform.v1beta1.ListStudiesResponse>;

Calls ListStudies.

Parameter
Name	Description
request	IListStudiesRequest ListStudiesRequest message or plain object

Returns
Type	Description
Promise<google.cloud.aiplatform.v1beta1.ListStudiesResponse>	Promise

listTrials(request, callback)

public listTrials(request: google.cloud.aiplatform.v1beta1.IListTrialsRequest, callback: google.cloud.aiplatform.v1beta1.VizierService.ListTrialsCallback): void;

Calls ListTrials.

Parameters
Name	Description
request	IListTrialsRequest ListTrialsRequest message or plain object
callback	ListTrialsCallback Node-style callback called with the error, if any, and ListTrialsResponse

Returns
Type	Description
void

listTrials(request)

public listTrials(request: google.cloud.aiplatform.v1beta1.IListTrialsRequest): Promise<google.cloud.aiplatform.v1beta1.ListTrialsResponse>;

Calls ListTrials.

Parameter
Name	Description
request	IListTrialsRequest ListTrialsRequest message or plain object

Returns
Type	Description
Promise<google.cloud.aiplatform.v1beta1.ListTrialsResponse>	Promise

lookupStudy(request, callback)

public lookupStudy(request: google.cloud.aiplatform.v1beta1.ILookupStudyRequest, callback: google.cloud.aiplatform.v1beta1.VizierService.LookupStudyCallback): void;

Calls LookupStudy.

Parameters
Name	Description
request	ILookupStudyRequest LookupStudyRequest message or plain object
callback	LookupStudyCallback Node-style callback called with the error, if any, and Study

Returns
Type	Description
void

lookupStudy(request)

public lookupStudy(request: google.cloud.aiplatform.v1beta1.ILookupStudyRequest): Promise<google.cloud.aiplatform.v1beta1.Study>;

Calls LookupStudy.

Parameter
Name	Description
request	ILookupStudyRequest LookupStudyRequest message or plain object

Returns
Type	Description
Promise<google.cloud.aiplatform.v1beta1.Study>	Promise

stopTrial(request, callback)

public stopTrial(request: google.cloud.aiplatform.v1beta1.IStopTrialRequest, callback: google.cloud.aiplatform.v1beta1.VizierService.StopTrialCallback): void;

Calls StopTrial.

Parameters
Name	Description
request	IStopTrialRequest StopTrialRequest message or plain object
callback	StopTrialCallback Node-style callback called with the error, if any, and Trial

Returns
Type	Description
void

stopTrial(request)

public stopTrial(request: google.cloud.aiplatform.v1beta1.IStopTrialRequest): Promise<google.cloud.aiplatform.v1beta1.Trial>;

Calls StopTrial.

Parameter
Name	Description
request	IStopTrialRequest StopTrialRequest message or plain object

Returns
Type	Description
Promise<google.cloud.aiplatform.v1beta1.Trial>	Promise

suggestTrials(request, callback)

public suggestTrials(request: google.cloud.aiplatform.v1beta1.ISuggestTrialsRequest, callback: google.cloud.aiplatform.v1beta1.VizierService.SuggestTrialsCallback): void;

Calls SuggestTrials.

Parameters
Name	Description
request	ISuggestTrialsRequest SuggestTrialsRequest message or plain object
callback	SuggestTrialsCallback Node-style callback called with the error, if any, and Operation

Returns
Type	Description
void

suggestTrials(request)

public suggestTrials(request: google.cloud.aiplatform.v1beta1.ISuggestTrialsRequest): Promise<google.longrunning.Operation>;

Calls SuggestTrials.

Parameter
Name	Description
request	ISuggestTrialsRequest SuggestTrialsRequest message or plain object

Returns
Type	Description
Promise<google.longrunning.Operation>	Promise