Class: OCI::DataScience::Models::Model

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/data_science/models/model.rb

Overview

Models are mathematical representations of the relationships between data. Models are represented by their associated metadata and artifacts.

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_FAILED = 'FAILED'.freeze,
  LIFECYCLE_STATE_INACTIVE = 'INACTIVE'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
CATEGORY_ENUM = 
[
  CATEGORY_USER = 'USER'.freeze,
  CATEGORY_SERVICE = 'SERVICE'.freeze,
  CATEGORY_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Model

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash

Options Hash (attributes):



229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
 
# File 'lib/oci/data_science/models/model.rb', line 229

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  self.id = attributes[:'id'] if attributes[:'id']

  self.compartment_id = attributes[:'compartmentId'] if attributes[:'compartmentId']

  raise 'You cannot provide both :compartmentId and :compartment_id' if attributes.key?(:'compartmentId') && attributes.key?(:'compartment_id')

  self.compartment_id = attributes[:'compartment_id'] if attributes[:'compartment_id']

  self.project_id = attributes[:'projectId'] if attributes[:'projectId']

  raise 'You cannot provide both :projectId and :project_id' if attributes.key?(:'projectId') && attributes.key?(:'project_id')

  self.project_id = attributes[:'project_id'] if attributes[:'project_id']

  self.display_name = attributes[:'displayName'] if attributes[:'displayName']

  raise 'You cannot provide both :displayName and :display_name' if attributes.key?(:'displayName') && attributes.key?(:'display_name')

  self.display_name = attributes[:'display_name'] if attributes[:'display_name']

  self.description = attributes[:'description'] if attributes[:'description']

  self.lifecycle_state = attributes[:'lifecycleState'] if attributes[:'lifecycleState']

  raise 'You cannot provide both :lifecycleState and :lifecycle_state' if attributes.key?(:'lifecycleState') && attributes.key?(:'lifecycle_state')

  self.lifecycle_state = attributes[:'lifecycle_state'] if attributes[:'lifecycle_state']

  self.lifecycle_details = attributes[:'lifecycleDetails'] if attributes[:'lifecycleDetails']

  raise 'You cannot provide both :lifecycleDetails and :lifecycle_details' if attributes.key?(:'lifecycleDetails') && attributes.key?(:'lifecycle_details')

  self.lifecycle_details = attributes[:'lifecycle_details'] if attributes[:'lifecycle_details']

  self.time_created = attributes[:'timeCreated'] if attributes[:'timeCreated']

  raise 'You cannot provide both :timeCreated and :time_created' if attributes.key?(:'timeCreated') && attributes.key?(:'time_created')

  self.time_created = attributes[:'time_created'] if attributes[:'time_created']

  self.created_by = attributes[:'createdBy'] if attributes[:'createdBy']

  raise 'You cannot provide both :createdBy and :created_by' if attributes.key?(:'createdBy') && attributes.key?(:'created_by')

  self.created_by = attributes[:'created_by'] if attributes[:'created_by']

  self.freeform_tags = attributes[:'freeformTags'] if attributes[:'freeformTags']

  raise 'You cannot provide both :freeformTags and :freeform_tags' if attributes.key?(:'freeformTags') && attributes.key?(:'freeform_tags')

  self.freeform_tags = attributes[:'freeform_tags'] if attributes[:'freeform_tags']

  self.defined_tags = attributes[:'definedTags'] if attributes[:'definedTags']

  raise 'You cannot provide both :definedTags and :defined_tags' if attributes.key?(:'definedTags') && attributes.key?(:'defined_tags')

  self.defined_tags = attributes[:'defined_tags'] if attributes[:'defined_tags']

  self.custom_metadata_list = attributes[:'customMetadataList'] if attributes[:'customMetadataList']

  raise 'You cannot provide both :customMetadataList and :custom_metadata_list' if attributes.key?(:'customMetadataList') && attributes.key?(:'custom_metadata_list')

  self.custom_metadata_list = attributes[:'custom_metadata_list'] if attributes[:'custom_metadata_list']

  self.defined_metadata_list = attributes[:'definedMetadataList'] if attributes[:'definedMetadataList']

  raise 'You cannot provide both :definedMetadataList and :defined_metadata_list' if attributes.key?(:'definedMetadataList') && attributes.key?(:'defined_metadata_list')

  self.defined_metadata_list = attributes[:'defined_metadata_list'] if attributes[:'defined_metadata_list']

  self.input_schema = attributes[:'inputSchema'] if attributes[:'inputSchema']

  raise 'You cannot provide both :inputSchema and :input_schema' if attributes.key?(:'inputSchema') && attributes.key?(:'input_schema')

  self.input_schema = attributes[:'input_schema'] if attributes[:'input_schema']

  self.output_schema = attributes[:'outputSchema'] if attributes[:'outputSchema']

  raise 'You cannot provide both :outputSchema and :output_schema' if attributes.key?(:'outputSchema') && attributes.key?(:'output_schema')

  self.output_schema = attributes[:'output_schema'] if attributes[:'output_schema']

  self.model_version_set_id = attributes[:'modelVersionSetId'] if attributes[:'modelVersionSetId']

  raise 'You cannot provide both :modelVersionSetId and :model_version_set_id' if attributes.key?(:'modelVersionSetId') && attributes.key?(:'model_version_set_id')

  self.model_version_set_id = attributes[:'model_version_set_id'] if attributes[:'model_version_set_id']

  self.model_version_set_name = attributes[:'modelVersionSetName'] if attributes[:'modelVersionSetName']

  raise 'You cannot provide both :modelVersionSetName and :model_version_set_name' if attributes.key?(:'modelVersionSetName') && attributes.key?(:'model_version_set_name')

  self.model_version_set_name = attributes[:'model_version_set_name'] if attributes[:'model_version_set_name']

  self.version_id = attributes[:'versionId'] if attributes[:'versionId']

  raise 'You cannot provide both :versionId and :version_id' if attributes.key?(:'versionId') && attributes.key?(:'version_id')

  self.version_id = attributes[:'version_id'] if attributes[:'version_id']

  self.version_label = attributes[:'versionLabel'] if attributes[:'versionLabel']

  raise 'You cannot provide both :versionLabel and :version_label' if attributes.key?(:'versionLabel') && attributes.key?(:'version_label')

  self.version_label = attributes[:'version_label'] if attributes[:'version_label']

  self.category = attributes[:'category'] if attributes[:'category']

  self.is_model_by_reference = attributes[:'isModelByReference'] unless attributes[:'isModelByReference'].nil?
  self.is_model_by_reference = false if is_model_by_reference.nil? && !attributes.key?(:'isModelByReference') # rubocop:disable Style/StringLiterals

  raise 'You cannot provide both :isModelByReference and :is_model_by_reference' if attributes.key?(:'isModelByReference') && attributes.key?(:'is_model_by_reference')

  self.is_model_by_reference = attributes[:'is_model_by_reference'] unless attributes[:'is_model_by_reference'].nil?
  self.is_model_by_reference = false if is_model_by_reference.nil? && !attributes.key?(:'isModelByReference') && !attributes.key?(:'is_model_by_reference') # rubocop:disable Style/StringLiterals

  self.retention_setting = attributes[:'retentionSetting'] if attributes[:'retentionSetting']

  raise 'You cannot provide both :retentionSetting and :retention_setting' if attributes.key?(:'retentionSetting') && attributes.key?(:'retention_setting')

  self.retention_setting = attributes[:'retention_setting'] if attributes[:'retention_setting']

  self.backup_setting = attributes[:'backupSetting'] if attributes[:'backupSetting']

  raise 'You cannot provide both :backupSetting and :backup_setting' if attributes.key?(:'backupSetting') && attributes.key?(:'backup_setting')

  self.backup_setting = attributes[:'backup_setting'] if attributes[:'backup_setting']

  self.retention_operation_details = attributes[:'retentionOperationDetails'] if attributes[:'retentionOperationDetails']

  raise 'You cannot provide both :retentionOperationDetails and :retention_operation_details' if attributes.key?(:'retentionOperationDetails') && attributes.key?(:'retention_operation_details')

  self.retention_operation_details = attributes[:'retention_operation_details'] if attributes[:'retention_operation_details']

  self.backup_operation_details = attributes[:'backupOperationDetails'] if attributes[:'backupOperationDetails']

  raise 'You cannot provide both :backupOperationDetails and :backup_operation_details' if attributes.key?(:'backupOperationDetails') && attributes.key?(:'backup_operation_details')

  self.backup_operation_details = attributes[:'backup_operation_details'] if attributes[:'backup_operation_details']
end

Instance Attribute Details

#backup_operation_details ⇒ OCI::DataScience::Models::BackupOperationDetails

This attribute is required.

Returns:



130
131
132
 
# File 'lib/oci/data_science/models/model.rb', line 130

def backup_operation_details
  @backup_operation_details
end

#backup_setting ⇒ OCI::DataScience::Models::BackupSetting

This attribute is required.

Returns:



122
123
124
 
# File 'lib/oci/data_science/models/model.rb', line 122

def backup_setting
  @backup_setting
end

#category ⇒ String

[Required] The category of the model.

Returns:

  • (String) 


110
111
112
 
# File 'lib/oci/data_science/models/model.rb', line 110

def category
  @category
end

#compartment_id ⇒ String

[Required] The OCID of the model's compartment.

Returns:

  • (String) 


32
33
34
 
# File 'lib/oci/data_science/models/model.rb', line 32

def compartment_id
  @compartment_id
end

#created_by ⇒ String

[Required] The OCID of the user who created the model.

Returns:

  • (String) 


62
63
64
 
# File 'lib/oci/data_science/models/model.rb', line 62

def created_by
  @created_by
end

#custom_metadata_list ⇒ Array<OCI::DataScience::Models::Metadata>

An array of custom metadata details for the model.

Returns:



78
79
80
 
# File 'lib/oci/data_science/models/model.rb', line 78

def custom_metadata_list
  @custom_metadata_list
end

#defined_metadata_list ⇒ Array<OCI::DataScience::Models::Metadata>

An array of defined metadata details for the model.

Returns:



82
83
84
 
# File 'lib/oci/data_science/models/model.rb', line 82

def defined_metadata_list
  @defined_metadata_list
end

#defined_tags ⇒ Hash<String, Hash<String, Object>>

Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: {\"Operations\": {\"CostCenter\": \"42\"}}

Returns:

  • (Hash<String, Hash<String, Object>>) 


74
75
76
 
# File 'lib/oci/data_science/models/model.rb', line 74

def defined_tags
  @defined_tags
end

#description ⇒ String

A short description of the model.

Returns:

  • (String) 


44
45
46
 
# File 'lib/oci/data_science/models/model.rb', line 44

def description
  @description
end

#display_name ⇒ String

[Required] A user-friendly display name for the resource. It does not have to be unique and can be modified. Avoid entering confidential information.

Returns:

  • (String) 


40
41
42
 
# File 'lib/oci/data_science/models/model.rb', line 40

def display_name
  @display_name
end

#freeform_tags ⇒ Hash<String, String>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See Resource Tags. Example: {\"Department\": \"Finance\"}

Returns:

  • (Hash<String, String>) 


68
69
70
 
# File 'lib/oci/data_science/models/model.rb', line 68

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the model.

Returns:

  • (String) 


28
29
30
 
# File 'lib/oci/data_science/models/model.rb', line 28

def id
  @id
end

#input_schema ⇒ String

Input schema file content in String format

Returns:

  • (String) 


86
87
88
 
# File 'lib/oci/data_science/models/model.rb', line 86

def input_schema
  @input_schema
end

#is_model_by_reference ⇒ BOOLEAN

[Required] Identifier to indicate whether a model artifact resides in the Service Tenancy or Customer Tenancy.

Returns:

  • (BOOLEAN) 


114
115
116
 
# File 'lib/oci/data_science/models/model.rb', line 114

def is_model_by_reference
  @is_model_by_reference
end

#lifecycle_details ⇒ String

[Required] Details about the lifecycle state of the model.

Returns:

  • (String) 


52
53
54
 
# File 'lib/oci/data_science/models/model.rb', line 52

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

[Required] The state of the model.

Returns:

  • (String) 


48
49
50
 
# File 'lib/oci/data_science/models/model.rb', line 48

def lifecycle_state
  @lifecycle_state
end

#model_version_set_id ⇒ String

[Required] The OCID of the model version set that the model is associated to.

Returns:

  • (String) 


94
95
96
 
# File 'lib/oci/data_science/models/model.rb', line 94

def model_version_set_id
  @model_version_set_id
end

#model_version_set_name ⇒ String

[Required] The name of the model version set that the model is associated to.

Returns:

  • (String) 


98
99
100
 
# File 'lib/oci/data_science/models/model.rb', line 98

def model_version_set_name
  @model_version_set_name
end

#output_schema ⇒ String

Output schema file content in String format

Returns:

  • (String) 


90
91
92
 
# File 'lib/oci/data_science/models/model.rb', line 90

def output_schema
  @output_schema
end

#project_id ⇒ String

[Required] The OCID of the project associated with the model.

Returns:

  • (String) 


36
37
38
 
# File 'lib/oci/data_science/models/model.rb', line 36

def project_id
  @project_id
end

#retention_operation_details ⇒ OCI::DataScience::Models::RetentionOperationDetails

This attribute is required.

Returns:



126
127
128
 
# File 'lib/oci/data_science/models/model.rb', line 126

def retention_operation_details
  @retention_operation_details
end

#retention_setting ⇒ OCI::DataScience::Models::RetentionSetting

This attribute is required.

Returns:



118
119
120
 
# File 'lib/oci/data_science/models/model.rb', line 118

def retention_setting
  @retention_setting
end

#time_created ⇒ DateTime

[Required] The date and time the resource was created in the timestamp format defined by RFC3339. Example: 2019-08-25T21:10:29.41Z

Returns:

  • (DateTime) 


58
59
60
 
# File 'lib/oci/data_science/models/model.rb', line 58

def time_created
  @time_created
end

#version_id ⇒ Integer

[Required] Unique identifier assigned to each version of the model.

Returns:

  • (Integer) 


102
103
104
 
# File 'lib/oci/data_science/models/model.rb', line 102

def version_id
  @version_id
end

#version_label ⇒ String

[Required] The version label can add an additional description of the lifecycle state of the model or the application using and training the model.

Returns:

  • (String) 


106
107
108
 
# File 'lib/oci/data_science/models/model.rb', line 106

def version_label
  @version_label
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/oci/data_science/models/model.rb', line 133

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'compartment_id': :'compartmentId',
    'project_id': :'projectId',
    'display_name': :'displayName',
    'description': :'description',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails',
    'time_created': :'timeCreated',
    'created_by': :'createdBy',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'custom_metadata_list': :'customMetadataList',
    'defined_metadata_list': :'definedMetadataList',
    'input_schema': :'inputSchema',
    'output_schema': :'outputSchema',
    'model_version_set_id': :'modelVersionSetId',
    'model_version_set_name': :'modelVersionSetName',
    'version_id': :'versionId',
    'version_label': :'versionLabel',
    'category': :'category',
    'is_model_by_reference': :'isModelByReference',
    'retention_setting': :'retentionSetting',
    'backup_setting': :'backupSetting',
    'retention_operation_details': :'retentionOperationDetails',
    'backup_operation_details': :'backupOperationDetails'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/oci/data_science/models/model.rb', line 166

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'compartment_id': :'String',
    'project_id': :'String',
    'display_name': :'String',
    'description': :'String',
    'lifecycle_state': :'String',
    'lifecycle_details': :'String',
    'time_created': :'DateTime',
    'created_by': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'custom_metadata_list': :'Array<OCI::DataScience::Models::Metadata>',
    'defined_metadata_list': :'Array<OCI::DataScience::Models::Metadata>',
    'input_schema': :'String',
    'output_schema': :'String',
    'model_version_set_id': :'String',
    'model_version_set_name': :'String',
    'version_id': :'Integer',
    'version_label': :'String',
    'category': :'String',
    'is_model_by_reference': :'BOOLEAN',
    'retention_setting': :'OCI::DataScience::Models::RetentionSetting',
    'backup_setting': :'OCI::DataScience::Models::BackupSetting',
    'retention_operation_details': :'OCI::DataScience::Models::RetentionOperationDetails',
    'backup_operation_details': :'OCI::DataScience::Models::BackupOperationDetails'
    # rubocop:enable Style/SymbolLiteral
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object) —

    the other object to be compared



409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
 
# File 'lib/oci/data_science/models/model.rb', line 409

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    id == other.id &&
    compartment_id == other.compartment_id &&
    project_id == other.project_id &&
    display_name == other.display_name &&
    description == other.description &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_details == other.lifecycle_details &&
    time_created == other.time_created &&
    created_by == other.created_by &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    custom_metadata_list == other.custom_metadata_list &&
    defined_metadata_list == other.defined_metadata_list &&
    input_schema == other.input_schema &&
    output_schema == other.output_schema &&
    model_version_set_id == other.model_version_set_id &&
    model_version_set_name == other.model_version_set_name &&
    version_id == other.version_id &&
    version_label == other.version_label &&
    category == other.category &&
    is_model_by_reference == other.is_model_by_reference &&
    retention_setting == other.retention_setting &&
    backup_setting == other.backup_setting &&
    retention_operation_details == other.retention_operation_details &&
    backup_operation_details == other.backup_operation_details
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
 
# File 'lib/oci/data_science/models/model.rb', line 463

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)

  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        public_method("#{key}=").call(
          attributes[self.class.attribute_map[key]]
            .map { |v| OCI::Internal::Util.convert_to_type(Regexp.last_match(1), v) }
        )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      public_method("#{key}=").call(
        OCI::Internal::Util.convert_to_type(type, attributes[self.class.attribute_map[key]])
      )
    end
    # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • other (Object) —

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


443
444
445
 
# File 'lib/oci/data_science/models/model.rb', line 443

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



452
453
454
 
# File 'lib/oci/data_science/models/model.rb', line 452

def hash
  [id, compartment_id, project_id, display_name, description, lifecycle_state, lifecycle_details, time_created, created_by, freeform_tags, defined_tags, custom_metadata_list, defined_metadata_list, input_schema, output_schema, model_version_set_id, model_version_set_name, version_id, version_label, category, is_model_by_reference, retention_setting, backup_setting, retention_operation_details, backup_operation_details].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



496
497
498
499
500
501
502
503
504
505
 
# File 'lib/oci/data_science/models/model.rb', line 496

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = public_method(attr).call
    next if value.nil? && !instance_variable_defined?("@#{attr}")

    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



490
491
492
 
# File 'lib/oci/data_science/models/model.rb', line 490

def to_s
  to_hash.to_s
end