Cloud AI Platform v1 API - Class ModelServiceClientImpl (2.27.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.

Inheritance

object > ModelServiceClient > ModelServiceClientImpl

Namespace

Google.Cloud.AIPlatform.V1

Assembly

Google.Cloud.AIPlatform.V1.dll

Remarks

A service for managing Vertex AI's machine learning Models.

Constructors

ModelServiceClientImpl(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 ModelServiceModelServiceClient

The underlying gRPC client.
settings ModelServiceSettings

The base ModelServiceSettings used within this client.
logger ILogger

Optional ILogger to use within this client.

Properties

CopyModelOperationsClient

public override OperationsClient CopyModelOperationsClient { get; }

The long-running operations client for CopyModel.

Property Value
Type Description
OperationsClient
Overrides

DeleteModelOperationsClient

public override OperationsClient DeleteModelOperationsClient { get; }

The long-running operations client for DeleteModel.

Property Value
Type Description
OperationsClient
Overrides

DeleteModelVersionOperationsClient

public override OperationsClient DeleteModelVersionOperationsClient { get; }

The long-running operations client for DeleteModelVersion.

Property Value
Type Description
OperationsClient
Overrides

ExportModelOperationsClient

public override OperationsClient ExportModelOperationsClient { get; }

The long-running operations client for ExportModel.

Property Value
Type Description
OperationsClient
Overrides

GrpcClient

public override ModelService.ModelServiceClient GrpcClient { get; }

The underlying gRPC ModelService client

Property Value
Type Description
ModelServiceModelServiceClient
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

UpdateExplanationDatasetOperationsClient

public override OperationsClient UpdateExplanationDatasetOperationsClient { get; }

The long-running operations client for UpdateExplanationDataset.

Property Value
Type Description
OperationsClient
Overrides

UploadModelOperationsClient

public override OperationsClient UploadModelOperationsClient { get; }

The long-running operations client for UploadModel.

Property Value
Type Description
OperationsClient
Overrides

Methods

BatchImportEvaluatedAnnotations(BatchImportEvaluatedAnnotationsRequest, CallSettings)

public override BatchImportEvaluatedAnnotationsResponse BatchImportEvaluatedAnnotations(BatchImportEvaluatedAnnotationsRequest request, CallSettings callSettings = null)

Imports a list of externally generated EvaluatedAnnotations.

Parameters
Name Description
request BatchImportEvaluatedAnnotationsRequest

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
BatchImportEvaluatedAnnotationsResponse

The RPC response.
Overrides

BatchImportEvaluatedAnnotationsAsync(BatchImportEvaluatedAnnotationsRequest, CallSettings)

public override Task<BatchImportEvaluatedAnnotationsResponse> BatchImportEvaluatedAnnotationsAsync(BatchImportEvaluatedAnnotationsRequest request, CallSettings callSettings = null)

Imports a list of externally generated EvaluatedAnnotations.

Parameters
Name Description
request BatchImportEvaluatedAnnotationsRequest

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
TaskBatchImportEvaluatedAnnotationsResponse

A Task containing the RPC response.
Overrides

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.
Overrides

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
TaskBatchImportModelEvaluationSlicesResponse

A Task containing the RPC response.
Overrides

CopyModel(CopyModelRequest, CallSettings)

public override Operation<CopyModelResponse, CopyModelOperationMetadata> CopyModel(CopyModelRequest request, CallSettings callSettings = null)

Copies an already existing Vertex AI Model into the specified Location. The source Model must exist in the same Project. When copying custom Models, the users themselves are responsible for [Model.metadata][google.cloud.aiplatform.v1.Model.metadata] content to be region-agnostic, as well as making sure that any resources (e.g. files) it depends on remain accessible.

Parameters
Name Description
request CopyModelRequest

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
OperationCopyModelResponseCopyModelOperationMetadata

The RPC response.
Overrides

CopyModelAsync(CopyModelRequest, CallSettings)

public override Task<Operation<CopyModelResponse, CopyModelOperationMetadata>> CopyModelAsync(CopyModelRequest request, CallSettings callSettings = null)

Copies an already existing Vertex AI Model into the specified Location. The source Model must exist in the same Project. When copying custom Models, the users themselves are responsible for [Model.metadata][google.cloud.aiplatform.v1.Model.metadata] content to be region-agnostic, as well as making sure that any resources (e.g. files) it depends on remain accessible.

Parameters
Name Description
request CopyModelRequest

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
TaskOperationCopyModelResponseCopyModelOperationMetadata

A Task containing the RPC response.
Overrides

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
OperationEmptyDeleteOperationMetadata

The RPC response.
Overrides

DeleteModelAsync(DeleteModelRequest, CallSettings)

public override 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
TaskOperationEmptyDeleteOperationMetadata

A Task containing the RPC response.
Overrides

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][google.cloud.aiplatform.v1.DeployedModel] 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
OperationEmptyDeleteOperationMetadata

The RPC response.
Overrides

DeleteModelVersionAsync(DeleteModelVersionRequest, CallSettings)

public override 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][google.cloud.aiplatform.v1.DeployedModel] 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
TaskOperationEmptyDeleteOperationMetadata

