Class: Google::Apis::MlV1::GoogleCloudMlV1Version

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

Overview

Represents a version of the model. Each version is a trained model deployed in the cloud, ready to handle prediction requests. A model can have multiple versions. You can get information about all of the versions of a given model by calling projects.models.versions.list. LINT.IfChange

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ GoogleCloudMlV1Version

Returns a new instance of GoogleCloudMlV1Version



1326
1327
1328
 
# File 'generated/google/apis/ml_v1/classes.rb', line 1326

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

Instance Attribute Details

#auto_scaling ⇒ Google::Apis::MlV1::GoogleCloudMlV1AutoScaling

Options for automatically scaling a model. Corresponds to the JSON property autoScaling

Returns:



1235
1236
1237
 
# File 'generated/google/apis/ml_v1/classes.rb', line 1235

def auto_scaling
  @auto_scaling
end

#create_time ⇒ String

Output only. The time the version was created. Corresponds to the JSON property createTime

Returns:

  • (String) 


1240
1241
1242
 
# File 'generated/google/apis/ml_v1/classes.rb', line 1240

def create_time
  @create_time
end

#deployment_uri ⇒ String

Required. The Google Cloud Storage location of the trained model used to create the version. See the overview of model deployment for more information. When passing Version to projects.models.versions.create the model service uses the specified location as the source of the model. Once deployed, the model version is hosted by the prediction service, so this location is useful only as a historical record. The total number of model files can't exceed 1000. Corresponds to the JSON property deploymentUri

Returns:

  • (String) 


1256
1257
1258
 
# File 'generated/google/apis/ml_v1/classes.rb', line 1256

def deployment_uri
  @deployment_uri
end

#description ⇒ String

Optional. The description specified for the version when it was created. Corresponds to the JSON property description

Returns:

  • (String) 


1261
1262
1263
 
# File 'generated/google/apis/ml_v1/classes.rb', line 1261

def description
  @description
end

#error_message ⇒ String

Output only. The details of a failure or a cancellation. Corresponds to the JSON property errorMessage

Returns:

  • (String) 


1266
1267
1268
 
# File 'generated/google/apis/ml_v1/classes.rb', line 1266

def error_message
  @error_message
end

#etag ⇒ String

etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a model from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform model updates in order to avoid race conditions: An etag is returned in the response to GetVersion, and systems are expected to put that etag in the request to UpdateVersion to ensure that their change will be applied to the model as intended. Corresponds to the JSON property etag NOTE: Values are automatically base64 encoded/decoded in the client library.

Returns:

  • (String) 


1278
1279
1280
 
# File 'generated/google/apis/ml_v1/classes.rb', line 1278

def etag
  @etag
end

#is_default ⇒ Boolean Also known as: is_default?

Output only. If true, this version will be used to handle prediction requests that do not specify a version. You can change the default version by calling projects.methods.versions.setDefault. Corresponds to the JSON property isDefault

Returns:

  • (Boolean) 


1287
1288
1289
 
# File 'generated/google/apis/ml_v1/classes.rb', line 1287

def is_default
  @is_default
end

#labels ⇒ Hash<String,String>

Optional. One or more labels that you can add, to organize your model versions. Each label is a key-value pair, where both the key and the value are arbitrary strings that you supply. For more information, see the documentation on using labels. Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>) 


1297
1298
1299
 
# File 'generated/google/apis/ml_v1/classes.rb', line 1297

def labels
  @labels
end

#last_use_time ⇒ String

Output only. The time the version was last used for prediction. Corresponds to the JSON property lastUseTime

Returns:

  • (String) 


1302
1303
1304
 
# File 'generated/google/apis/ml_v1/classes.rb', line 1302

def last_use_time
  @last_use_time
end

#manual_scaling ⇒ Google::Apis::MlV1::GoogleCloudMlV1ManualScaling

Options for manually scaling a model. Corresponds to the JSON property manualScaling

Returns:



1307
1308
1309
 
# File 'generated/google/apis/ml_v1/classes.rb', line 1307

def manual_scaling
  @manual_scaling
end

#name ⇒ String

Required.The name specified for the version when it was created. The version name must be unique within the model it is created in. Corresponds to the JSON property name

Returns:

  • (String) 


1313
1314
1315
 
# File 'generated/google/apis/ml_v1/classes.rb', line 1313

def name
  @name
end

#runtime_version ⇒ String

Optional. The Google Cloud ML runtime version to use for this deployment. If not set, Google Cloud ML will choose a version. Corresponds to the JSON property runtimeVersion

Returns:

  • (String) 


1319
1320
1321
 
# File 'generated/google/apis/ml_v1/classes.rb', line 1319

def runtime_version
  @runtime_version
end

#state ⇒ String

Output only. The state of a version. Corresponds to the JSON property state

Returns:

  • (String) 


1324
1325
1326
 
# File 'generated/google/apis/ml_v1/classes.rb', line 1324

def state
  @state
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
 
# File 'generated/google/apis/ml_v1/classes.rb', line 1331

def update!(**args)
  @auto_scaling = args[:auto_scaling] if args.key?(:auto_scaling)
  @create_time = args[:create_time] if args.key?(:create_time)
  @deployment_uri = args[:deployment_uri] if args.key?(:deployment_uri)
  @description = args[:description] if args.key?(:description)
  @error_message = args[:error_message] if args.key?(:error_message)
  @etag = args[:etag] if args.key?(:etag)
  @is_default = args[:is_default] if args.key?(:is_default)
  @labels = args[:labels] if args.key?(:labels)
  @last_use_time = args[:last_use_time] if args.key?(:last_use_time)
  @manual_scaling = args[:manual_scaling] if args.key?(:manual_scaling)
  @name = args[:name] if args.key?(:name)
  @runtime_version = args[:runtime_version] if args.key?(:runtime_version)
  @state = args[:state] if args.key?(:state)
end