Class ProjectsResource.LocationsResource.ModelsResource

The "models" collection of methods.

Inheritance

object

ProjectsResource.LocationsResource.ModelsResource

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Google.Apis.Aiplatform.v1

Assembly: Google.Apis.Aiplatform.v1.dll

Syntax

public class ProjectsResource.LocationsResource.ModelsResource

Constructors

ModelsResource(IClientService)

Constructs a new resource.

Declaration

public ModelsResource(IClientService service)

Parameters

Type	Name	Description
IClientService	service

Properties

Evaluations

Gets the Evaluations resource.

Declaration

public virtual ProjectsResource.LocationsResource.ModelsResource.EvaluationsResource Evaluations { get; }

Property Value

Type	Description
ProjectsResource.LocationsResource.ModelsResource.EvaluationsResource

Operations

Gets the Operations resource.

Declaration

public virtual ProjectsResource.LocationsResource.ModelsResource.OperationsResource Operations { get; }

Property Value

Type	Description
ProjectsResource.LocationsResource.ModelsResource.OperationsResource

Methods

Copy(GoogleCloudAiplatformV1CopyModelRequest, string)

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 content to be region-agnostic, as well as making sure that any resources (e.g. files) it depends on remain accessible.

Declaration

public virtual ProjectsResource.LocationsResource.ModelsResource.CopyRequest Copy(GoogleCloudAiplatformV1CopyModelRequest body, string parent)

Parameters

Type	Name	Description
GoogleCloudAiplatformV1CopyModelRequest	body	The body of the request.
string	parent	Required. The resource name of the Location into which to copy the Model. Format: projects/{project}/locations/{location}

Returns

Type	Description
ProjectsResource.LocationsResource.ModelsResource.CopyRequest

Delete(string)

Deletes a Model. A model cannot be deleted if any Endpoint resource has a DeployedModel based on the model in its deployed_models field.

Declaration

public virtual ProjectsResource.LocationsResource.ModelsResource.DeleteRequest Delete(string name)

Parameters

Type	Name	Description
string	name	Required. The name of the Model resource to be deleted. Format: projects/{project}/locations/{location}/models/{model}

Returns

Type	Description
ProjectsResource.LocationsResource.ModelsResource.DeleteRequest

DeleteVersion(string)

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 for deleting the Model instead.

Declaration

public virtual ProjectsResource.LocationsResource.ModelsResource.DeleteVersionRequest DeleteVersion(string name)

Parameters

Type	Name	Description
string	name	Required. The name of the model version to be deleted, with a version ID explicitly included. Example: projects/{project}/locations/{location}/models/{model}@1234

Returns

Type	Description
ProjectsResource.LocationsResource.ModelsResource.DeleteVersionRequest

Export(GoogleCloudAiplatformV1ExportModelRequest, string)

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.

Declaration

public virtual ProjectsResource.LocationsResource.ModelsResource.ExportRequest Export(GoogleCloudAiplatformV1ExportModelRequest body, string name)

Parameters

Type	Name	Description
GoogleCloudAiplatformV1ExportModelRequest	body	The body of the request.
string	name	Required. The resource name of the Model to export. The resource name may contain version id or version alias to specify the version, if no version is specified, the default version will be exported.

Returns

Type	Description
ProjectsResource.LocationsResource.ModelsResource.ExportRequest

Get(string)

Gets a Model.

Declaration

public virtual ProjectsResource.LocationsResource.ModelsResource.GetRequest Get(string name)

Parameters

Type	Name	Description
string	name	Required. The name of the Model resource. Format: projects/{project}/locations/{location}/models/{model} In order to retrieve a specific version of the model, also provide the version ID or version alias. Example: projects/{project}/locations/{location}/models/{model}@2 or projects/{project}/locations/{location}/models/{model}@golden If no version ID or alias is specified, the "default" version will be returned. The "default" version alias is created for the first version of the model, and can be moved to other versions later on. There will be exactly one default version.

Returns

Type	Description
ProjectsResource.LocationsResource.ModelsResource.GetRequest

GetIamPolicy(string)

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

Declaration

public virtual ProjectsResource.LocationsResource.ModelsResource.GetIamPolicyRequest GetIamPolicy(string resource)

Parameters

Type	Name	Description
string	resource	REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field.

Returns

Type	Description
ProjectsResource.LocationsResource.ModelsResource.GetIamPolicyRequest

List(string)

Lists Models in a Location.

Declaration

public virtual ProjectsResource.LocationsResource.ModelsResource.ListRequest List(string parent)

Parameters

Type	Name	Description
string	parent	Required. The resource name of the Location to list the Models from. Format: projects/{project}/locations/{location}

