Class: OCI::DataScience::Models::CreateMlApplicationInstanceDetails

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

Overview

The information about new MlApplicationInstance.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateMlApplicationInstanceDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



99
100
101
102
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
128
129
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
155
156
# File 'lib/oci/data_science/models/create_ml_application_instance_details.rb', line 99

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.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_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.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?
  self.is_enabled = true if is_enabled.nil? && !attributes.key?(:'isEnabled') # rubocop:disable Style/StringLiterals

  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.is_enabled = true if is_enabled.nil? && !attributes.key?(:'isEnabled') && !attributes.key?(:'is_enabled') # rubocop:disable Style/StringLiterals

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

Instance Attribute Details

#auth_configurationOCI::DataScience::Models::CreateAuthConfigurationDetails



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

def auth_configuration
  @auth_configuration
end

#compartment_idString

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

Returns:

  • (String)


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

def compartment_id
  @compartment_id
end

#configurationArray<OCI::DataScience::Models::ConfigurationProperty>

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



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

def configuration
  @configuration
end

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


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

def defined_tags
  @defined_tags
end

#display_nameString

The name of MlApplicationInstance. System will generate displayName when not provided.

Returns:

  • (String)


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

def display_name
  @display_name
end

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


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

def freeform_tags
  @freeform_tags
end

#is_enabledBOOLEAN

Defines whether the MlApplicationInstance will be created in ACTIVE (true value) or INACTIVE (false value) lifecycle state.

Returns:

  • (BOOLEAN)


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

def is_enabled
  @is_enabled
end

#ml_application_idString

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

Returns:

  • (String)


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

def ml_application_id
  @ml_application_id
end

#ml_application_implementation_idString

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

Returns:

  • (String)


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

def ml_application_implementation_id
  @ml_application_implementation_id
end

Class Method Details

.attribute_mapObject

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



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
# File 'lib/oci/data_science/models/create_ml_application_instance_details.rb', line 51

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'displayName',
    'ml_application_id': :'mlApplicationId',
    'ml_application_implementation_id': :'mlApplicationImplementationId',
    'auth_configuration': :'authConfiguration',
    'configuration': :'configuration',
    'is_enabled': :'isEnabled',
    'compartment_id': :'compartmentId',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
# File 'lib/oci/data_science/models/create_ml_application_instance_details.rb', line 68

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'String',
    'ml_application_id': :'String',
    'ml_application_implementation_id': :'String',
    'auth_configuration': :'OCI::DataScience::Models::CreateAuthConfigurationDetails',
    'configuration': :'Array<OCI::DataScience::Models::ConfigurationProperty>',
    'is_enabled': :'BOOLEAN',
    'compartment_id': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_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



165
166
167
168
169
170
171
172
173
174
175
176
177
178
# File 'lib/oci/data_science/models/create_ml_application_instance_details.rb', line 165

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

  self.class == other.class &&
    display_name == other.display_name &&
    ml_application_id == other.ml_application_id &&
    ml_application_implementation_id == other.ml_application_implementation_id &&
    auth_configuration == other.auth_configuration &&
    configuration == other.configuration &&
    is_enabled == other.is_enabled &&
    compartment_id == other.compartment_id &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_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



203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
# File 'lib/oci/data_science/models/create_ml_application_instance_details.rb', line 203

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


183
184
185
# File 'lib/oci/data_science/models/create_ml_application_instance_details.rb', line 183

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



192
193
194
# File 'lib/oci/data_science/models/create_ml_application_instance_details.rb', line 192

def hash
  [display_name, ml_application_id, ml_application_implementation_id, auth_configuration, configuration, is_enabled, compartment_id, freeform_tags, defined_tags].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



236
237
238
239
240
241
242
243
244
245
# File 'lib/oci/data_science/models/create_ml_application_instance_details.rb', line 236

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



230
231
232
# File 'lib/oci/data_science/models/create_ml_application_instance_details.rb', line 230

def to_s
  to_hash.to_s
end