Cloud AI Platform v1beta1 API - Class VizierServiceClientImpl (1.0.0-beta12) 

public sealed class VizierServiceClientImpl : VizierServiceClient

Reference documentation and code samples for the Cloud AI Platform v1beta1 API class VizierServiceClientImpl.

VizierService client wrapper implementation, for convenient use.

Inheritance

object > VizierServiceClient > VizierServiceClientImpl

Namespace

Google.Cloud.AIPlatform.V1Beta1

Assembly

Google.Cloud.AIPlatform.V1Beta1.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(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 VizierServiceVizierServiceClient

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

GrpcClient

public override VizierService.VizierServiceClient GrpcClient { get; }

The underlying gRPC VizierService client

Property Value
Type Description
VizierServiceVizierServiceClient
Overrides

IAMPolicyClient

public override IAMPolicyClient IAMPolicyClient { get; }

The IAMPolicyClient associated with this client.

Property Value
Type Description
IAMPolicyClient
Overrides

LocationsClient

public override LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
Type Description
LocationsClient
Overrides

SuggestTrialsOperationsClient

public override OperationsClient SuggestTrialsOperationsClient { get; }

The long-running operations client for SuggestTrials.

Property Value
Type Description
OperationsClient
Overrides

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

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
TaskTrial

A Task containing the RPC response.
Overrides

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.aiplatform.v1beta1.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
OperationCheckTrialEarlyStoppingStateResponseCheckTrialEarlyStoppingStateMetatdata

The RPC response.
Overrides

CheckTrialEarlyStoppingStateAsync(CheckTrialEarlyStoppingStateRequest, CallSettings)

public override 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.aiplatform.v1beta1.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
TaskOperationCheckTrialEarlyStoppingStateResponseCheckTrialEarlyStoppingStateMetatdata

A Task containing the RPC response.
Overrides

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

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
TaskTrial

A Task containing the RPC response.
Overrides

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

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
TaskStudy

A Task containing the RPC response.
Overrides

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

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
TaskTrial

A Task containing the RPC response.
Overrides

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

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

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

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

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

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
TaskStudy

A Task containing the RPC response.
Overrides

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

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
TaskTrial

A Task containing the RPC response.
Overrides

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

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
TaskListOptimalTrialsResponse

A Task containing the RPC response.
Overrides

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
PagedEnumerableListStudiesResponseStudy

A pageable sequence of Study resources.
Overrides

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
PagedAsyncEnumerableListStudiesResponseStudy

A pageable asynchronous sequence of Study resources.
Overrides

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
PagedEnumerableListTrialsResponseTrial

A pageable sequence of Trial resources.
Overrides

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
PagedAsyncEnumerableListTrialsResponseTrial

A pageable asynchronous sequence of Trial resources.
Overrides

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

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
TaskStudy

A Task containing the RPC response.
Overrides

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

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
TaskTrial

A Task containing the RPC response.
Overrides

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.aiplatform.v1beta1.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
OperationSuggestTrialsResponseSuggestTrialsMetadata

The RPC response.
Overrides

SuggestTrialsAsync(SuggestTrialsRequest, CallSettings)

public override 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.aiplatform.v1beta1.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
TaskOperationSuggestTrialsResponseSuggestTrialsMetadata

A Task containing the RPC response.
Overrides