A Task containing the RPC response.
Overrides

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
OperationExportModelResponseExportModelOperationMetadata

The RPC response.
Overrides

ExportModelAsync(ExportModelRequest, CallSettings)

public override 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
TaskOperationExportModelResponseExportModelOperationMetadata

A Task containing the RPC response.
Overrides

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.
Overrides

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
TaskModel

A Task containing the RPC response.
Overrides

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.
Overrides

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
TaskModelEvaluation

A Task containing the RPC response.
Overrides

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.
Overrides

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
TaskModelEvaluationSlice

A Task containing the RPC response.
Overrides

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.
Overrides

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
TaskModelEvaluation

A Task containing the RPC response.
Overrides

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
PagedEnumerableListModelEvaluationSlicesResponseModelEvaluationSlice

A pageable sequence of ModelEvaluationSlice resources.
Overrides

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
PagedAsyncEnumerableListModelEvaluationSlicesResponseModelEvaluationSlice

A pageable asynchronous sequence of ModelEvaluationSlice resources.
Overrides

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
PagedEnumerableListModelEvaluationsResponseModelEvaluation

A pageable sequence of ModelEvaluation resources.
Overrides

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
PagedAsyncEnumerableListModelEvaluationsResponseModelEvaluation

A pageable asynchronous sequence of ModelEvaluation resources.
Overrides

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
PagedEnumerableListModelVersionsResponseModel

A pageable sequence of Model resources.
Overrides

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
PagedAsyncEnumerableListModelVersionsResponseModel

A pageable asynchronous sequence of Model resources.
Overrides

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
PagedEnumerableListModelsResponseModel

A pageable sequence of Model resources.
Overrides

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
PagedAsyncEnumerableListModelsResponseModel

A pageable asynchronous sequence of Model resources.
Overrides

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.
Overrides

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
TaskModel

A Task containing the RPC response.
Overrides

UpdateExplanationDataset(UpdateExplanationDatasetRequest, CallSettings)

public override Operation<UpdateExplanationDatasetResponse, UpdateExplanationDatasetOperationMetadata> UpdateExplanationDataset(UpdateExplanationDatasetRequest request, CallSettings callSettings = null)

Incrementally update the dataset used for an examples model.

Parameters
Name Description
request UpdateExplanationDatasetRequest

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
OperationUpdateExplanationDatasetResponseUpdateExplanationDatasetOperationMetadata

The RPC response.
Overrides

UpdateExplanationDatasetAsync(UpdateExplanationDatasetRequest, CallSettings)

public override Task<Operation<UpdateExplanationDatasetResponse, UpdateExplanationDatasetOperationMetadata>> UpdateExplanationDatasetAsync(UpdateExplanationDatasetRequest request, CallSettings callSettings = null)

Incrementally update the dataset used for an examples model.

Parameters
Name Description
request UpdateExplanationDatasetRequest

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
TaskOperationUpdateExplanationDatasetResponseUpdateExplanationDatasetOperationMetadata

A Task containing the RPC response.
Overrides

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.
Overrides

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
TaskModel

A Task containing the RPC response.
Overrides

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
OperationUploadModelResponseUploadModelOperationMetadata

The RPC response.
Overrides

UploadModelAsync(UploadModelRequest, CallSettings)

public override 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
TaskOperationUploadModelResponseUploadModelOperationMetadata

A Task containing the RPC response.
Overrides