Class VizierServiceClientImpl (2.3.0)

Version 2.3.0

• 3.11.0 (latest)
• 3.10.0
• 3.9.0
• 3.8.0
• 3.7.0
• 3.6.0
• 3.5.0
• 3.4.0
• 3.3.0
• 3.2.0
• 3.1.0
• 3.0.0
• 2.28.0
• 2.27.0
• 2.26.0
• 2.25.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.0
• 1.8.0
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0

public sealed class VizierServiceClientImpl : VizierServiceClient

VizierService client wrapper implementation, for convenient use.

Inheritance

Object > VizierServiceClient > VizierServiceClientImpl

Inherited Members

VizierServiceClient.DefaultEndpoint

VizierServiceClient.DefaultScopes

VizierServiceClient.ServiceMetadata

VizierServiceClient.CreateAsync(CancellationToken)

VizierServiceClient.Create()

VizierServiceClient.ShutdownDefaultChannelsAsync()

VizierServiceClient.CreateStudyAsync(CreateStudyRequest, CancellationToken)

VizierServiceClient.CreateStudy(String, Study, CallSettings)

VizierServiceClient.CreateStudyAsync(String, Study, CallSettings)

VizierServiceClient.CreateStudyAsync(String, Study, CancellationToken)

VizierServiceClient.CreateStudy(LocationName, Study, CallSettings)

VizierServiceClient.CreateStudyAsync(LocationName, Study, CallSettings)

VizierServiceClient.CreateStudyAsync(LocationName, Study, CancellationToken)

VizierServiceClient.GetStudyAsync(GetStudyRequest, CancellationToken)

VizierServiceClient.GetStudy(String, CallSettings)

VizierServiceClient.GetStudyAsync(String, CallSettings)

VizierServiceClient.GetStudyAsync(String, CancellationToken)

VizierServiceClient.GetStudy(StudyName, CallSettings)

VizierServiceClient.GetStudyAsync(StudyName, CallSettings)

VizierServiceClient.GetStudyAsync(StudyName, CancellationToken)

VizierServiceClient.ListStudies(String, String, Nullable<Int32>, CallSettings)

VizierServiceClient.ListStudiesAsync(String, String, Nullable<Int32>, CallSettings)

VizierServiceClient.ListStudies(LocationName, String, Nullable<Int32>, CallSettings)

VizierServiceClient.ListStudiesAsync(LocationName, String, Nullable<Int32>, CallSettings)

VizierServiceClient.DeleteStudyAsync(DeleteStudyRequest, CancellationToken)

VizierServiceClient.DeleteStudy(String, CallSettings)

VizierServiceClient.DeleteStudyAsync(String, CallSettings)

VizierServiceClient.DeleteStudyAsync(String, CancellationToken)

VizierServiceClient.DeleteStudy(StudyName, CallSettings)

VizierServiceClient.DeleteStudyAsync(StudyName, CallSettings)

VizierServiceClient.DeleteStudyAsync(StudyName, CancellationToken)

VizierServiceClient.LookupStudyAsync(LookupStudyRequest, CancellationToken)

VizierServiceClient.LookupStudy(String, CallSettings)

VizierServiceClient.LookupStudyAsync(String, CallSettings)

VizierServiceClient.LookupStudyAsync(String, CancellationToken)

VizierServiceClient.LookupStudy(LocationName, CallSettings)

VizierServiceClient.LookupStudyAsync(LocationName, CallSettings)

VizierServiceClient.LookupStudyAsync(LocationName, CancellationToken)

VizierServiceClient.SuggestTrialsAsync(SuggestTrialsRequest, CancellationToken)

VizierServiceClient.PollOnceSuggestTrials(String, CallSettings)

VizierServiceClient.PollOnceSuggestTrialsAsync(String, CallSettings)

VizierServiceClient.CreateTrialAsync(CreateTrialRequest, CancellationToken)

VizierServiceClient.CreateTrial(String, Trial, CallSettings)

VizierServiceClient.CreateTrialAsync(String, Trial, CallSettings)

VizierServiceClient.CreateTrialAsync(String, Trial, CancellationToken)

VizierServiceClient.CreateTrial(StudyName, Trial, CallSettings)

VizierServiceClient.CreateTrialAsync(StudyName, Trial, CallSettings)

VizierServiceClient.CreateTrialAsync(StudyName, Trial, CancellationToken)

