Class: Google::Cloud::AIPlatform::V1::DeployedModel

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/aiplatform/v1/endpoint.rb

Overview

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

Defined Under Namespace

Classes: SystemLabelsEntry

Instance Attribute Summary collapse

Instance Attribute Details

#automatic_resources ⇒ ::Google::Cloud::AIPlatform::V1::AutomaticResources

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

Returns:



276
277
278
279
280
281
282
283
284
285
286
287
288
 
# File 'proto_docs/google/cloud/aiplatform/v1/endpoint.rb', line 276

class DeployedModel
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class SystemLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#create_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. Timestamp when the DeployedModel was created.

Returns:



276
277
278
279
280
281
282
283
284
285
286
287
288
 
# File 'proto_docs/google/cloud/aiplatform/v1/endpoint.rb', line 276

class DeployedModel
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class SystemLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#dedicated_resources ⇒ ::Google::Cloud::AIPlatform::V1::DedicatedResources

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

Returns:



276
277
278
279
280
281
282
283
284
285
286
287
288
 
# File 'proto_docs/google/cloud/aiplatform/v1/endpoint.rb', line 276

class DeployedModel
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class SystemLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#disable_container_logging ⇒ ::Boolean

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

Returns:

  • (::Boolean) —

    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.



276
277
278
279
280
281
282
283
284
285
286
287
288
 
# File 'proto_docs/google/cloud/aiplatform/v1/endpoint.rb', line 276

class DeployedModel
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class SystemLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#disable_explanations ⇒ ::Boolean

Returns If true, deploy the model without explainable feature, regardless the existence of Model.explanation_spec or explanation_spec.

Returns:



276
277
278
279
280
281
282
283
284
285
286
287
288
 
# File 'proto_docs/google/cloud/aiplatform/v1/endpoint.rb', line 276

class DeployedModel
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class SystemLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#display_name ⇒ ::String

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

Returns:

  • (::String) —

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



276
277
278
279
280
281
282
283
284
285
286
287
288
 
# File 'proto_docs/google/cloud/aiplatform/v1/endpoint.rb', line 276

class DeployedModel
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class SystemLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#enable_access_logging ⇒ ::Boolean

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

Returns:

  • (::Boolean) —

    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.



276
277
278
279
280
281
282
283
284
285
286
287
288
 
# File 'proto_docs/google/cloud/aiplatform/v1/endpoint.rb', line 276

class DeployedModel
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class SystemLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#explanation_spec ⇒ ::Google::Cloud::AIPlatform::V1::ExplanationSpec

Returns Explanation configuration for this DeployedModel.

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

Returns:



276
277
278
279
280
281
282
283
284
285
286
287
288
 
# File 'proto_docs/google/cloud/aiplatform/v1/endpoint.rb', line 276

class DeployedModel
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class SystemLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#faster_deployment_config ⇒ ::Google::Cloud::AIPlatform::V1::FasterDeploymentConfig

Returns Configuration for faster model deployment.

Returns:



276
277
278
279
280
281
282
283
284
285
286
287
288
 
# File 'proto_docs/google/cloud/aiplatform/v1/endpoint.rb', line 276

class DeployedModel
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class SystemLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#id ⇒ ::String

Returns 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]/.

Returns:

  • (::String) —

    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]/.



276
277
278
279
280
281
282
283
284
285
286
287
288
 
# File 'proto_docs/google/cloud/aiplatform/v1/endpoint.rb', line 276

class DeployedModel
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class SystemLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#model ⇒ ::String

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

Returns:

  • (::String) —

    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.



276
277
278
279
280
281
282
283
284
285
286
287
288
 
# File 'proto_docs/google/cloud/aiplatform/v1/endpoint.rb', line 276

class DeployedModel
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class SystemLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#model_version_id ⇒ ::String (readonly)

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

Returns:

  • (::String) —

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



276
277
278
279
280
281
282
283
284
285
286
287
288
 
# File 'proto_docs/google/cloud/aiplatform/v1/endpoint.rb', line 276

class DeployedModel
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class SystemLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#private_endpoints ⇒ ::Google::Cloud::AIPlatform::V1::PrivateEndpoints (readonly)

Returns 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 is configured.

Returns:



276
277
278
279
280
281
282
283
284
285
286
287
288
 
# File 'proto_docs/google/cloud/aiplatform/v1/endpoint.rb', line 276

class DeployedModel
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class SystemLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#service_account ⇒ ::String

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

Returns:

  • (::String) —

    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.



276
277
278
279
280
281
282
283
284
285
286
287
288
 
# File 'proto_docs/google/cloud/aiplatform/v1/endpoint.rb', line 276

class DeployedModel
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class SystemLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#shared_resources ⇒ ::String

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

Returns:

  • (::String) —

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



276
277
278
279
280
281
282
283
284
285
286
287
288
 
# File 'proto_docs/google/cloud/aiplatform/v1/endpoint.rb', line 276

class DeployedModel
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class SystemLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#system_labels ⇒ ::Google::Protobuf::Map{::String => ::String}

Returns System labels to apply to Model Garden deployments. System labels are managed by Google for internal use only.

Returns:

  • (::Google::Protobuf::Map{::String => ::String}) —

    System labels to apply to Model Garden deployments. System labels are managed by Google for internal use only.



276
277
278
279
280
281
282
283
284
285
286
287
288
 
# File 'proto_docs/google/cloud/aiplatform/v1/endpoint.rb', line 276

class DeployedModel
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class SystemLabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end