Cloud AI Platform v1 API - Class DeployedModel (2.27.0)

Version latest

• 2.27.0 (latest)
• 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 DeployedModel : IMessage<DeployedModel>, IEquatable<DeployedModel>, IDeepCloneable<DeployedModel>, IBufferMessage, IMessage

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

A deployment of a Model. Endpoints contain one or more DeployedModels.

Inheritance

object > DeployedModel

Implements

IMessageDeployedModel, IEquatableDeployedModel, IDeepCloneableDeployedModel, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.AIPlatform.V1

Assembly

Google.Cloud.AIPlatform.V1.dll

Constructors

DeployedModel()

public DeployedModel()

DeployedModel(DeployedModel)

public DeployedModel(DeployedModel other)

Parameter
Name	Description
other	DeployedModel

Properties

AutomaticResources

public AutomaticResources AutomaticResources { get; set; }

A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration.

Property Value
Type	Description
AutomaticResources

CreateTime

public Timestamp CreateTime { get; set; }

Output only. Timestamp when the DeployedModel was created.

Property Value
Type	Description
Timestamp

DedicatedResources

public DedicatedResources DedicatedResources { get; set; }

A description of resources that are dedicated to the DeployedModel, and that need a higher degree of manual configuration.

Property Value
Type	Description
DedicatedResources

DisableContainerLogging

public bool DisableContainerLogging { get; set; }

For custom-trained Models and AutoML Tabular Models, the container of the DeployedModel instances will send stderr and stdout streams to Cloud Logging by default. Please note that the logs incur cost, which are subject to Cloud Logging pricing.

User can disable container logging by setting this flag to true.

Property Value
Type	Description
bool

DisableExplanations

public bool DisableExplanations { get; set; }

If true, deploy the model without explainable feature, regardless the existence of [Model.explanation_spec][google.cloud.aiplatform.v1.Model.explanation_spec] or [explanation_spec][google.cloud.aiplatform.v1.DeployedModel.explanation_spec].

Property Value
Type	Description
bool

DisplayName

public string DisplayName { get; set; }

The display name of the DeployedModel. If not provided upon creation, the Model's display_name is used.

Property Value
Type	Description
string

EnableAccessLogging

public bool EnableAccessLogging { get; set; }

If true, online prediction access logs are sent to Cloud Logging. These logs are like standard server access logs, containing information like timestamp and latency for each prediction request.

Note that logs may incur a cost, especially if your project receives prediction requests at a high queries per second rate (QPS). Estimate your costs before enabling this option.

Property Value
Type	Description
bool

ExplanationSpec

public ExplanationSpec ExplanationSpec { get; set; }

Explanation configuration for this DeployedModel.

When deploying a Model using [EndpointService.DeployModel][google.cloud.aiplatform.v1.EndpointService.DeployModel], this value overrides the value of [Model.explanation_spec][google.cloud.aiplatform.v1.Model.explanation_spec]. All fields of [explanation_spec][google.cloud.aiplatform.v1.DeployedModel.explanation_spec] are optional in the request. If a field of [explanation_spec][google.cloud.aiplatform.v1.DeployedModel.explanation_spec] is not populated, the value of the same field of [Model.explanation_spec][google.cloud.aiplatform.v1.Model.explanation_spec] is inherited. If the corresponding [Model.explanation_spec][google.cloud.aiplatform.v1.Model.explanation_spec] is not populated, all fields of the [explanation_spec][google.cloud.aiplatform.v1.DeployedModel.explanation_spec] will be used for the explanation configuration.

Property Value
Type	Description
ExplanationSpec

HasSharedResources

public bool HasSharedResources { get; }

Gets whether the "shared_resources" field is set

Property Value
Type	Description
bool

Id

public string Id { get; set; }

Immutable. The ID of the DeployedModel. If not provided upon deployment, Vertex AI will generate a value for this ID.

This value should be 1-10 characters, and valid characters are /[0-9]/.

Property Value
Type	Description
string

Model

public string Model { get; set; }

Required. The resource name of the Model that this is the deployment of. Note that the Model may be in a different location than the DeployedModel's Endpoint.

The resource name may contain version id or version alias to specify the version. Example: projects/{project}/locations/{location}/models/{model}@2 or projects/{project}/locations/{location}/models/{model}@golden if no version is specified, the default version will be deployed.

Property Value
Type	Description
string

ModelAsModelName

public ModelName ModelAsModelName { get; set; }

ModelName-typed view over the Model resource name property.

Property Value
Type	Description
ModelName

ModelVersionId

public string ModelVersionId { get; set; }

Output only. The version ID of the model that is deployed.

Property Value
Type	Description
string

PredictionResourcesCase

public DeployedModel.PredictionResourcesOneofCase PredictionResourcesCase { get; }

Property Value
Type	Description
DeployedModelPredictionResourcesOneofCase

PrivateEndpoints

public PrivateEndpoints PrivateEndpoints { get; set; }

Output only. Provide paths for users to send predict/explain/health requests directly to the deployed model services running on Cloud via private services access. This field is populated if [network][google.cloud.aiplatform.v1.Endpoint.network] is configured.

Property Value
Type	Description
PrivateEndpoints

ServiceAccount

public string ServiceAccount { get; set; }

The service account that the DeployedModel's container runs as. Specify the email address of the service account. If this service account is not specified, the container runs as a service account that doesn't have access to the resource project.

Users deploying the Model must have the iam.serviceAccounts.actAs permission on this service account.

Property Value
Type	Description
string

SharedResources

public string SharedResources { get; set; }

The resource name of the shared DeploymentResourcePool to deploy on. Format: projects/{project}/locations/{location}/deploymentResourcePools/{deployment_resource_pool}

Property Value
Type	Description
string

SharedResourcesAsDeploymentResourcePoolName

public DeploymentResourcePoolName SharedResourcesAsDeploymentResourcePoolName { get; set; }

DeploymentResourcePoolName-typed view over the SharedResources resource name property.

Property Value
Type	Description
DeploymentResourcePoolName