Class: OCI::DataScience::Models::CreateModelDetails

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

Overview

Parameters needed to create a new model. Models are mathematical representations of the relationships between data. Models are represented by their associated metadata and artifact.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateModelDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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

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

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

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

  self.defined_metadata_list = attributes[:'definedMetadataList'] if attributes[:'definedMetadataList']

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

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

  self.input_schema = attributes[:'inputSchema'] if attributes[:'inputSchema']

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

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

  self.output_schema = attributes[:'outputSchema'] if attributes[:'outputSchema']

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

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

  self.model_version_set_id = attributes[:'modelVersionSetId'] if attributes[:'modelVersionSetId']

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

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

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

Instance Attribute Details

#compartment_id ⇒ String

[Required] The OCID of the compartment to create the model in.

Returns:

  • (String) 


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

def compartment_id
  @compartment_id
end

#custom_metadata_list ⇒ Array<OCI::DataScience::Models::Metadata>

An array of custom metadata details for the model.

Returns:



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

def custom_metadata_list
  @custom_metadata_list
end

#defined_metadata_list ⇒ Array<OCI::DataScience::Models::Metadata>

An array of defined metadata details for the model.

Returns:



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

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


39
40
41
 
# File 'lib/oci/data_science/models/create_model_details.rb', line 39

def defined_tags
  @defined_tags
end

#description ⇒ String

A short description of the model.

Returns:

  • (String) 


27
28
29
 
# File 'lib/oci/data_science/models/create_model_details.rb', line 27

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. Example: My Model

Returns:

  • (String) 


23
24
25
 
# File 'lib/oci/data_science/models/create_model_details.rb', line 23

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


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

def freeform_tags
  @freeform_tags
end

#input_schema ⇒ String

Input schema file content in String format

Returns:

  • (String) 


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

def input_schema
  @input_schema
end

#model_version_set_id ⇒ String

The OCID of the model version set that the model is associated to.

Returns:

  • (String) 


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

def model_version_set_id
  @model_version_set_id
end

#output_schema ⇒ String

Output schema file content in String format

Returns:

  • (String) 


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

def output_schema
  @output_schema
end

#project_id ⇒ String

[Required] The OCID of the project to associate with the model.

Returns:

  • (String) 


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

def project_id
  @project_id
end

#version_label ⇒ String

The version label can add an additional description of the lifecycle state of the model or the application using/training the model.

Returns:

  • (String) 


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

def version_label
  @version_label
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'compartmentId',
    'project_id': :'projectId',
    'display_name': :'displayName',
    'description': :'description',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'custom_metadata_list': :'customMetadataList',
    'defined_metadata_list': :'definedMetadataList',
    'input_schema': :'inputSchema',
    'output_schema': :'outputSchema',
    'model_version_set_id': :'modelVersionSetId',
    'version_label': :'versionLabel'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/oci/data_science/models/create_model_details.rb', line 86

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'String',
    'project_id': :'String',
    'display_name': :'String',
    'description': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'custom_metadata_list': :'Array<OCI::DataScience::Models::Metadata>',
    'defined_metadata_list': :'Array<OCI::DataScience::Models::Metadata>',
    'input_schema': :'String',
    'output_schema': :'String',
    'model_version_set_id': :'String',
    'version_label': :'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



205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
 
# File 'lib/oci/data_science/models/create_model_details.rb', line 205

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

  self.class == other.class &&
    compartment_id == other.compartment_id &&
    project_id == other.project_id &&
    display_name == other.display_name &&
    description == other.description &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    custom_metadata_list == other.custom_metadata_list &&
    defined_metadata_list == other.defined_metadata_list &&
    input_schema == other.input_schema &&
    output_schema == other.output_schema &&
    model_version_set_id == other.model_version_set_id &&
    version_label == other.version_label
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



246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
 
# File 'lib/oci/data_science/models/create_model_details.rb', line 246

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


226
227
228
 
# File 'lib/oci/data_science/models/create_model_details.rb', line 226

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



235
236
237
 
# File 'lib/oci/data_science/models/create_model_details.rb', line 235

def hash
  [compartment_id, project_id, display_name, description, freeform_tags, defined_tags, custom_metadata_list, defined_metadata_list, input_schema, output_schema, model_version_set_id, version_label].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



279
280
281
282
283
284
285
286
287
288
 
# File 'lib/oci/data_science/models/create_model_details.rb', line 279

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



273
274
275
 
# File 'lib/oci/data_science/models/create_model_details.rb', line 273

def to_s
  to_hash.to_s
end