Class: Google::Apis::AiplatformV1::GoogleCloudAiplatformV1DeployedModel

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/aiplatform_v1/classes.rb,
lib/google/apis/aiplatform_v1/representations.rb,
lib/google/apis/aiplatform_v1/representations.rb

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudAiplatformV1DeployedModel

Returns a new instance of GoogleCloudAiplatformV1DeployedModel.



4187
4188
4189
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 4187

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#automatic_resources ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1AutomaticResources

A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. Each Model supporting these resources documents its specific guidelines. Corresponds to the JSON property automaticResources

Returns:



4104
4105
4106
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 4104

def automatic_resources
  @automatic_resources
end

#create_time ⇒ String

Output only. Timestamp when the DeployedModel was created. Corresponds to the JSON property createTime

Returns:

  • (String) 


4109
4110
4111
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 4109

def create_time
  @create_time
end

#dedicated_resources ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1DedicatedResources

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

Returns:



4115
4116
4117
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 4115

def dedicated_resources
  @dedicated_resources
end

#disable_container_logging ⇒ Boolean Also known as: disable_container_logging?

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. Corresponds to the JSON property disableContainerLogging

Returns:

  • (Boolean) 


4124
4125
4126
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 4124

def disable_container_logging
  @disable_container_logging
end

#display_name ⇒ String

The display name of the DeployedModel. If not provided upon creation, the Model's display_name is used. Corresponds to the JSON property displayName

Returns:

  • (String) 


4131
4132
4133
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 4131

def display_name
  @display_name
end

#enable_access_logging ⇒ Boolean Also known as: enable_access_logging?

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. Corresponds to the JSON property enableAccessLogging

Returns:

  • (Boolean) 


4140
4141
4142
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 4140

def enable_access_logging
  @enable_access_logging
end

#explanation_spec ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ExplanationSpec

Specification of Model explanation. Corresponds to the JSON property explanationSpec

Returns:



4146
4147
4148
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 4146

def explanation_spec
  @explanation_spec
end

#id ⇒ 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]/. Corresponds to the JSON property id

Returns:

  • (String) 


4153
4154
4155
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 4153

def id
  @id
end

#model ⇒ 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. Corresponds to the JSON property model

Returns:

  • (String) 


4163
4164
4165
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 4163

def model
  @model
end

#model_version_id ⇒ String

Output only. The version ID of the model that is deployed. Corresponds to the JSON property modelVersionId

Returns:

  • (String) 


4168
4169
4170
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 4168

def model_version_id
  @model_version_id
end

#private_endpoints ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1PrivateEndpoints

PrivateEndpoints proto is used to provide paths for users to send requests privately. To send request via private service access, use predict_http_uri, explain_http_uri or health_http_uri. To send request via private service connect, use service_attachment. Corresponds to the JSON property privateEndpoints

Returns:



4176
4177
4178
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 4176

def private_endpoints
  @private_endpoints
end

#service_account ⇒ 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. Corresponds to the JSON property serviceAccount

Returns:

  • (String) 


4185
4186
4187
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 4185

def 
  @service_account
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 4192

def update!(**args)
  @automatic_resources = args[:automatic_resources] if args.key?(:automatic_resources)
  @create_time = args[:create_time] if args.key?(:create_time)
  @dedicated_resources = args[:dedicated_resources] if args.key?(:dedicated_resources)
  @disable_container_logging = args[:disable_container_logging] if args.key?(:disable_container_logging)
  @display_name = args[:display_name] if args.key?(:display_name)
  @enable_access_logging = args[:enable_access_logging] if args.key?(:enable_access_logging)
  @explanation_spec = args[:explanation_spec] if args.key?(:explanation_spec)
  @id = args[:id] if args.key?(:id)
  @model = args[:model] if args.key?(:model)
  @model_version_id = args[:model_version_id] if args.key?(:model_version_id)
  @private_endpoints = args[:private_endpoints] if args.key?(:private_endpoints)
  @service_account = args[:service_account] if args.key?(:service_account)
end