Cloud AI Platform v1 API - Class VizierService.VizierServiceClient (2.21.0)

public class VizierService.VizierServiceClient : ClientBase<VizierService.VizierServiceClient>

Reference documentation and code samples for the Cloud AI Platform v1 API class VizierService.VizierServiceClient.

Client for VizierService

Inheritance

object > ClientBase > ClientBaseVizierServiceVizierServiceClient > VizierService.VizierServiceClient

Namespace

Google.Cloud.AIPlatform.V1

Assembly

Google.Cloud.AIPlatform.V1.dll

Constructors

VizierServiceClient()

protected VizierServiceClient()

Protected parameterless constructor to allow creation of test doubles.

VizierServiceClient(CallInvoker)

public VizierServiceClient(CallInvoker callInvoker)

Creates a new client for VizierService that uses a custom CallInvoker.

Parameter
NameDescription
callInvokerCallInvoker

The callInvoker to use to make remote calls.

VizierServiceClient(ChannelBase)

public VizierServiceClient(ChannelBase channel)

Creates a new client for VizierService

Parameter
NameDescription
channelChannelBase

The channel to use to make remote calls.

VizierServiceClient(ClientBaseConfiguration)

protected VizierServiceClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
NameDescription
configurationClientBaseClientBaseConfiguration

The client configuration.

Methods

AddTrialMeasurement(AddTrialMeasurementRequest, CallOptions)

public virtual Trial AddTrialMeasurement(AddTrialMeasurementRequest request, CallOptions options)

Adds a measurement of the objective metrics to a Trial. This measurement is assumed to have been taken before the Trial is complete.

Parameters
NameDescription
requestAddTrialMeasurementRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Trial

The response received from the server.

AddTrialMeasurement(AddTrialMeasurementRequest, Metadata, DateTime?, CancellationToken)

