Class: OCI::AiAnomalyDetection::Models::Anomaly

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

Overview

An object to hold value information for each anomaly point

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Anomaly

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :signal_name (String) —

    The value to assign to the #signal_name property

  • :actual_value (Float) —

    The value to assign to the #actual_value property

  • :estimated_value (Float) —

    The value to assign to the #estimated_value property

  • :imputed_value (Float) —

    The value to assign to the #imputed_value property

  • :anomaly_score (Float) —

    The value to assign to the #anomaly_score property

[View source]

68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/oci/ai_anomaly_detection/models/anomaly.rb', line 68

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

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

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

  self.actual_value = attributes[:'actualValue'] if attributes[:'actualValue']

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

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

  self.estimated_value = attributes[:'estimatedValue'] if attributes[:'estimatedValue']

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

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

  self.imputed_value = attributes[:'imputedValue'] if attributes[:'imputedValue']

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

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

  self.anomaly_score = attributes[:'anomalyScore'] if attributes[:'anomalyScore']

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

  self.anomaly_score = attributes[:'anomaly_score'] if attributes[:'anomaly_score']
end

Instance Attribute Details

#actual_value ⇒ Float

[Required] The actual value for the anomaly point at given signal and timestamp/row

Returns:

  • (Float) 

17
18
19
 
# File 'lib/oci/ai_anomaly_detection/models/anomaly.rb', line 17

def actual_value
  @actual_value
end

#anomaly_score ⇒ Float

[Required] A significant score ranged from 0 to 1 to each anomaly point.

Returns:

  • (Float) 

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

def anomaly_score
  @anomaly_score
end

#estimated_value ⇒ Float

[Required] The estimated value for the anomaly point at given signal and timestamp/row

Returns:

  • (Float) 

21
22
23
 
# File 'lib/oci/ai_anomaly_detection/models/anomaly.rb', line 21

def estimated_value
  @estimated_value
end

#imputed_value ⇒ Float

The value imputed by an IDP step for missing values in origin data.

Returns:

  • (Float) 

25
26
27
 
# File 'lib/oci/ai_anomaly_detection/models/anomaly.rb', line 25

def imputed_value
  @imputed_value
end

#signal_name ⇒ String

[Required] Name of a signal where current anomaly point belongs to

Returns:

  • (String) 

13
14
15
 
# File 'lib/oci/ai_anomaly_detection/models/anomaly.rb', line 13

def signal_name
  @signal_name
end

Class Method Details

.attribute_map ⇒ Object

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

[View source]

32
33
34
35
36
37
38
39
40
41
42
 
# File 'lib/oci/ai_anomaly_detection/models/anomaly.rb', line 32

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'signal_name': :'signalName',
    'actual_value': :'actualValue',
    'estimated_value': :'estimatedValue',
    'imputed_value': :'imputedValue',
    'anomaly_score': :'anomalyScore'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.

[View source]

45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/oci/ai_anomaly_detection/models/anomaly.rb', line 45

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'signal_name': :'String',
    'actual_value': :'Float',
    'estimated_value': :'Float',
    'imputed_value': :'Float',
    'anomaly_score': :'Float'
    # 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

[View source]

112
113
114
115
116
117
118
119
120
121
 
# File 'lib/oci/ai_anomaly_detection/models/anomaly.rb', line 112

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

  self.class == other.class &&
    signal_name == other.signal_name &&
    actual_value == other.actual_value &&
    estimated_value == other.estimated_value &&
    imputed_value == other.imputed_value &&
    anomaly_score == other.anomaly_score
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

[View source]

146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/oci/ai_anomaly_detection/models/anomaly.rb', line 146

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
[View source]

126
127
128
 
# File 'lib/oci/ai_anomaly_detection/models/anomaly.rb', line 126

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code

[View source]

135
136
137
 
# File 'lib/oci/ai_anomaly_detection/models/anomaly.rb', line 135

def hash
  [signal_name, actual_value, estimated_value, imputed_value, anomaly_score].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash

[View source]

179
180
181
182
183
184
185
186
187
188
 
# File 'lib/oci/ai_anomaly_detection/models/anomaly.rb', line 179

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

[View source]

173
174
175
 
# File 'lib/oci/ai_anomaly_detection/models/anomaly.rb', line 173

def to_s
  to_hash.to_s
end