VizierServiceClient.GetTrialAsync(GetTrialRequest, CancellationToken)

VizierServiceClient.GetTrial(String, CallSettings)

VizierServiceClient.GetTrialAsync(String, CallSettings)

VizierServiceClient.GetTrialAsync(String, CancellationToken)

VizierServiceClient.GetTrial(TrialName, CallSettings)

VizierServiceClient.GetTrialAsync(TrialName, CallSettings)

VizierServiceClient.GetTrialAsync(TrialName, CancellationToken)

VizierServiceClient.ListTrials(String, String, Nullable<Int32>, CallSettings)

VizierServiceClient.ListTrialsAsync(String, String, Nullable<Int32>, CallSettings)

VizierServiceClient.ListTrials(StudyName, String, Nullable<Int32>, CallSettings)

VizierServiceClient.ListTrialsAsync(StudyName, String, Nullable<Int32>, CallSettings)

VizierServiceClient.AddTrialMeasurementAsync(AddTrialMeasurementRequest, CancellationToken)

VizierServiceClient.CompleteTrialAsync(CompleteTrialRequest, CancellationToken)

VizierServiceClient.DeleteTrialAsync(DeleteTrialRequest, CancellationToken)

VizierServiceClient.DeleteTrial(String, CallSettings)

VizierServiceClient.DeleteTrialAsync(String, CallSettings)

VizierServiceClient.DeleteTrialAsync(String, CancellationToken)

VizierServiceClient.DeleteTrial(TrialName, CallSettings)

VizierServiceClient.DeleteTrialAsync(TrialName, CallSettings)

VizierServiceClient.DeleteTrialAsync(TrialName, CancellationToken)

VizierServiceClient.CheckTrialEarlyStoppingStateAsync(CheckTrialEarlyStoppingStateRequest, CancellationToken)

VizierServiceClient.PollOnceCheckTrialEarlyStoppingState(String, CallSettings)

VizierServiceClient.PollOnceCheckTrialEarlyStoppingStateAsync(String, CallSettings)

VizierServiceClient.StopTrialAsync(StopTrialRequest, CancellationToken)

VizierServiceClient.ListOptimalTrialsAsync(ListOptimalTrialsRequest, CancellationToken)

VizierServiceClient.ListOptimalTrials(String, CallSettings)

VizierServiceClient.ListOptimalTrialsAsync(String, CallSettings)

VizierServiceClient.ListOptimalTrialsAsync(String, CancellationToken)

VizierServiceClient.ListOptimalTrials(StudyName, CallSettings)

VizierServiceClient.ListOptimalTrialsAsync(StudyName, CallSettings)

VizierServiceClient.ListOptimalTrialsAsync(StudyName, CancellationToken)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ToString()

Namespace

Google.Cloud.AIPlatform.V1

Assembly

Google.Cloud.AIPlatform.V1.dll

Remarks

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.

Constructors

VizierServiceClientImpl(VizierService.VizierServiceClient, VizierServiceSettings, ILogger)

public VizierServiceClientImpl(VizierService.VizierServiceClient grpcClient, VizierServiceSettings settings, ILogger logger)

Constructs a client wrapper for the VizierService service, with the specified gRPC client and settings.

Parameters
Name	Description
grpcClient	VizierService.VizierServiceClient The underlying gRPC client.
settings	VizierServiceSettings The base VizierServiceSettings used within this client.
logger	ILogger Optional ILogger to use within this client.

Properties

CheckTrialEarlyStoppingStateOperationsClient

public override OperationsClient CheckTrialEarlyStoppingStateOperationsClient { get; }

The long-running operations client for CheckTrialEarlyStoppingState.

Property Value
Type	Description
OperationsClient

Overrides

VizierServiceClient.CheckTrialEarlyStoppingStateOperationsClient

GrpcClient

public override VizierService.VizierServiceClient GrpcClient { get; }

The underlying gRPC VizierService client

Property Value
Type	Description
VizierService.VizierServiceClient

Overrides

VizierServiceClient.GrpcClient

IAMPolicyClient

public override IAMPolicyClient IAMPolicyClient { get; }

The IAMPolicyClient associated with this client.

Property Value
Type	Description
IAMPolicyClient

Overrides

VizierServiceClient.IAMPolicyClient

LocationsClient

public override LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
Type	Description
LocationsClient

Overrides

VizierServiceClient.LocationsClient

SuggestTrialsOperationsClient

