Class: OCI::AiAnomalyDetection::Models::ModelSummary

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/ai_anomaly_detection/models/model_summary.rb

Overview

Summary of the Model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ModelSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
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
# File 'lib/oci/ai_anomaly_detection/models/model_summary.rb', line 122

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

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

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

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

  self.model_training_results = attributes[:'modelTrainingResults'] if attributes[:'modelTrainingResults']

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

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

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

#compartment_idString

[Required] The OCID for the model's compartment.

Returns:

  • (String)


26
27
28
# File 'lib/oci/ai_anomaly_detection/models/model_summary.rb', line 26

def compartment_id
  @compartment_id
end

#defined_tagsHash<String, Hash<String, Object>>

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {\"foo-namespace\": {\"bar-key\": \"value\"}}

Returns:

  • (Hash<String, Hash<String, Object>>)


56
57
58
# File 'lib/oci/ai_anomaly_detection/models/model_summary.rb', line 56

def defined_tags
  @defined_tags
end

#descriptionString

A short description of the Model.

Returns:

  • (String)


22
23
24
# File 'lib/oci/ai_anomaly_detection/models/model_summary.rb', line 22

def description
  @description
end

#display_nameString

[Required] A user-friendly display name for the resource. It does not have to be unique and can be modified. Avoid entering confidential information.

Returns:

  • (String)


18
19
20
# File 'lib/oci/ai_anomaly_detection/models/model_summary.rb', line 18

def display_name
  @display_name
end

#freeform_tagsHash<String, String>

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {\"bar-key\": \"value\"}

Returns:

  • (Hash<String, String>)


50
51
52
# File 'lib/oci/ai_anomaly_detection/models/model_summary.rb', line 50

def freeform_tags
  @freeform_tags
end

#idString

[Required] The OCID of the model.

Returns:

  • (String)


14
15
16
# File 'lib/oci/ai_anomaly_detection/models/model_summary.rb', line 14

def id
  @id
end

#lifecycle_stateString

[Required] The state of the model.

Returns:

  • (String)


40
41
42
# File 'lib/oci/ai_anomaly_detection/models/model_summary.rb', line 40

def lifecycle_state
  @lifecycle_state
end

#model_training_detailsOCI::AiAnomalyDetection::Models::ModelTrainingDetails



29
30
31
# File 'lib/oci/ai_anomaly_detection/models/model_summary.rb', line 29

def model_training_details
  @model_training_details
end

#model_training_resultsOCI::AiAnomalyDetection::Models::ModelTrainingResults



32
33
34
# File 'lib/oci/ai_anomaly_detection/models/model_summary.rb', line 32

def model_training_results
  @model_training_results
end

#project_idString

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

Returns:

  • (String)


44
45
46
# File 'lib/oci/ai_anomaly_detection/models/model_summary.rb', line 44

def project_id
  @project_id
end

#system_tagsHash<String, Object>

Usage of system tag keys. These predefined keys are scoped to namespaces. Example: { \"orcl-cloud\": { \"free-tier-retained\": \"true\" } }

Returns:

  • (Hash<String, Object>)


62
63
64
# File 'lib/oci/ai_anomaly_detection/models/model_summary.rb', line 62

def system_tags
  @system_tags
end

#time_createdDateTime

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

Returns:

  • (DateTime)


36
37
38
# File 'lib/oci/ai_anomaly_detection/models/model_summary.rb', line 36

def time_created
  @time_created
end

Class Method Details

.attribute_mapObject

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'display_name': :'displayName',
    'description': :'description',
    'compartment_id': :'compartmentId',
    'model_training_details': :'modelTrainingDetails',
    'model_training_results': :'modelTrainingResults',
    'time_created': :'timeCreated',
    'lifecycle_state': :'lifecycleState',
    'project_id': :'projectId',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'display_name': :'String',
    'description': :'String',
    'compartment_id': :'String',
    'model_training_details': :'OCI::AiAnomalyDetection::Models::ModelTrainingDetails',
    'model_training_results': :'OCI::AiAnomalyDetection::Models::ModelTrainingResults',
    'time_created': :'DateTime',
    'lifecycle_state': :'String',
    'project_id': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'system_tags': :'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



200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
# File 'lib/oci/ai_anomaly_detection/models/model_summary.rb', line 200

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

  self.class == other.class &&
    id == other.id &&
    display_name == other.display_name &&
    description == other.description &&
    compartment_id == other.compartment_id &&
    model_training_details == other.model_training_details &&
    model_training_results == other.model_training_results &&
    time_created == other.time_created &&
    lifecycle_state == other.lifecycle_state &&
    project_id == other.project_id &&
    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



241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
# File 'lib/oci/ai_anomaly_detection/models/model_summary.rb', line 241

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


221
222
223
# File 'lib/oci/ai_anomaly_detection/models/model_summary.rb', line 221

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



230
231
232
# File 'lib/oci/ai_anomaly_detection/models/model_summary.rb', line 230

def hash
  [id, display_name, description, compartment_id, model_training_details, model_training_results, time_created, lifecycle_state, project_id, freeform_tags, defined_tags, system_tags].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



274
275
276
277
278
279
280
281
282
283
# File 'lib/oci/ai_anomaly_detection/models/model_summary.rb', line 274

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



268
269
270
# File 'lib/oci/ai_anomaly_detection/models/model_summary.rb', line 268

def to_s
  to_hash.to_s
end