public virtual Trial AddTrialMeasurement(AddTrialMeasurementRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Adds a measurement of the objective metrics to a Trial. This measurement is assumed to have been taken before the Trial is complete.

Parameters
NameDescription
requestAddTrialMeasurementRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Trial

The response received from the server.

AddTrialMeasurementAsync(AddTrialMeasurementRequest, CallOptions)

public virtual AsyncUnaryCall<Trial> AddTrialMeasurementAsync(AddTrialMeasurementRequest request, CallOptions options)

Adds a measurement of the objective metrics to a Trial. This measurement is assumed to have been taken before the Trial is complete.

Parameters
NameDescription
requestAddTrialMeasurementRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallTrial

The call object.

AddTrialMeasurementAsync(AddTrialMeasurementRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Trial> AddTrialMeasurementAsync(AddTrialMeasurementRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Adds a measurement of the objective metrics to a Trial. This measurement is assumed to have been taken before the Trial is complete.

Parameters
NameDescription
requestAddTrialMeasurementRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallTrial

The call object.

CheckTrialEarlyStoppingState(CheckTrialEarlyStoppingStateRequest, CallOptions)

public virtual Operation CheckTrialEarlyStoppingState(CheckTrialEarlyStoppingStateRequest request, CallOptions options)

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

Parameters
NameDescription
requestCheckTrialEarlyStoppingStateRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

CheckTrialEarlyStoppingState(CheckTrialEarlyStoppingStateRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation CheckTrialEarlyStoppingState(CheckTrialEarlyStoppingStateRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
NameDescription
requestCheckTrialEarlyStoppingStateRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

CheckTrialEarlyStoppingStateAsync(CheckTrialEarlyStoppingStateRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> CheckTrialEarlyStoppingStateAsync(CheckTrialEarlyStoppingStateRequest request, CallOptions options)

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

Parameters
NameDescription
requestCheckTrialEarlyStoppingStateRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

CheckTrialEarlyStoppingStateAsync(CheckTrialEarlyStoppingStateRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> CheckTrialEarlyStoppingStateAsync(CheckTrialEarlyStoppingStateRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
NameDescription
requestCheckTrialEarlyStoppingStateRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

CompleteTrial(CompleteTrialRequest, CallOptions)

public virtual Trial CompleteTrial(CompleteTrialRequest request, CallOptions options)

Marks a Trial as complete.

Parameters
NameDescription
requestCompleteTrialRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Trial

The response received from the server.

CompleteTrial(CompleteTrialRequest, Metadata, DateTime?, CancellationToken)

public virtual Trial CompleteTrial(CompleteTrialRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Marks a Trial as complete.

Parameters
NameDescription
requestCompleteTrialRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Trial

The response received from the server.

CompleteTrialAsync(CompleteTrialRequest, CallOptions)

public virtual AsyncUnaryCall<Trial> CompleteTrialAsync(CompleteTrialRequest request, CallOptions options)

Marks a Trial as complete.

Parameters
NameDescription
requestCompleteTrialRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallTrial

The call object.

CompleteTrialAsync(CompleteTrialRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Trial> CompleteTrialAsync(CompleteTrialRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Marks a Trial as complete.

Parameters
NameDescription
requestCompleteTrialRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallTrial

The call object.

CreateIAMPolicyClient()

public virtual IAMPolicy.IAMPolicyClient CreateIAMPolicyClient()

Creates a new instance of IAMPolicy.IAMPolicyClient using the same call invoker as this client.

Returns
TypeDescription
IAMPolicyIAMPolicyClient

A new IAMPolicy.IAMPolicyClient for the same target as this client.

CreateLocationsClient()

public virtual Locations.LocationsClient CreateLocationsClient()

Creates a new instance of Locations.LocationsClient using the same call invoker as this client.

Returns
TypeDescription
LocationsLocationsClient

A new Locations.LocationsClient for the same target as this client.

CreateOperationsClient()

public virtual Operations.OperationsClient CreateOperationsClient()

Creates a new instance of Operations.OperationsClient using the same call invoker as this client.

Returns
TypeDescription
OperationsOperationsClient

A new Operations client for the same target as this client.

CreateStudy(CreateStudyRequest, CallOptions)

public virtual Study CreateStudy(CreateStudyRequest request, CallOptions options)

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

Parameters
NameDescription
requestCreateStudyRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Study

The response received from the server.

CreateStudy(CreateStudyRequest, Metadata, DateTime?, CancellationToken)

public virtual Study CreateStudy(CreateStudyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
NameDescription
requestCreateStudyRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Study

The response received from the server.

CreateStudyAsync(CreateStudyRequest, CallOptions)

public virtual AsyncUnaryCall<Study> CreateStudyAsync(CreateStudyRequest request, CallOptions options)

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

Parameters
NameDescription
requestCreateStudyRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallStudy

The call object.

CreateStudyAsync(CreateStudyRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Study> CreateStudyAsync(CreateStudyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
NameDescription
requestCreateStudyRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallStudy

The call object.

CreateTrial(CreateTrialRequest, CallOptions)

public virtual Trial CreateTrial(CreateTrialRequest request, CallOptions options)

Adds a user provided Trial to a Study.

Parameters
NameDescription
requestCreateTrialRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Trial

The response received from the server.

CreateTrial(CreateTrialRequest, Metadata, DateTime?, CancellationToken)

public virtual Trial CreateTrial(CreateTrialRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Adds a user provided Trial to a Study.

Parameters
NameDescription
requestCreateTrialRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Trial

The response received from the server.

CreateTrialAsync(CreateTrialRequest, CallOptions)

public virtual AsyncUnaryCall<Trial> CreateTrialAsync(CreateTrialRequest request, CallOptions options)

Adds a user provided Trial to a Study.

Parameters
NameDescription
requestCreateTrialRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallTrial

The call object.

CreateTrialAsync(CreateTrialRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Trial> CreateTrialAsync(CreateTrialRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Adds a user provided Trial to a Study.

Parameters
NameDescription
requestCreateTrialRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallTrial

The call object.

DeleteStudy(DeleteStudyRequest, CallOptions)

public virtual Empty DeleteStudy(DeleteStudyRequest request, CallOptions options)

Deletes a Study.

Parameters
NameDescription
requestDeleteStudyRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Empty

The response received from the server.

DeleteStudy(DeleteStudyRequest, Metadata, DateTime?, CancellationToken)

public virtual Empty DeleteStudy(DeleteStudyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes a Study.

Parameters
NameDescription
requestDeleteStudyRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Empty

The response received from the server.

DeleteStudyAsync(DeleteStudyRequest, CallOptions)

public virtual AsyncUnaryCall<Empty> DeleteStudyAsync(DeleteStudyRequest request, CallOptions options)

Deletes a Study.

Parameters
NameDescription
requestDeleteStudyRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallEmpty

The call object.

DeleteStudyAsync(DeleteStudyRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Empty> DeleteStudyAsync(DeleteStudyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes a Study.

Parameters
NameDescription
requestDeleteStudyRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallEmpty

The call object.

DeleteTrial(DeleteTrialRequest, CallOptions)

public virtual Empty DeleteTrial(DeleteTrialRequest request, CallOptions options)

Deletes a Trial.

Parameters
NameDescription
requestDeleteTrialRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Empty

The response received from the server.

DeleteTrial(DeleteTrialRequest, Metadata, DateTime?, CancellationToken)

public virtual Empty DeleteTrial(DeleteTrialRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes a Trial.

Parameters
NameDescription
requestDeleteTrialRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Empty

The response received from the server.

DeleteTrialAsync(DeleteTrialRequest, CallOptions)

public virtual AsyncUnaryCall<Empty> DeleteTrialAsync(DeleteTrialRequest request, CallOptions options)

Deletes a Trial.

Parameters
NameDescription
requestDeleteTrialRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallEmpty

The call object.

DeleteTrialAsync(DeleteTrialRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Empty> DeleteTrialAsync(DeleteTrialRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes a Trial.

Parameters
NameDescription
requestDeleteTrialRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallEmpty

The call object.

GetStudy(GetStudyRequest, CallOptions)

public virtual Study GetStudy(GetStudyRequest request, CallOptions options)

Gets a Study by name.

Parameters
NameDescription
requestGetStudyRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Study

The response received from the server.

GetStudy(GetStudyRequest, Metadata, DateTime?, CancellationToken)

public virtual Study GetStudy(GetStudyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets a Study by name.

Parameters
NameDescription
requestGetStudyRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Study

The response received from the server.

GetStudyAsync(GetStudyRequest, CallOptions)

public virtual AsyncUnaryCall<Study> GetStudyAsync(GetStudyRequest request, CallOptions options)

Gets a Study by name.

Parameters
NameDescription
requestGetStudyRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallStudy

The call object.

GetStudyAsync(GetStudyRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Study> GetStudyAsync(GetStudyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets a Study by name.

Parameters
NameDescription
requestGetStudyRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallStudy

The call object.

GetTrial(GetTrialRequest, CallOptions)

public virtual Trial GetTrial(GetTrialRequest request, CallOptions options)

Gets a Trial.

Parameters
NameDescription
requestGetTrialRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Trial

The response received from the server.

GetTrial(GetTrialRequest, Metadata, DateTime?, CancellationToken)

public virtual Trial GetTrial(GetTrialRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets a Trial.

Parameters
NameDescription
requestGetTrialRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Trial

The response received from the server.

GetTrialAsync(GetTrialRequest, CallOptions)

public virtual AsyncUnaryCall<Trial> GetTrialAsync(GetTrialRequest request, CallOptions options)

Gets a Trial.

Parameters
NameDescription
requestGetTrialRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallTrial

The call object.

GetTrialAsync(GetTrialRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Trial> GetTrialAsync(GetTrialRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets a Trial.

Parameters
NameDescription
requestGetTrialRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallTrial

The call object.

ListOptimalTrials(ListOptimalTrialsRequest, CallOptions)

public virtual ListOptimalTrialsResponse ListOptimalTrials(ListOptimalTrialsRequest request, CallOptions options)

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
NameDescription
requestListOptimalTrialsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
ListOptimalTrialsResponse

The response received from the server.

ListOptimalTrials(ListOptimalTrialsRequest, Metadata, DateTime?, CancellationToken)

public virtual ListOptimalTrialsResponse ListOptimalTrials(ListOptimalTrialsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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
NameDescription
requestListOptimalTrialsRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
ListOptimalTrialsResponse

The response received from the server.

ListOptimalTrialsAsync(ListOptimalTrialsRequest, CallOptions)

public virtual AsyncUnaryCall<ListOptimalTrialsResponse> ListOptimalTrialsAsync(ListOptimalTrialsRequest request, CallOptions options)

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
NameDescription
requestListOptimalTrialsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallListOptimalTrialsResponse

The call object.

ListOptimalTrialsAsync(ListOptimalTrialsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListOptimalTrialsResponse> ListOptimalTrialsAsync(ListOptimalTrialsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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
NameDescription
requestListOptimalTrialsRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallListOptimalTrialsResponse

The call object.

ListStudies(ListStudiesRequest, CallOptions)

public virtual ListStudiesResponse ListStudies(ListStudiesRequest request, CallOptions options)

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

Parameters
NameDescription
requestListStudiesRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
ListStudiesResponse

The response received from the server.

ListStudies(ListStudiesRequest, Metadata, DateTime?, CancellationToken)

public virtual ListStudiesResponse ListStudies(ListStudiesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
NameDescription
requestListStudiesRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
ListStudiesResponse

The response received from the server.

ListStudiesAsync(ListStudiesRequest, CallOptions)

public virtual AsyncUnaryCall<ListStudiesResponse> ListStudiesAsync(ListStudiesRequest request, CallOptions options)

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

Parameters
NameDescription
requestListStudiesRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallListStudiesResponse

The call object.

ListStudiesAsync(ListStudiesRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListStudiesResponse> ListStudiesAsync(ListStudiesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
NameDescription
requestListStudiesRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallListStudiesResponse

The call object.

ListTrials(ListTrialsRequest, CallOptions)

public virtual ListTrialsResponse ListTrials(ListTrialsRequest request, CallOptions options)

Lists the Trials associated with a Study.

Parameters
NameDescription
requestListTrialsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
ListTrialsResponse

The response received from the server.

ListTrials(ListTrialsRequest, Metadata, DateTime?, CancellationToken)

public virtual ListTrialsResponse ListTrials(ListTrialsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists the Trials associated with a Study.

Parameters
NameDescription
requestListTrialsRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
ListTrialsResponse

The response received from the server.

ListTrialsAsync(ListTrialsRequest, CallOptions)

public virtual AsyncUnaryCall<ListTrialsResponse> ListTrialsAsync(ListTrialsRequest request, CallOptions options)

Lists the Trials associated with a Study.

Parameters
NameDescription
requestListTrialsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallListTrialsResponse

The call object.

ListTrialsAsync(ListTrialsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListTrialsResponse> ListTrialsAsync(ListTrialsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists the Trials associated with a Study.

Parameters
NameDescription
requestListTrialsRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallListTrialsResponse

The call object.

LookupStudy(LookupStudyRequest, CallOptions)

public virtual Study LookupStudy(LookupStudyRequest request, CallOptions options)

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

Parameters
NameDescription
requestLookupStudyRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Study

The response received from the server.

LookupStudy(LookupStudyRequest, Metadata, DateTime?, CancellationToken)

public virtual Study LookupStudy(LookupStudyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
NameDescription
requestLookupStudyRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Study

The response received from the server.

LookupStudyAsync(LookupStudyRequest, CallOptions)

public virtual AsyncUnaryCall<Study> LookupStudyAsync(LookupStudyRequest request, CallOptions options)

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

Parameters
NameDescription
requestLookupStudyRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallStudy

The call object.

LookupStudyAsync(LookupStudyRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Study> LookupStudyAsync(LookupStudyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
NameDescription
requestLookupStudyRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallStudy

The call object.

NewInstance(ClientBaseConfiguration)

protected override VizierService.VizierServiceClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
NameDescription
configurationClientBaseClientBaseConfiguration
Returns
TypeDescription
VizierServiceVizierServiceClient
Overrides

StopTrial(StopTrialRequest, CallOptions)

public virtual Trial StopTrial(StopTrialRequest request, CallOptions options)

Stops a Trial.

Parameters
NameDescription
requestStopTrialRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Trial

The response received from the server.

StopTrial(StopTrialRequest, Metadata, DateTime?, CancellationToken)

public virtual Trial StopTrial(StopTrialRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Stops a Trial.

Parameters
NameDescription
requestStopTrialRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Trial

The response received from the server.

StopTrialAsync(StopTrialRequest, CallOptions)

public virtual AsyncUnaryCall<Trial> StopTrialAsync(StopTrialRequest request, CallOptions options)

Stops a Trial.

Parameters
NameDescription
requestStopTrialRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallTrial

The call object.

StopTrialAsync(StopTrialRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Trial> StopTrialAsync(StopTrialRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Stops a Trial.

Parameters
NameDescription
requestStopTrialRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallTrial

The call object.

SuggestTrials(SuggestTrialsRequest, CallOptions)

public virtual Operation SuggestTrials(SuggestTrialsRequest request, CallOptions options)

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

Parameters
NameDescription
requestSuggestTrialsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

SuggestTrials(SuggestTrialsRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation SuggestTrials(SuggestTrialsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
NameDescription
requestSuggestTrialsRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

SuggestTrialsAsync(SuggestTrialsRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> SuggestTrialsAsync(SuggestTrialsRequest request, CallOptions options)

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

Parameters
NameDescription
requestSuggestTrialsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

SuggestTrialsAsync(SuggestTrialsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> SuggestTrialsAsync(SuggestTrialsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
NameDescription
requestSuggestTrialsRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.