public override OperationsClient SuggestTrialsOperationsClient { get; }

The long-running operations client for SuggestTrials.

Property Value
Type	Description
OperationsClient

Overrides

VizierServiceClient.SuggestTrialsOperationsClient

Methods

AddTrialMeasurement(AddTrialMeasurementRequest, CallSettings)

public override Trial AddTrialMeasurement(AddTrialMeasurementRequest request, CallSettings callSettings = null)

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 The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Trial	The RPC response.

Overrides

VizierServiceClient.AddTrialMeasurement(AddTrialMeasurementRequest, CallSettings)

AddTrialMeasurementAsync(AddTrialMeasurementRequest, CallSettings)

public override Task<Trial> AddTrialMeasurementAsync(AddTrialMeasurementRequest request, CallSettings callSettings = null)

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 The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Task<Trial>	A Task containing the RPC response.

Overrides

VizierServiceClient.AddTrialMeasurementAsync(AddTrialMeasurementRequest, CallSettings)

CheckTrialEarlyStoppingState(CheckTrialEarlyStoppingStateRequest, CallSettings)

public override Operation<CheckTrialEarlyStoppingStateResponse, CheckTrialEarlyStoppingStateMetatdata> CheckTrialEarlyStoppingState(CheckTrialEarlyStoppingStateRequest request, CallSettings callSettings = null)

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.ml.v1.CheckTrialEarlyStoppingStateResponse].

Parameters
Name	Description
request	CheckTrialEarlyStoppingStateRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Operation<CheckTrialEarlyStoppingStateResponse, CheckTrialEarlyStoppingStateMetatdata>	The RPC response.

Overrides

VizierServiceClient.CheckTrialEarlyStoppingState(CheckTrialEarlyStoppingStateRequest, CallSettings)

CheckTrialEarlyStoppingStateAsync(CheckTrialEarlyStoppingStateRequest, CallSettings)

public override async Task<Operation<CheckTrialEarlyStoppingStateResponse, CheckTrialEarlyStoppingStateMetatdata>> CheckTrialEarlyStoppingStateAsync(CheckTrialEarlyStoppingStateRequest request, CallSettings callSettings = null)

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.ml.v1.CheckTrialEarlyStoppingStateResponse].

Parameters
Name	Description
request	CheckTrialEarlyStoppingStateRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Task<Operation<CheckTrialEarlyStoppingStateResponse, CheckTrialEarlyStoppingStateMetatdata>>	A Task containing the RPC response.

Overrides

VizierServiceClient.CheckTrialEarlyStoppingStateAsync(CheckTrialEarlyStoppingStateRequest, CallSettings)

CompleteTrial(CompleteTrialRequest, CallSettings)

public override Trial CompleteTrial(CompleteTrialRequest request, CallSettings callSettings = null)

Marks a Trial as complete.

Parameters
Name	Description
request	CompleteTrialRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Trial	The RPC response.

Overrides

VizierServiceClient.CompleteTrial(CompleteTrialRequest, CallSettings)

CompleteTrialAsync(CompleteTrialRequest, CallSettings)

public override Task<Trial> CompleteTrialAsync(CompleteTrialRequest request, CallSettings callSettings = null)

Marks a Trial as complete.

Parameters
Name	Description
request	CompleteTrialRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Task<Trial>	A Task containing the RPC response.

Overrides

VizierServiceClient.CompleteTrialAsync(CompleteTrialRequest, CallSettings)

CreateStudy(CreateStudyRequest, CallSettings)

public override Study CreateStudy(CreateStudyRequest request, CallSettings callSettings = null)

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

Parameters
Name	Description
request	CreateStudyRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Study	The RPC response.

Overrides

VizierServiceClient.CreateStudy(CreateStudyRequest, CallSettings)

CreateStudyAsync(CreateStudyRequest, CallSettings)

public override Task<Study> CreateStudyAsync(CreateStudyRequest request, CallSettings callSettings = null)

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

Parameters
Name	Description
request	CreateStudyRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Task<Study>	A Task containing the RPC response.

Overrides

VizierServiceClient.CreateStudyAsync(CreateStudyRequest, CallSettings)

CreateTrial(CreateTrialRequest, CallSettings)

public override Trial CreateTrial(CreateTrialRequest request, CallSettings callSettings = null)

Adds a user provided Trial to a Study.

Parameters
Name	Description
request	CreateTrialRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Trial	The RPC response.

