Class: OCI::DataScience::Models::MlApplicationImplementation

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

Overview

Resource representing solution for AI/ML use-case defined by ML Application

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_NEEDS_ATTENTION = 'NEEDS_ATTENTION'.freeze,
  LIFECYCLE_STATE_FAILED = 'FAILED'.freeze,
  LIFECYCLE_STATE_DELETING = 'DELETING'.freeze,
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.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 = {}) ⇒ MlApplicationImplementation

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
280
281
282
283
284
 
# File 'lib/oci/data_science/models/ml_application_implementation.rb', line 181

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

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

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

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

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

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

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

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


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

def allowed_migration_destinations
  @allowed_migration_destinations
end

#application_components ⇒ Array<OCI::DataScience::Models::ApplicationComponent>

List of application components (OCI resources shared for all MlApplicationInstances). These have been created automatically based on their definitions in the ML Application package.

Returns:



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

def application_components
  @application_components
end

#compartment_id ⇒ String

[Required] The OCID of the compartment where ML Application Implementation is created.

Returns:

  • (String) 


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

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:



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

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


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

def defined_tags
  @defined_tags
end

#description ⇒ String

Description of ML Application Implementation defined in ML Application package descriptor

Returns:

  • (String) 


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

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


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

def freeform_tags
  @freeform_tags
end

#id ⇒ String

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

Returns:

  • (String) 


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

def id
  @id
end

#lifecycle_details ⇒ String

[Required] A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.

Returns:

  • (String) 


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

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

[Required] The current state of the MlApplicationImplementation.

Returns:

  • (String) 


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

def lifecycle_state
  @lifecycle_state
end

#logging ⇒ OCI::DataScience::Models::ImplementationLogging

Returns:



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

def logging
  @logging
end

#ml_application_id ⇒ String

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

Returns:

  • (String) 


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

def ml_application_id
  @ml_application_id
end

#ml_application_name ⇒ String

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

Returns:

  • (String) 


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

def ml_application_name
  @ml_application_name
end

#ml_application_package_arguments ⇒ OCI::DataScience::Models::MlApplicationPackageArguments

Returns:



55
56
57
 
# File 'lib/oci/data_science/models/ml_application_implementation.rb', line 55

def ml_application_package_arguments
  @ml_application_package_arguments
end

#name ⇒ String

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

Returns:

  • (String) 


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

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) 


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

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


100
101
102
 
# File 'lib/oci/data_science/models/ml_application_implementation.rb', line 100

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

[Required] Creation time of MlApplicationImplementation creation in the format defined by RFC 3339.

Returns:

  • (DateTime) 


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

def time_created
  @time_created
end

#time_updated ⇒ DateTime

[Required] Time of last MlApplicationImplementation update in the format defined by RFC 3339.

Returns:

  • (DateTime) 


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

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

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



103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/oci/data_science/models/ml_application_implementation.rb', line 103

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',
    'application_components': :'applicationComponents',
    'configuration_schema': :'configurationSchema',
    'ml_application_package_arguments': :'mlApplicationPackageArguments',
    'allowed_migration_destinations': :'allowedMigrationDestinations',
    'logging': :'logging',
    'compartment_id': :'compartmentId',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/oci/data_science/models/ml_application_implementation.rb', line 130

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',
    'application_components': :'Array<OCI::DataScience::Models::ApplicationComponent>',
    'configuration_schema': :'Array<OCI::DataScience::Models::ConfigurationPropertySchema>',
    'ml_application_package_arguments': :'OCI::DataScience::Models::MlApplicationPackageArguments',
    'allowed_migration_destinations': :'Array<String>',
    'logging': :'OCI::DataScience::Models::ImplementationLogging',
    'compartment_id': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'lifecycle_state': :'String',
    'lifecycle_details': :'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



306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
 
# File 'lib/oci/data_science/models/ml_application_implementation.rb', line 306

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 &&
    application_components == other.application_components &&
    configuration_schema == other.configuration_schema &&
    ml_application_package_arguments == other.ml_application_package_arguments &&
    allowed_migration_destinations == other.allowed_migration_destinations &&
    logging == other.logging &&
    compartment_id == other.compartment_id &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_details == other.lifecycle_details &&
    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



354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
 
# File 'lib/oci/data_science/models/ml_application_implementation.rb', line 354

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


334
335
336
 
# File 'lib/oci/data_science/models/ml_application_implementation.rb', line 334

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



343
344
345
 
# File 'lib/oci/data_science/models/ml_application_implementation.rb', line 343

def hash
  [id, name, description, ml_application_id, ml_application_name, package_version, application_components, configuration_schema, ml_application_package_arguments, allowed_migration_destinations, logging, compartment_id, time_created, time_updated, lifecycle_state, lifecycle_details, 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



387
388
389
390
391
392
393
394
395
396
 
# File 'lib/oci/data_science/models/ml_application_implementation.rb', line 387

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



381
382
383
 
# File 'lib/oci/data_science/models/ml_application_implementation.rb', line 381

def to_s
  to_hash.to_s
end