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

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):



174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
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
 
# File 'lib/oci/data_science/models/model.rb', line 174

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.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']
end

Instance Attribute Details

#compartment_id ⇒ String

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

Returns:

  • (String) 


26
27
28
 
# File 'lib/oci/data_science/models/model.rb', line 26

def compartment_id
  @compartment_id
end

#created_by ⇒ String

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

Returns:

  • (String) 


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

def created_by
  @created_by
end

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

An array of custom metadata details for the model.

Returns:



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

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:



72
73
74
 
# File 'lib/oci/data_science/models/model.rb', line 72

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>>) 


64
65
66
 
# File 'lib/oci/data_science/models/model.rb', line 64

def defined_tags
  @defined_tags
end

#description ⇒ String

A short description of the model.

Returns:

  • (String) 


38
39
40
 
# File 'lib/oci/data_science/models/model.rb', line 38

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) 


34
35
36
 
# File 'lib/oci/data_science/models/model.rb', line 34

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>) 


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

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the model.

Returns:

  • (String) 


22
23
24
 
# File 'lib/oci/data_science/models/model.rb', line 22

def id
  @id
end

#input_schema ⇒ String

Input schema file content in String format

Returns:

  • (String) 


76
77
78
 
# File 'lib/oci/data_science/models/model.rb', line 76

def input_schema
  @input_schema
end

#lifecycle_state ⇒ String

[Required] The state of the model.

Returns:

  • (String) 


42
43
44
 
# File 'lib/oci/data_science/models/model.rb', line 42

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) 


84
85
86
 
# File 'lib/oci/data_science/models/model.rb', line 84

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) 


88
89
90
 
# File 'lib/oci/data_science/models/model.rb', line 88

def model_version_set_name
  @model_version_set_name
end

#output_schema ⇒ String

Output schema file content in String format

Returns:

  • (String) 


80
81
82
 
# File 'lib/oci/data_science/models/model.rb', line 80

def output_schema
  @output_schema
end

#project_id ⇒ String

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

Returns:

  • (String) 


30
31
32
 
# File 'lib/oci/data_science/models/model.rb', line 30

def project_id
  @project_id
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) 


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

def time_created
  @time_created
end

#version_id ⇒ Integer

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

Returns:

  • (Integer) 


92
93
94
 
# File 'lib/oci/data_science/models/model.rb', line 92

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) 


96
97
98
 
# File 'lib/oci/data_science/models/model.rb', line 96

def version_label
  @version_label
end

Class Method Details

.attribute_map ⇒ Object

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



99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'lib/oci/data_science/models/model.rb', line 99

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'compartment_id': :'compartmentId',
    'project_id': :'projectId',
    'display_name': :'displayName',
    'description': :'description',
    'lifecycle_state': :'lifecycleState',
    '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'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/oci/data_science/models/model.rb', line 125

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'compartment_id': :'String',
    'project_id': :'String',
    'display_name': :'String',
    'description': :'String',
    'lifecycle_state': :'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'
    # 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



301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
 
# File 'lib/oci/data_science/models/model.rb', line 301

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 &&
    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
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



348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
 
# File 'lib/oci/data_science/models/model.rb', line 348

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


328
329
330
 
# File 'lib/oci/data_science/models/model.rb', line 328

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



337
338
339
 
# File 'lib/oci/data_science/models/model.rb', line 337

def hash
  [id, compartment_id, project_id, display_name, description, lifecycle_state, 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].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



381
382
383
384
385
386
387
388
389
390
 
# File 'lib/oci/data_science/models/model.rb', line 381

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



375
376
377
 
# File 'lib/oci/data_science/models/model.rb', line 375

def to_s
  to_hash.to_s
end