Overrides

VizierServiceClient.CreateTrial(CreateTrialRequest, CallSettings)

CreateTrialAsync(CreateTrialRequest, CallSettings)

public override Task<Trial> CreateTrialAsync(CreateTrialRequest request, CallSettings callSettings = null)

Adds a user provided Trial to a Study.

Parameters
Name	Description
request	CreateTrialRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Task<Trial>	A Task containing the RPC response.

Overrides

VizierServiceClient.CreateTrialAsync(CreateTrialRequest, CallSettings)

DeleteStudy(DeleteStudyRequest, CallSettings)

public override void DeleteStudy(DeleteStudyRequest request, CallSettings callSettings = null)

Deletes a Study.

Parameters
Name	Description
request	DeleteStudyRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Overrides

VizierServiceClient.DeleteStudy(DeleteStudyRequest, CallSettings)

DeleteStudyAsync(DeleteStudyRequest, CallSettings)

public override Task DeleteStudyAsync(DeleteStudyRequest request, CallSettings callSettings = null)

Deletes a Study.

Parameters
Name	Description
request	DeleteStudyRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Task	A Task containing the RPC response.

Overrides

VizierServiceClient.DeleteStudyAsync(DeleteStudyRequest, CallSettings)

DeleteTrial(DeleteTrialRequest, CallSettings)

public override void DeleteTrial(DeleteTrialRequest request, CallSettings callSettings = null)

Deletes a Trial.

Parameters
Name	Description
request	DeleteTrialRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Overrides

VizierServiceClient.DeleteTrial(DeleteTrialRequest, CallSettings)

DeleteTrialAsync(DeleteTrialRequest, CallSettings)

public override Task DeleteTrialAsync(DeleteTrialRequest request, CallSettings callSettings = null)

Deletes a Trial.

Parameters
Name	Description
request	DeleteTrialRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Task	A Task containing the RPC response.

Overrides

VizierServiceClient.DeleteTrialAsync(DeleteTrialRequest, CallSettings)

GetStudy(GetStudyRequest, CallSettings)

public override Study GetStudy(GetStudyRequest request, CallSettings callSettings = null)

Gets a Study by name.

Parameters
Name	Description
request	GetStudyRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Study	The RPC response.

Overrides

VizierServiceClient.GetStudy(GetStudyRequest, CallSettings)

GetStudyAsync(GetStudyRequest, CallSettings)

public override Task<Study> GetStudyAsync(GetStudyRequest request, CallSettings callSettings = null)

Gets a Study by name.

Parameters
Name	Description
request	GetStudyRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Task<Study>	A Task containing the RPC response.

Overrides

VizierServiceClient.GetStudyAsync(GetStudyRequest, CallSettings)

GetTrial(GetTrialRequest, CallSettings)

public override Trial GetTrial(GetTrialRequest request, CallSettings callSettings = null)

Gets a Trial.

Parameters
Name	Description
request	GetTrialRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Trial	The RPC response.

Overrides

VizierServiceClient.GetTrial(GetTrialRequest, CallSettings)

GetTrialAsync(GetTrialRequest, CallSettings)

public override Task<Trial> GetTrialAsync(GetTrialRequest request, CallSettings callSettings = null)

Gets a Trial.

Parameters
Name	Description
request	GetTrialRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Task<Trial>	A Task containing the RPC response.

Overrides

VizierServiceClient.GetTrialAsync(GetTrialRequest, CallSettings)

ListOptimalTrials(ListOptimalTrialsRequest, CallSettings)

public override ListOptimalTrialsResponse ListOptimalTrials(ListOptimalTrialsRequest request, CallSettings callSettings = null)

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 The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
ListOptimalTrialsResponse	The RPC response.

Overrides

VizierServiceClient.ListOptimalTrials(ListOptimalTrialsRequest, CallSettings)

ListOptimalTrialsAsync(ListOptimalTrialsRequest, CallSettings)

public override Task<ListOptimalTrialsResponse> ListOptimalTrialsAsync(ListOptimalTrialsRequest request, CallSettings callSettings = null)

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 The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Task<ListOptimalTrialsResponse>	A Task containing the RPC response.

Overrides

VizierServiceClient.ListOptimalTrialsAsync(ListOptimalTrialsRequest, CallSettings)

ListStudies(ListStudiesRequest, CallSettings)

