- 3.10.0 (latest)
- 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 : VizierServiceClientReference documentation and code samples for the Cloud AI Platform v1 API class VizierServiceClientImpl.
VizierService client wrapper implementation, for convenient use.
Namespace
GoogleCloudGoogle.Cloud.AIPlatformV1Assembly
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(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 | VizierServiceVizierServiceClientThe underlying gRPC client. |
settings | VizierServiceSettingsThe base VizierServiceSettings used within this client. |
logger | ILoggerOptional 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 | |
GrpcClient
public override VizierService.VizierServiceClient GrpcClient { get; }The underlying gRPC VizierService client
| Property Value | |
|---|---|
| Type | Description |
VizierServiceVizierServiceClient | |
IAMPolicyClient
public override IAMPolicyClient IAMPolicyClient { get; }The IAMPolicyClient associated with this client.
| Property Value | |
|---|---|
| Type | Description |
IAMPolicyClient | |
LocationsClient
public override LocationsClient LocationsClient { get; }The LocationsClient associated with this client.
| Property Value | |
|---|---|
| Type | Description |
LocationsClient | |
SuggestTrialsOperationsClient
public override OperationsClient SuggestTrialsOperationsClient { get; }The long-running operations client for SuggestTrials.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
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 | AddTrialMeasurementRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Trial | The RPC response. |
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 | AddTrialMeasurementRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskTrial | A Task containing the RPC response. |
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.v1.CheckTrialEarlyStoppingStateResponse].
| Parameters | |
|---|---|
| Name | Description |
request | CheckTrialEarlyStoppingStateRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationCheckTrialEarlyStoppingStateResponseCheckTrialEarlyStoppingStateMetatdata | The RPC response. |
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.v1.CheckTrialEarlyStoppingStateResponse].
| Parameters | |
|---|---|
| Name | Description |
request | CheckTrialEarlyStoppingStateRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationCheckTrialEarlyStoppingStateResponseCheckTrialEarlyStoppingStateMetatdata | A Task containing the RPC response. |
CompleteTrial(CompleteTrialRequest, CallSettings)
public override Trial CompleteTrial(CompleteTrialRequest request, CallSettings callSettings = null)Marks a Trial as complete.
| Parameters | |
|---|---|
| Name | Description |
request | CompleteTrialRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Trial | The RPC response. |
CompleteTrialAsync(CompleteTrialRequest, CallSettings)
public override Task<Trial> CompleteTrialAsync(CompleteTrialRequest request, CallSettings callSettings = null)Marks a Trial as complete.
| Parameters | |
|---|---|
| Name | Description |
request | CompleteTrialRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskTrial | A Task containing the RPC response. |
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 | CreateStudyRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Study | The RPC response. |
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 | CreateStudyRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskStudy | A Task containing the RPC response. |
CreateTrial(CreateTrialRequest, CallSettings)
public override Trial CreateTrial(CreateTrialRequest request, CallSettings callSettings = null)Adds a user provided Trial to a Study.
| Parameters | |
|---|---|
| Name | Description |
request | CreateTrialRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Trial | The RPC response. |
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 | CreateTrialRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskTrial | A Task containing the RPC response. |
DeleteStudy(DeleteStudyRequest, CallSettings)
public override void DeleteStudy(DeleteStudyRequest request, CallSettings callSettings = null)Deletes a Study.
| Parameters | |
|---|---|
| Name | Description |
request | DeleteStudyRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
DeleteStudyAsync(DeleteStudyRequest, CallSettings)
public override Task DeleteStudyAsync(DeleteStudyRequest request, CallSettings callSettings = null)Deletes a Study.
| Parameters | |
|---|---|
| Name | Description |
request | DeleteStudyRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task | A Task containing the RPC response. |
DeleteTrial(DeleteTrialRequest, CallSettings)
public override void DeleteTrial(DeleteTrialRequest request, CallSettings callSettings = null)Deletes a Trial.
| Parameters | |
|---|---|
| Name | Description |
request | DeleteTrialRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
DeleteTrialAsync(DeleteTrialRequest, CallSettings)
public override Task DeleteTrialAsync(DeleteTrialRequest request, CallSettings callSettings = null)Deletes a Trial.
| Parameters | |
|---|---|
| Name | Description |
request | DeleteTrialRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task | A Task containing the RPC response. |
GetStudy(GetStudyRequest, CallSettings)
public override Study GetStudy(GetStudyRequest request, CallSettings callSettings = null)Gets a Study by name.
| Parameters | |
|---|---|
| Name | Description |
request | GetStudyRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Study | The RPC response. |
GetStudyAsync(GetStudyRequest, CallSettings)
public override Task<Study> GetStudyAsync(GetStudyRequest request, CallSettings callSettings = null)Gets a Study by name.
| Parameters | |
|---|---|
| Name | Description |
request | GetStudyRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskStudy | A Task containing the RPC response. |
GetTrial(GetTrialRequest, CallSettings)
public override Trial GetTrial(GetTrialRequest request, CallSettings callSettings = null)Gets a Trial.
| Parameters | |
|---|---|
| Name | Description |
request | GetTrialRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Trial | The RPC response. |
GetTrialAsync(GetTrialRequest, CallSettings)
public override Task<Trial> GetTrialAsync(GetTrialRequest request, CallSettings callSettings = null)Gets a Trial.
| Parameters | |
|---|---|
| Name | Description |
request | GetTrialRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskTrial | A Task containing the RPC response. |
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 | ListOptimalTrialsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
ListOptimalTrialsResponse | The RPC response. |
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 | ListOptimalTrialsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskListOptimalTrialsResponse | A Task containing the RPC response. |
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 | ListStudiesRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerableListStudiesResponseStudy | A pageable sequence of Study resources. |
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 | ListStudiesRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerableListStudiesResponseStudy | A pageable asynchronous sequence of Study resources. |
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 | ListTrialsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerableListTrialsResponseTrial | A pageable sequence of Trial resources. |
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 | ListTrialsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerableListTrialsResponseTrial | A pageable asynchronous sequence of Trial resources. |
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 | LookupStudyRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Study | The RPC response. |
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 | LookupStudyRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskStudy | A Task containing the RPC response. |
StopTrial(StopTrialRequest, CallSettings)
public override Trial StopTrial(StopTrialRequest request, CallSettings callSettings = null)Stops a Trial.
| Parameters | |
|---|---|
| Name | Description |
request | StopTrialRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Trial | The RPC response. |
StopTrialAsync(StopTrialRequest, CallSettings)
public override Task<Trial> StopTrialAsync(StopTrialRequest request, CallSettings callSettings = null)Stops a Trial.
| Parameters | |
|---|---|
| Name | Description |
request | StopTrialRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskTrial | A Task containing the RPC response. |
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 | SuggestTrialsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
OperationSuggestTrialsResponseSuggestTrialsMetadata | The RPC response. |
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.ml.v1.SuggestTrialsResponse].
| Parameters | |
|---|---|
| Name | Description |
request | SuggestTrialsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
TaskOperationSuggestTrialsResponseSuggestTrialsMetadata | A Task containing the RPC response. |