- 3.13.0 (latest)
- 3.12.0
- 3.11.0
- 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 ModelServiceClientImpl : ModelServiceClient
Reference documentation and code samples for the Cloud AI Platform v1 API class ModelServiceClientImpl.
ModelService client wrapper implementation, for convenient use.
Namespace
Google.Cloud.AIPlatform.V1Assembly
Google.Cloud.AIPlatform.V1.dll
Remarks
A service for managing Vertex AI's machine learning Models.
Constructors
ModelServiceClientImpl(ModelService.ModelServiceClient, ModelServiceSettings, ILogger)
public ModelServiceClientImpl(ModelService.ModelServiceClient grpcClient, ModelServiceSettings settings, ILogger logger)
Constructs a client wrapper for the ModelService service, with the specified gRPC client and settings.
Parameters | |
---|---|
Name | Description |
grpcClient | ModelService.ModelServiceClient The underlying gRPC client. |
settings | ModelServiceSettings The base ModelServiceSettings used within this client. |
logger | ILogger Optional ILogger to use within this client. |
Properties
DeleteModelOperationsClient
public override OperationsClient DeleteModelOperationsClient { get; }
The long-running operations client for DeleteModel
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
DeleteModelVersionOperationsClient
public override OperationsClient DeleteModelVersionOperationsClient { get; }
The long-running operations client for DeleteModelVersion
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
ExportModelOperationsClient
public override OperationsClient ExportModelOperationsClient { get; }
The long-running operations client for ExportModel
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
GrpcClient
public override ModelService.ModelServiceClient GrpcClient { get; }
The underlying gRPC ModelService client
Property Value | |
---|---|
Type | Description |
ModelService.ModelServiceClient |
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 |
UploadModelOperationsClient
public override OperationsClient UploadModelOperationsClient { get; }
The long-running operations client for UploadModel
.
Property Value | |
---|---|
Type | Description |
OperationsClient |
Methods
BatchImportModelEvaluationSlices(BatchImportModelEvaluationSlicesRequest, CallSettings)
public override BatchImportModelEvaluationSlicesResponse BatchImportModelEvaluationSlices(BatchImportModelEvaluationSlicesRequest request, CallSettings callSettings = null)
Imports a list of externally generated ModelEvaluationSlice.
Parameters | |
---|---|
Name | Description |
request | BatchImportModelEvaluationSlicesRequest 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 |
BatchImportModelEvaluationSlicesResponse | The RPC response. |
BatchImportModelEvaluationSlicesAsync(BatchImportModelEvaluationSlicesRequest, CallSettings)
public override Task<BatchImportModelEvaluationSlicesResponse> BatchImportModelEvaluationSlicesAsync(BatchImportModelEvaluationSlicesRequest request, CallSettings callSettings = null)
Imports a list of externally generated ModelEvaluationSlice.
Parameters | |
---|---|
Name | Description |
request | BatchImportModelEvaluationSlicesRequest 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<BatchImportModelEvaluationSlicesResponse> | A Task containing the RPC response. |
DeleteModel(DeleteModelRequest, CallSettings)
public override Operation<Empty, DeleteOperationMetadata> DeleteModel(DeleteModelRequest request, CallSettings callSettings = null)
Deletes a Model.
A model cannot be deleted if any [Endpoint][google.cloud.aiplatform.v1.Endpoint] resource has a [DeployedModel][google.cloud.aiplatform.v1.DeployedModel] based on the model in its [deployed_models][google.cloud.aiplatform.v1.Endpoint.deployed_models] field.
Parameters | |
---|---|
Name | Description |
request | DeleteModelRequest 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<Empty, DeleteOperationMetadata> | The RPC response. |
DeleteModelAsync(DeleteModelRequest, CallSettings)
public override async Task<Operation<Empty, DeleteOperationMetadata>> DeleteModelAsync(DeleteModelRequest request, CallSettings callSettings = null)
Deletes a Model.
A model cannot be deleted if any [Endpoint][google.cloud.aiplatform.v1.Endpoint] resource has a [DeployedModel][google.cloud.aiplatform.v1.DeployedModel] based on the model in its [deployed_models][google.cloud.aiplatform.v1.Endpoint.deployed_models] field.
Parameters | |
---|---|
Name | Description |
request | DeleteModelRequest 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<Empty, DeleteOperationMetadata>> | A Task containing the RPC response. |
DeleteModelVersion(DeleteModelVersionRequest, CallSettings)
public override Operation<Empty, DeleteOperationMetadata> DeleteModelVersion(DeleteModelVersionRequest request, CallSettings callSettings = null)
Deletes a Model version.
Model version can only be deleted if there are no [DeployedModels][] created from it. Deleting the only version in the Model is not allowed. Use [DeleteModel][google.cloud.aiplatform.v1.ModelService.DeleteModel] for deleting the Model instead.
Parameters | |
---|---|
Name | Description |
request | DeleteModelVersionRequest 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<Empty, DeleteOperationMetadata> | The RPC response. |
DeleteModelVersionAsync(DeleteModelVersionRequest, CallSettings)
public override async Task<Operation<Empty, DeleteOperationMetadata>> DeleteModelVersionAsync(DeleteModelVersionRequest request, CallSettings callSettings = null)
Deletes a Model version.
Model version can only be deleted if there are no [DeployedModels][] created from it. Deleting the only version in the Model is not allowed. Use [DeleteModel][google.cloud.aiplatform.v1.ModelService.DeleteModel] for deleting the Model instead.
Parameters | |
---|---|
Name | Description |
request | DeleteModelVersionRequest 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<Empty, DeleteOperationMetadata>> | A Task containing the RPC response. |
ExportModel(ExportModelRequest, CallSettings)
public override Operation<ExportModelResponse, ExportModelOperationMetadata> ExportModel(ExportModelRequest request, CallSettings callSettings = null)
Exports a trained, exportable Model to a location specified by the user. A Model is considered to be exportable if it has at least one [supported export format][google.cloud.aiplatform.v1.Model.supported_export_formats].
Parameters | |
---|---|
Name | Description |
request | ExportModelRequest 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<ExportModelResponse, ExportModelOperationMetadata> | The RPC response. |
ExportModelAsync(ExportModelRequest, CallSettings)
public override async Task<Operation<ExportModelResponse, ExportModelOperationMetadata>> ExportModelAsync(ExportModelRequest request, CallSettings callSettings = null)
Exports a trained, exportable Model to a location specified by the user. A Model is considered to be exportable if it has at least one [supported export format][google.cloud.aiplatform.v1.Model.supported_export_formats].
Parameters | |
---|---|
Name | Description |
request | ExportModelRequest 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<ExportModelResponse, ExportModelOperationMetadata>> | A Task containing the RPC response. |
GetModel(GetModelRequest, CallSettings)
public override Model GetModel(GetModelRequest request, CallSettings callSettings = null)
Gets a Model.
Parameters | |
---|---|
Name | Description |
request | GetModelRequest 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 |
Model | The RPC response. |
GetModelAsync(GetModelRequest, CallSettings)
public override Task<Model> GetModelAsync(GetModelRequest request, CallSettings callSettings = null)
Gets a Model.
Parameters | |
---|---|
Name | Description |
request | GetModelRequest 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<Model> | A Task containing the RPC response. |
GetModelEvaluation(GetModelEvaluationRequest, CallSettings)
public override ModelEvaluation GetModelEvaluation(GetModelEvaluationRequest request, CallSettings callSettings = null)
Gets a ModelEvaluation.
Parameters | |
---|---|
Name | Description |
request | GetModelEvaluationRequest 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 |
ModelEvaluation | The RPC response. |
GetModelEvaluationAsync(GetModelEvaluationRequest, CallSettings)
public override Task<ModelEvaluation> GetModelEvaluationAsync(GetModelEvaluationRequest request, CallSettings callSettings = null)
Gets a ModelEvaluation.
Parameters | |
---|---|
Name | Description |
request | GetModelEvaluationRequest 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<ModelEvaluation> | A Task containing the RPC response. |
GetModelEvaluationSlice(GetModelEvaluationSliceRequest, CallSettings)
public override ModelEvaluationSlice GetModelEvaluationSlice(GetModelEvaluationSliceRequest request, CallSettings callSettings = null)
Gets a ModelEvaluationSlice.
Parameters | |
---|---|
Name | Description |
request | GetModelEvaluationSliceRequest 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 |
ModelEvaluationSlice | The RPC response. |
GetModelEvaluationSliceAsync(GetModelEvaluationSliceRequest, CallSettings)
public override Task<ModelEvaluationSlice> GetModelEvaluationSliceAsync(GetModelEvaluationSliceRequest request, CallSettings callSettings = null)
Gets a ModelEvaluationSlice.
Parameters | |
---|---|
Name | Description |
request | GetModelEvaluationSliceRequest 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<ModelEvaluationSlice> | A Task containing the RPC response. |
ImportModelEvaluation(ImportModelEvaluationRequest, CallSettings)
public override ModelEvaluation ImportModelEvaluation(ImportModelEvaluationRequest request, CallSettings callSettings = null)
Imports an externally generated ModelEvaluation.
Parameters | |
---|---|
Name | Description |
request | ImportModelEvaluationRequest 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 |
ModelEvaluation | The RPC response. |
ImportModelEvaluationAsync(ImportModelEvaluationRequest, CallSettings)
public override Task<ModelEvaluation> ImportModelEvaluationAsync(ImportModelEvaluationRequest request, CallSettings callSettings = null)
Imports an externally generated ModelEvaluation.
Parameters | |
---|---|
Name | Description |
request | ImportModelEvaluationRequest 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<ModelEvaluation> | A Task containing the RPC response. |
ListModelEvaluations(ListModelEvaluationsRequest, CallSettings)
public override PagedEnumerable<ListModelEvaluationsResponse, ModelEvaluation> ListModelEvaluations(ListModelEvaluationsRequest request, CallSettings callSettings = null)
Lists ModelEvaluations in a Model.
Parameters | |
---|---|
Name | Description |
request | ListModelEvaluationsRequest 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<ListModelEvaluationsResponse, ModelEvaluation> | A pageable sequence of ModelEvaluation resources. |
ListModelEvaluationsAsync(ListModelEvaluationsRequest, CallSettings)
public override PagedAsyncEnumerable<ListModelEvaluationsResponse, ModelEvaluation> ListModelEvaluationsAsync(ListModelEvaluationsRequest request, CallSettings callSettings = null)
Lists ModelEvaluations in a Model.
Parameters | |
---|---|
Name | Description |
request | ListModelEvaluationsRequest 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<ListModelEvaluationsResponse, ModelEvaluation> | A pageable asynchronous sequence of ModelEvaluation resources. |
ListModelEvaluationSlices(ListModelEvaluationSlicesRequest, CallSettings)
public override PagedEnumerable<ListModelEvaluationSlicesResponse, ModelEvaluationSlice> ListModelEvaluationSlices(ListModelEvaluationSlicesRequest request, CallSettings callSettings = null)
Lists ModelEvaluationSlices in a ModelEvaluation.
Parameters | |
---|---|
Name | Description |
request | ListModelEvaluationSlicesRequest 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<ListModelEvaluationSlicesResponse, ModelEvaluationSlice> | A pageable sequence of ModelEvaluationSlice resources. |
ListModelEvaluationSlicesAsync(ListModelEvaluationSlicesRequest, CallSettings)
public override PagedAsyncEnumerable<ListModelEvaluationSlicesResponse, ModelEvaluationSlice> ListModelEvaluationSlicesAsync(ListModelEvaluationSlicesRequest request, CallSettings callSettings = null)
Lists ModelEvaluationSlices in a ModelEvaluation.
Parameters | |
---|---|
Name | Description |
request | ListModelEvaluationSlicesRequest 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<ListModelEvaluationSlicesResponse, ModelEvaluationSlice> | A pageable asynchronous sequence of ModelEvaluationSlice resources. |
ListModels(ListModelsRequest, CallSettings)
public override PagedEnumerable<ListModelsResponse, Model> ListModels(ListModelsRequest request, CallSettings callSettings = null)
Lists Models in a Location.
Parameters | |
---|---|
Name | Description |
request | ListModelsRequest 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<ListModelsResponse, Model> | A pageable sequence of Model resources. |
ListModelsAsync(ListModelsRequest, CallSettings)
public override PagedAsyncEnumerable<ListModelsResponse, Model> ListModelsAsync(ListModelsRequest request, CallSettings callSettings = null)
Lists Models in a Location.
Parameters | |
---|---|
Name | Description |
request | ListModelsRequest 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<ListModelsResponse, Model> | A pageable asynchronous sequence of Model resources. |
ListModelVersions(ListModelVersionsRequest, CallSettings)
public override PagedEnumerable<ListModelVersionsResponse, Model> ListModelVersions(ListModelVersionsRequest request, CallSettings callSettings = null)
Lists versions of the specified model.
Parameters | |
---|---|
Name | Description |
request | ListModelVersionsRequest 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<ListModelVersionsResponse, Model> | A pageable sequence of Model resources. |
ListModelVersionsAsync(ListModelVersionsRequest, CallSettings)
public override PagedAsyncEnumerable<ListModelVersionsResponse, Model> ListModelVersionsAsync(ListModelVersionsRequest request, CallSettings callSettings = null)
Lists versions of the specified model.
Parameters | |
---|---|
Name | Description |
request | ListModelVersionsRequest 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<ListModelVersionsResponse, Model> | A pageable asynchronous sequence of Model resources. |
MergeVersionAliases(MergeVersionAliasesRequest, CallSettings)
public override Model MergeVersionAliases(MergeVersionAliasesRequest request, CallSettings callSettings = null)
Merges a set of aliases for a Model version.
Parameters | |
---|---|
Name | Description |
request | MergeVersionAliasesRequest 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 |
Model | The RPC response. |
MergeVersionAliasesAsync(MergeVersionAliasesRequest, CallSettings)
public override Task<Model> MergeVersionAliasesAsync(MergeVersionAliasesRequest request, CallSettings callSettings = null)
Merges a set of aliases for a Model version.
Parameters | |
---|---|
Name | Description |
request | MergeVersionAliasesRequest 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<Model> | A Task containing the RPC response. |
UpdateModel(UpdateModelRequest, CallSettings)
public override Model UpdateModel(UpdateModelRequest request, CallSettings callSettings = null)
Updates a Model.
Parameters | |
---|---|
Name | Description |
request | UpdateModelRequest 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 |
Model | The RPC response. |
UpdateModelAsync(UpdateModelRequest, CallSettings)
public override Task<Model> UpdateModelAsync(UpdateModelRequest request, CallSettings callSettings = null)
Updates a Model.
Parameters | |
---|---|
Name | Description |
request | UpdateModelRequest 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<Model> | A Task containing the RPC response. |
UploadModel(UploadModelRequest, CallSettings)
public override Operation<UploadModelResponse, UploadModelOperationMetadata> UploadModel(UploadModelRequest request, CallSettings callSettings = null)
Uploads a Model artifact into Vertex AI.
Parameters | |
---|---|
Name | Description |
request | UploadModelRequest 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<UploadModelResponse, UploadModelOperationMetadata> | The RPC response. |
UploadModelAsync(UploadModelRequest, CallSettings)
public override async Task<Operation<UploadModelResponse, UploadModelOperationMetadata>> UploadModelAsync(UploadModelRequest request, CallSettings callSettings = null)
Uploads a Model artifact into Vertex AI.
Parameters | |
---|---|
Name | Description |
request | UploadModelRequest 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<UploadModelResponse, UploadModelOperationMetadata>> | A Task containing the RPC response. |