public override PagedEnumerable<ListStudiesResponse, Study> ListStudies(ListStudiesRequest request, CallSettings callSettings = null)

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

Parameters
Name	Description
request	ListStudiesRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedEnumerable<ListStudiesResponse, Study>	A pageable sequence of Study resources.

Overrides

VizierServiceClient.ListStudies(ListStudiesRequest, CallSettings)

ListStudiesAsync(ListStudiesRequest, CallSettings)

public override PagedAsyncEnumerable<ListStudiesResponse, Study> ListStudiesAsync(ListStudiesRequest request, CallSettings callSettings = null)

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

Parameters
Name	Description
request	ListStudiesRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedAsyncEnumerable<ListStudiesResponse, Study>	A pageable asynchronous sequence of Study resources.

Overrides

VizierServiceClient.ListStudiesAsync(ListStudiesRequest, CallSettings)

ListTrials(ListTrialsRequest, CallSettings)

public override PagedEnumerable<ListTrialsResponse, Trial> ListTrials(ListTrialsRequest request, CallSettings callSettings = null)

Lists the Trials associated with a Study.

Parameters
Name	Description
request	ListTrialsRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedEnumerable<ListTrialsResponse, Trial>	A pageable sequence of Trial resources.

Overrides

VizierServiceClient.ListTrials(ListTrialsRequest, CallSettings)

ListTrialsAsync(ListTrialsRequest, CallSettings)

public override PagedAsyncEnumerable<ListTrialsResponse, Trial> ListTrialsAsync(ListTrialsRequest request, CallSettings callSettings = null)

Lists the Trials associated with a Study.

Parameters
Name	Description
request	ListTrialsRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedAsyncEnumerable<ListTrialsResponse, Trial>	A pageable asynchronous sequence of Trial resources.

Overrides

VizierServiceClient.ListTrialsAsync(ListTrialsRequest, CallSettings)

LookupStudy(LookupStudyRequest, CallSettings)

public override Study LookupStudy(LookupStudyRequest request, CallSettings callSettings = null)

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

Parameters
Name	Description
request	LookupStudyRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Study	The RPC response.

Overrides

VizierServiceClient.LookupStudy(LookupStudyRequest, CallSettings)

LookupStudyAsync(LookupStudyRequest, CallSettings)

public override Task<Study> LookupStudyAsync(LookupStudyRequest request, CallSettings callSettings = null)

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

Parameters
Name	Description
request	LookupStudyRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Task<Study>	A Task containing the RPC response.

Overrides

VizierServiceClient.LookupStudyAsync(LookupStudyRequest, CallSettings)

StopTrial(StopTrialRequest, CallSettings)

public override Trial StopTrial(StopTrialRequest request, CallSettings callSettings = null)

Stops a Trial.

Parameters
Name	Description
request	StopTrialRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Trial	The RPC response.

Overrides

VizierServiceClient.StopTrial(StopTrialRequest, CallSettings)

StopTrialAsync(StopTrialRequest, CallSettings)

public override Task<Trial> StopTrialAsync(StopTrialRequest request, CallSettings callSettings = null)

Stops a Trial.

Parameters
Name	Description
request	StopTrialRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Task<Trial>	A Task containing the RPC response.

Overrides

VizierServiceClient.StopTrialAsync(StopTrialRequest, CallSettings)

SuggestTrials(SuggestTrialsRequest, CallSettings)

public override Operation<SuggestTrialsResponse, SuggestTrialsMetadata> SuggestTrials(SuggestTrialsRequest request, CallSettings callSettings = null)

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.ml.v1.SuggestTrialsResponse].

Parameters
Name	Description
request	SuggestTrialsRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Operation<SuggestTrialsResponse, SuggestTrialsMetadata>	The RPC response.

Overrides

VizierServiceClient.SuggestTrials(SuggestTrialsRequest, CallSettings)

SuggestTrialsAsync(SuggestTrialsRequest, CallSettings)

public override async Task<Operation<SuggestTrialsResponse, SuggestTrialsMetadata>> SuggestTrialsAsync(SuggestTrialsRequest request, CallSettings callSettings = null)

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.ml.v1.SuggestTrialsResponse].

Parameters
Name	Description
request	SuggestTrialsRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Task<Operation<SuggestTrialsResponse, SuggestTrialsMetadata>>	A Task containing the RPC response.

Overrides

VizierServiceClient.SuggestTrialsAsync(SuggestTrialsRequest, CallSettings)