Class: OCI::DataScience::Models::MlApplicationImplementationSummary

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

Overview

Summary of the MlApplicationImplementation.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ MlApplicationImplementationSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
164
165
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
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
 
# File 'lib/oci/data_science/models/ml_application_implementation_summary.rb', line 137

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

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

  self.ml_application_id = attributes[:'mlApplicationId'] if attributes[:'mlApplicationId']

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

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

  self.ml_application_name = attributes[:'mlApplicationName'] if attributes[:'mlApplicationName']

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

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

  self.package_version = attributes[:'packageVersion'] if attributes[:'packageVersion']

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

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

  self.configuration_schema = attributes[:'configurationSchema'] if attributes[:'configurationSchema']

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

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

  self.allowed_migration_destinations = attributes[:'allowedMigrationDestinations'] if attributes[:'allowedMigrationDestinations']

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

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

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

Instance Attribute Details

#allowed_migration_destinations ⇒ Array<String>

List of ML Application Implementation OCIDs for which migration from this implementation is allowed. Migration means that if consumers change implementation for their instances to implementation with OCID from this list, instance components will be updated in place otherwise new instance components are created based on the new implementation and old instance components are removed.

Returns:

  • (Array<String>) 


41
42
43
 
# File 'lib/oci/data_science/models/ml_application_implementation_summary.rb', line 41

def allowed_migration_destinations
  @allowed_migration_destinations
end

#compartment_id ⇒ String

[Required] The OCID of the compartment where the MlApplicationImplementation is created.

Returns:

  • (String) 


45
46
47
 
# File 'lib/oci/data_science/models/ml_application_implementation_summary.rb', line 45

def compartment_id
  @compartment_id
end

#configuration_schema ⇒ Array<OCI::DataScience::Models::ConfigurationPropertySchema>

Schema of configuration which needs to be provided for each ML Application Instance. It is defined in the ML Application package descriptor.

Returns:



37
38
39
 
# File 'lib/oci/data_science/models/ml_application_implementation_summary.rb', line 37

def configuration_schema
  @configuration_schema
end

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

[Required] 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>>) 


65
66
67
 
# File 'lib/oci/data_science/models/ml_application_implementation_summary.rb', line 65

def defined_tags
  @defined_tags
end

#description ⇒ String

Description of ML Application Implementation defined in ML Application package descriptor

Returns:

  • (String) 


21
22
23
 
# File 'lib/oci/data_science/models/ml_application_implementation_summary.rb', line 21

def description
  @description
end

#freeform_tags ⇒ Hash<String, String>

[Required] 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>) 


59
60
61
 
# File 'lib/oci/data_science/models/ml_application_implementation_summary.rb', line 59

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the MlApplicationImplementation. Unique identifier that is immutable after creation.

Returns:

  • (String) 


13
14
15
 
# File 'lib/oci/data_science/models/ml_application_implementation_summary.rb', line 13

def id
  @id
end

#lifecycle_state ⇒ String

[Required] The current state of the ML Application Implementation.

Returns:

  • (String) 


53
54
55
 
# File 'lib/oci/data_science/models/ml_application_implementation_summary.rb', line 53

def lifecycle_state
  @lifecycle_state
end

#ml_application_id ⇒ String

[Required] The OCID of the ML Application implemented by this ML Application Implementation.

Returns:

  • (String) 


25
26
27
 
# File 'lib/oci/data_science/models/ml_application_implementation_summary.rb', line 25

def ml_application_id
  @ml_application_id
end

#ml_application_name ⇒ String

[Required] The name of ML Application (based on mlApplicationId).

Returns:

  • (String) 


29
30
31
 
# File 'lib/oci/data_science/models/ml_application_implementation_summary.rb', line 29

def ml_application_name
  @ml_application_name
end

#name ⇒ String

[Required] ML Application Implementation name which is unique for given ML Application.

Returns:

  • (String) 


17
18
19
 
# File 'lib/oci/data_science/models/ml_application_implementation_summary.rb', line 17

def name
  @name
end

#package_version ⇒ String

The version of ML Application Package (e.g. "1.2" or "2.0.4") defined in ML Application package descriptor. Value is not mandatory only for CREATING state otherwise it must be always presented.

Returns:

  • (String) 


33
34
35
 
# File 'lib/oci/data_science/models/ml_application_implementation_summary.rb', line 33

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


71
72
73
 
# File 'lib/oci/data_science/models/ml_application_implementation_summary.rb', line 71

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

[Required] The time the MlApplicationImplementation was created. An RFC3339 formatted datetime string

Returns:

  • (DateTime) 


49
50
51
 
# File 'lib/oci/data_science/models/ml_application_implementation_summary.rb', line 49

def time_created
  @time_created
end

Class Method Details

.attribute_map ⇒ Object

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



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/oci/data_science/models/ml_application_implementation_summary.rb', line 74

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'name': :'name',
    'description': :'description',
    'ml_application_id': :'mlApplicationId',
    'ml_application_name': :'mlApplicationName',
    'package_version': :'packageVersion',
    'configuration_schema': :'configurationSchema',
    'allowed_migration_destinations': :'allowedMigrationDestinations',
    'compartment_id': :'compartmentId',
    'time_created': :'timeCreated',
    'lifecycle_state': :'lifecycleState',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/oci/data_science/models/ml_application_implementation_summary.rb', line 96

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'name': :'String',
    'description': :'String',
    'ml_application_id': :'String',
    'ml_application_name': :'String',
    'package_version': :'String',
    'configuration_schema': :'Array<OCI::DataScience::Models::ConfigurationPropertySchema>',
    'allowed_migration_destinations': :'Array<String>',
    'compartment_id': :'String',
    'time_created': :'DateTime',
    'lifecycle_state': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'system_tags': :'Hash<String, Hash<String, Object>>'
    # 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



223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
 
# File 'lib/oci/data_science/models/ml_application_implementation_summary.rb', line 223

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

  self.class == other.class &&
    id == other.id &&
    name == other.name &&
    description == other.description &&
    ml_application_id == other.ml_application_id &&
    ml_application_name == other.ml_application_name &&
    package_version == other.package_version &&
    configuration_schema == other.configuration_schema &&
    allowed_migration_destinations == other.allowed_migration_destinations &&
    compartment_id == other.compartment_id &&
    time_created == other.time_created &&
    lifecycle_state == other.lifecycle_state &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    system_tags == other.system_tags
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



266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
 
# File 'lib/oci/data_science/models/ml_application_implementation_summary.rb', line 266

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


246
247
248
 
# File 'lib/oci/data_science/models/ml_application_implementation_summary.rb', line 246

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



255
256
257
 
# File 'lib/oci/data_science/models/ml_application_implementation_summary.rb', line 255

def hash
  [id, name, description, ml_application_id, ml_application_name, package_version, configuration_schema, allowed_migration_destinations, compartment_id, time_created, lifecycle_state, freeform_tags, defined_tags, system_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



299
300
301
302
303
304
305
306
307
308
 
# File 'lib/oci/data_science/models/ml_application_implementation_summary.rb', line 299

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



293
294
295
 
# File 'lib/oci/data_science/models/ml_application_implementation_summary.rb', line 293

def to_s
  to_hash.to_s
end