Class: OCI::DataScience::Models::ModelGroup

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

Overview

Model group is a collection of the models. Model groups are represented by their associated metadata.

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_FAILED = 'FAILED'.freeze,
  LIFECYCLE_STATE_INACTIVE = 'INACTIVE'.freeze,
  LIFECYCLE_STATE_DELETING = 'DELETING'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.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 = {}) ⇒ ModelGroup

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
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
 
# File 'lib/oci/data_science/models/model_group.rb', line 201

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.model_group_details = attributes[:'modelGroupDetails'] if attributes[:'modelGroupDetails']

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

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

  self.member_model_entries = attributes[:'memberModelEntries'] if attributes[:'memberModelEntries']

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

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

  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.system_tags = attributes[:'systemTags'] if attributes[:'systemTags']

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

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

  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.time_updated = attributes[:'timeUpdated'] if attributes[:'timeUpdated']

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

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

  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.model_group_version_history_id = attributes[:'modelGroupVersionHistoryId'] if attributes[:'modelGroupVersionHistoryId']

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

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

  self.model_group_version_history_name = attributes[:'modelGroupVersionHistoryName'] if attributes[:'modelGroupVersionHistoryName']

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

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

  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.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.create_type = attributes[:'createType'] if attributes[:'createType']

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

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

  self.source_model_group_id = attributes[:'sourceModelGroupId'] if attributes[:'sourceModelGroupId']

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

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

Instance Attribute Details

#compartment_id ⇒ String

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

Returns:

  • (String) 


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

def compartment_id
  @compartment_id
end

#create_type ⇒ String

The type of the model group create operation.

Returns:

  • (String) 


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

def create_type
  @create_type
end

#created_by ⇒ String

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

Returns:

  • (String) 


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

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


60
61
62
 
# File 'lib/oci/data_science/models/model_group.rb', line 60

def defined_tags
  @defined_tags
end

#description ⇒ String

A short description of the modelGroup.

Returns:

  • (String) 


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

def description
  @description
end

#display_name ⇒ String

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) 


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

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


54
55
56
 
# File 'lib/oci/data_science/models/model_group.rb', line 54

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the modelGroup.

Returns:

  • (String) 


24
25
26
 
# File 'lib/oci/data_science/models/model_group.rb', line 24

def id
  @id
end

#lifecycle_details ⇒ String

Details about the lifecycle state of the model group.

Returns:

  • (String) 


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

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

[Required] The state of the modelGroup.

Returns:

  • (String) 


70
71
72
 
# File 'lib/oci/data_science/models/model_group.rb', line 70

def lifecycle_state
  @lifecycle_state
end

#member_model_entries ⇒ OCI::DataScience::Models::MemberModelEntries

This attribute is required.

Returns:



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

def member_model_entries
  @member_model_entries
end

#model_group_details ⇒ OCI::DataScience::Models::ModelGroupDetails

This attribute is required.

Returns:



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

def model_group_details
  @model_group_details
end

#model_group_version_history_id ⇒ String

The OCID of the model group version history to which the modelGroup is associated.

Returns:

  • (String) 


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

def model_group_version_history_id
  @model_group_version_history_id
end

#model_group_version_history_name ⇒ String

The name of the model group version history to which the model group is associated.

Returns:

  • (String) 


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

def model_group_version_history_name
  @model_group_version_history_name
end

#project_id ⇒ String

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

Returns:

  • (String) 


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

def project_id
  @project_id
end

#source_model_group_id ⇒ String

The OCID of the model group used for the clone operation.

Returns:

  • (String) 


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

def source_model_group_id
  @source_model_group_id
end

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

Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}

Returns:

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


66
67
68
 
# File 'lib/oci/data_science/models/model_group.rb', line 66

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


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

def time_created
  @time_created
end

#time_updated ⇒ DateTime

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

Returns:

  • (DateTime) 


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

def time_updated
  @time_updated
end

#version_id ⇒ Integer

Unique identifier assigned to each version of the model group. It would be auto-incremented number generated by service.

Returns:

  • (Integer) 


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

def version_id
  @version_id
end

#version_label ⇒ String

An additional description of the lifecycle state of the model group.

Returns:

  • (String) 


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

def version_label
  @version_label
end

Class Method Details

.attribute_map ⇒ Object

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



117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/oci/data_science/models/model_group.rb', line 117

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'compartment_id': :'compartmentId',
    'project_id': :'projectId',
    'display_name': :'displayName',
    'description': :'description',
    'model_group_details': :'modelGroupDetails',
    'member_model_entries': :'memberModelEntries',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'created_by': :'createdBy',
    'model_group_version_history_id': :'modelGroupVersionHistoryId',
    'model_group_version_history_name': :'modelGroupVersionHistoryName',
    'version_label': :'versionLabel',
    'version_id': :'versionId',
    'create_type': :'createType',
    'source_model_group_id': :'sourceModelGroupId'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
 
# File 'lib/oci/data_science/models/model_group.rb', line 146

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'compartment_id': :'String',
    'project_id': :'String',
    'display_name': :'String',
    'description': :'String',
    'model_group_details': :'OCI::DataScience::Models::ModelGroupDetails',
    'member_model_entries': :'OCI::DataScience::Models::MemberModelEntries',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'system_tags': :'Hash<String, Hash<String, Object>>',
    'lifecycle_state': :'String',
    'lifecycle_details': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'created_by': :'String',
    'model_group_version_history_id': :'String',
    'model_group_version_history_name': :'String',
    'version_label': :'String',
    'version_id': :'Integer',
    'create_type': :'String',
    'source_model_group_id': :'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



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
 
# File 'lib/oci/data_science/models/model_group.rb', line 346

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 &&
    model_group_details == other.model_group_details &&
    member_model_entries == other.member_model_entries &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    system_tags == other.system_tags &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_details == other.lifecycle_details &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    created_by == other.created_by &&
    model_group_version_history_id == other.model_group_version_history_id &&
    model_group_version_history_name == other.model_group_version_history_name &&
    version_label == other.version_label &&
    version_id == other.version_id &&
    create_type == other.create_type &&
    source_model_group_id == other.source_model_group_id
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



396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
 
# File 'lib/oci/data_science/models/model_group.rb', line 396

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


376
377
378
 
# File 'lib/oci/data_science/models/model_group.rb', line 376

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



385
386
387
 
# File 'lib/oci/data_science/models/model_group.rb', line 385

def hash
  [id, compartment_id, project_id, display_name, description, model_group_details, member_model_entries, freeform_tags, defined_tags, system_tags, lifecycle_state, lifecycle_details, time_created, time_updated, created_by, model_group_version_history_id, model_group_version_history_name, version_label, version_id, create_type, source_model_group_id].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



429
430
431
432
433
434
435
436
437
438
 
# File 'lib/oci/data_science/models/model_group.rb', line 429

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



423
424
425
 
# File 'lib/oci/data_science/models/model_group.rb', line 423

def to_s
  to_hash.to_s
end