Class: OCI::DataScience::Models::MlApplicationInstance

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

Overview

Resource representing instance of ML Application.

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze,
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_INACTIVE = 'INACTIVE'.freeze,
  LIFECYCLE_STATE_DELETING = 'DELETING'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_NEEDS_ATTENTION = 'NEEDS_ATTENTION'.freeze,
  LIFECYCLE_STATE_FAILED = 'FAILED'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
LIFECYCLE_SUBSTATE_ENUM = 
[
  LIFECYCLE_SUBSTATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_SUBSTATE_UPDATING = 'UPDATING'.freeze,
  LIFECYCLE_SUBSTATE_UPGRADING = 'UPGRADING'.freeze,
  LIFECYCLE_SUBSTATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_SUBSTATE_INACTIVE = 'INACTIVE'.freeze,
  LIFECYCLE_SUBSTATE_DELETING = 'DELETING'.freeze,
  LIFECYCLE_SUBSTATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_SUBSTATE_NEEDS_ATTENTION = 'NEEDS_ATTENTION'.freeze,
  LIFECYCLE_SUBSTATE_FAILED = 'FAILED'.freeze,
  LIFECYCLE_SUBSTATE_NON_RECOVERABLE_PROVIDER_ISSUE = 'NON_RECOVERABLE_PROVIDER_ISSUE'.freeze,
  LIFECYCLE_SUBSTATE_RECOVERABLE_PROVIDER_ISSUE = 'RECOVERABLE_PROVIDER_ISSUE'.freeze,
  LIFECYCLE_SUBSTATE_NON_RECOVERABLE_SERVICE_ISSUE = 'NON_RECOVERABLE_SERVICE_ISSUE'.freeze,
  LIFECYCLE_SUBSTATE_RECOVERABLE_SERVICE_ISSUE = 'RECOVERABLE_SERVICE_ISSUE'.freeze,
  LIFECYCLE_SUBSTATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ MlApplicationInstance

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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

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

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

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

  self.ml_application_implementation_name = attributes[:'mlApplicationImplementationName'] if attributes[:'mlApplicationImplementationName']

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

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

  self.auth_configuration = attributes[:'authConfiguration'] if attributes[:'authConfiguration']

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

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

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

  self.is_enabled = attributes[:'isEnabled'] unless attributes[:'isEnabled'].nil?

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

  self.is_enabled = attributes[:'is_enabled'] unless attributes[:'is_enabled'].nil?

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

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

  self.prediction_endpoint_details = attributes[:'prediction_endpoint_details'] if attributes[:'prediction_endpoint_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.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_substate = attributes[:'lifecycleSubstate'] if attributes[:'lifecycleSubstate']

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

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

  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

#auth_configuration ⇒ OCI::DataScience::Models::AuthConfiguration

Returns:



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

def auth_configuration
  @auth_configuration
end

#compartment_id ⇒ String

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

Returns:

  • (String) 


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

def compartment_id
  @compartment_id
end

#configuration ⇒ Array<OCI::DataScience::Models::ConfigurationProperty>

Data that are used for provisioning of the given MlApplicationInstance. These are validated against configurationSchema defined in referenced MlApplicationImplementation.

Returns:



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

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


115
116
117
 
# File 'lib/oci/data_science/models/ml_application_instance.rb', line 115

def defined_tags
  @defined_tags
end

#display_name ⇒ String

[Required] The name of MlApplicationInstance. System will generate displayName when not provided during creation.

Returns:

  • (String) 


47
48
49
 
# File 'lib/oci/data_science/models/ml_application_instance.rb', line 47

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


109
110
111
 
# File 'lib/oci/data_science/models/ml_application_instance.rb', line 109

def freeform_tags
  @freeform_tags
end

#id ⇒ String

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

Returns:

  • (String) 


43
44
45
 
# File 'lib/oci/data_science/models/ml_application_instance.rb', line 43

def id
  @id
end

#is_enabled ⇒ BOOLEAN

[Required] States whether the MlApplicationInstance is supposed to be in ACTIVE lifecycle state.

Returns:

  • (BOOLEAN) 


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

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


103
104
105
 
# File 'lib/oci/data_science/models/ml_application_instance.rb', line 103

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

[Required] The current state of the MlApplicationInstance.

Returns:

  • (String) 


93
94
95
 
# File 'lib/oci/data_science/models/ml_application_instance.rb', line 93

def lifecycle_state
  @lifecycle_state
end

#lifecycle_substate ⇒ String

[Required] The current substate of the MlApplicationInstance. The substate has MlApplicationInstance specific values in comparison with lifecycleState which has standard values common for all OCI resources. The NEEDS_ATTENTION and FAILED substates are deprecated in favor of (NON)?RECOVERABLE(PROVIDER|SERVICE)_ISSUE and will be removed in next release.

Returns:

  • (String) 


99
100
101
 
# File 'lib/oci/data_science/models/ml_application_instance.rb', line 99

def lifecycle_substate
  @lifecycle_substate
end

#ml_application_id ⇒ String

[Required] The OCID of ML Application. This resource is an instance of ML Application referenced by this OCID.

Returns:

  • (String) 


51
52
53
 
# File 'lib/oci/data_science/models/ml_application_instance.rb', line 51

def ml_application_id
  @ml_application_id
end

#ml_application_implementation_id ⇒ String

[Required] The OCID of ML Application Implementation selected as a certain solution for a given ML problem (ML Application)

Returns:

  • (String) 


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

def ml_application_implementation_id
  @ml_application_implementation_id
end

#ml_application_implementation_name ⇒ String

[Required] The name of Ml Application Implementation (based on mlApplicationImplementationId)

Returns:

  • (String) 


63
64
65
 
# File 'lib/oci/data_science/models/ml_application_instance.rb', line 63

def ml_application_implementation_name
  @ml_application_implementation_name
end

#ml_application_name ⇒ String

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

Returns:

  • (String) 


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

def ml_application_name
  @ml_application_name
end

#prediction_endpoint_details ⇒ OCI::DataScience::Models::PredictionEndpointDetails

Returns:



81
82
83
 
# File 'lib/oci/data_science/models/ml_application_instance.rb', line 81

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


121
122
123
 
# File 'lib/oci/data_science/models/ml_application_instance.rb', line 121

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

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

Returns:

  • (DateTime) 


85
86
87
 
# File 'lib/oci/data_science/models/ml_application_instance.rb', line 85

def time_created
  @time_created
end

#time_updated ⇒ DateTime

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

Returns:

  • (DateTime) 


89
90
91
 
# File 'lib/oci/data_science/models/ml_application_instance.rb', line 89

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

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



124
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/ml_application_instance.rb', line 124

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'display_name': :'displayName',
    'ml_application_id': :'mlApplicationId',
    'ml_application_name': :'mlApplicationName',
    'ml_application_implementation_id': :'mlApplicationImplementationId',
    'ml_application_implementation_name': :'mlApplicationImplementationName',
    'auth_configuration': :'authConfiguration',
    'configuration': :'configuration',
    'is_enabled': :'isEnabled',
    'compartment_id': :'compartmentId',
    'prediction_endpoint_details': :'predictionEndpointDetails',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_substate': :'lifecycleSubstate',
    'lifecycle_details': :'lifecycleDetails',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'display_name': :'String',
    'ml_application_id': :'String',
    'ml_application_name': :'String',
    'ml_application_implementation_id': :'String',
    'ml_application_implementation_name': :'String',
    'auth_configuration': :'OCI::DataScience::Models::AuthConfiguration',
    'configuration': :'Array<OCI::DataScience::Models::ConfigurationProperty>',
    'is_enabled': :'BOOLEAN',
    'compartment_id': :'String',
    'prediction_endpoint_details': :'OCI::DataScience::Models::PredictionEndpointDetails',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'lifecycle_state': :'String',
    'lifecycle_substate': :'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



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/ml_application_instance.rb', line 348

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

  self.class == other.class &&
    id == other.id &&
    display_name == other.display_name &&
    ml_application_id == other.ml_application_id &&
    ml_application_name == other.ml_application_name &&
    ml_application_implementation_id == other.ml_application_implementation_id &&
    ml_application_implementation_name == other.ml_application_implementation_name &&
    auth_configuration == other.auth_configuration &&
    configuration == other.configuration &&
    is_enabled == other.is_enabled &&
    compartment_id == other.compartment_id &&
    prediction_endpoint_details == other.prediction_endpoint_details &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_substate == other.lifecycle_substate &&
    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



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/ml_application_instance.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/ml_application_instance.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/ml_application_instance.rb', line 385

def hash
  [id, display_name, ml_application_id, ml_application_name, ml_application_implementation_id, ml_application_implementation_name, auth_configuration, configuration, is_enabled, compartment_id, prediction_endpoint_details, time_created, time_updated, lifecycle_state, lifecycle_substate, 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



429
430
431
432
433
434
435
436
437
438
 
# File 'lib/oci/data_science/models/ml_application_instance.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/ml_application_instance.rb', line 423

def to_s
  to_hash.to_s
end