Returns

Type	Description
ProjectsResource.LocationsResource.ModelsResource.ListRequest

ListCheckpoints(string)

Lists checkpoints of the specified model version.

Declaration

public virtual ProjectsResource.LocationsResource.ModelsResource.ListCheckpointsRequest ListCheckpoints(string name)

Parameters

Type	Name	Description
string	name	Required. The name of the model version to list checkpoints for. projects/{project}/locations/{location}/models/{model}@{version} Example: projects/{project}/locations/{location}/models/{model}@2 or projects/{project}/locations/{location}/models/{model}@golden If no version ID or alias is specified, the latest version will be used.

Returns

Type	Description
ProjectsResource.LocationsResource.ModelsResource.ListCheckpointsRequest

ListVersions(string)

Lists versions of the specified model.

Declaration

public virtual ProjectsResource.LocationsResource.ModelsResource.ListVersionsRequest ListVersions(string name)

Parameters

Type	Name	Description
string	name	Required. The name of the model to list versions for.

Returns

Type	Description
ProjectsResource.LocationsResource.ModelsResource.ListVersionsRequest

MergeVersionAliases(GoogleCloudAiplatformV1MergeVersionAliasesRequest, string)

Merges a set of aliases for a Model version.

Declaration

public virtual ProjectsResource.LocationsResource.ModelsResource.MergeVersionAliasesRequest MergeVersionAliases(GoogleCloudAiplatformV1MergeVersionAliasesRequest body, string name)

Parameters

Type	Name	Description
GoogleCloudAiplatformV1MergeVersionAliasesRequest	body	The body of the request.
string	name	Required. The name of the model version to merge aliases, with a version ID explicitly included. Example: projects/{project}/locations/{location}/models/{model}@1234

Returns

Type	Description
ProjectsResource.LocationsResource.ModelsResource.MergeVersionAliasesRequest

Patch(GoogleCloudAiplatformV1Model, string)

Updates a Model.

Declaration

public virtual ProjectsResource.LocationsResource.ModelsResource.PatchRequest Patch(GoogleCloudAiplatformV1Model body, string name)

Parameters

Type	Name	Description
GoogleCloudAiplatformV1Model	body	The body of the request.
string	name	The resource name of the Model.

Returns

Type	Description
ProjectsResource.LocationsResource.ModelsResource.PatchRequest

SetIamPolicy(GoogleIamV1SetIamPolicyRequest, string)

Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

Declaration

public virtual ProjectsResource.LocationsResource.ModelsResource.SetIamPolicyRequest SetIamPolicy(GoogleIamV1SetIamPolicyRequest body, string resource)

Parameters

Type	Name	Description
GoogleIamV1SetIamPolicyRequest	body	The body of the request.
string	resource	REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.

Returns

Type	Description
ProjectsResource.LocationsResource.ModelsResource.SetIamPolicyRequest

TestIamPermissions(string)

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

Declaration

public virtual ProjectsResource.LocationsResource.ModelsResource.TestIamPermissionsRequest TestIamPermissions(string resource)

Parameters

Type	Name	Description
string	resource	REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field.

Returns

Type	Description
ProjectsResource.LocationsResource.ModelsResource.TestIamPermissionsRequest

UpdateExplanationDataset(GoogleCloudAiplatformV1UpdateExplanationDatasetRequest, string)

Incrementally update the dataset used for an examples model.

Declaration

public virtual ProjectsResource.LocationsResource.ModelsResource.UpdateExplanationDatasetRequest UpdateExplanationDataset(GoogleCloudAiplatformV1UpdateExplanationDatasetRequest body, string model)

Parameters

Type	Name	Description
GoogleCloudAiplatformV1UpdateExplanationDatasetRequest	body	The body of the request.
string	model	Required. The resource name of the Model to update. Format: projects/{project}/locations/{location}/models/{model}

Returns

Type	Description
ProjectsResource.LocationsResource.ModelsResource.UpdateExplanationDatasetRequest

Upload(GoogleCloudAiplatformV1UploadModelRequest, string)

Uploads a Model artifact into Vertex AI.

Declaration

public virtual ProjectsResource.LocationsResource.ModelsResource.UploadRequest Upload(GoogleCloudAiplatformV1UploadModelRequest body, string parent)

Parameters

Type	Name	Description
GoogleCloudAiplatformV1UploadModelRequest	body	The body of the request.
string	parent	Required. The resource name of the Location into which to upload the Model. Format: projects/{project}/locations/{location}

Returns

Type	Description
ProjectsResource.LocationsResource.ModelsResource.UploadRequest