Class: OCI::AiAnomalyDetection::Models::PerSignalDetails

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

Overview

Detailed information like statistics, metrics and status for a signal

Constant Summary collapse

STATUS_ENUM = 
[
  STATUS_ACCEPTED = 'ACCEPTED'.freeze,
  STATUS_DROPPED = 'DROPPED'.freeze,
  STATUS_OTHER = 'OTHER'.freeze,
  STATUS_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PerSignalDetails

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

  • :mvi_ratio (Float) —

    The value to assign to the #mvi_ratio property

  • :is_quantized (BOOLEAN) —

    The value to assign to the #is_quantized property

  • :fap (Float) —

    The value to assign to the #fap property

  • :min (Float) —

    The value to assign to the #min property

  • :max (Float) —

    The value to assign to the #max property

  • :std (Float) —

    The value to assign to the #std property

  • :status (String) —

    The value to assign to the #status property

  • :details (String) —

    The value to assign to the #details property



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

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

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

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

  self.is_quantized = attributes[:'isQuantized'] unless attributes[:'isQuantized'].nil?

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

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

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

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

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

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

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

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

Instance Attribute Details

#details ⇒ String

detailed information for a signal.

Returns:

  • (String) 


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

def details
  @details
end

#fap ⇒ Float

Accuracy metric for a signal.

Returns:

  • (Float) 


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

def fap
  @fap
end

#is_quantized ⇒ BOOLEAN

A boolean value to indicate if a signal is quantized or not.

Returns:

  • (BOOLEAN) 


28
29
30
 
# File 'lib/oci/ai_anomaly_detection/models/per_signal_details.rb', line 28

def is_quantized
  @is_quantized
end

#max ⇒ Float

**[Required]** Max value within a signal.

Returns:

  • (Float) 


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

def max
  @max
end

#min ⇒ Float

**[Required]** Min value within a signal.

Returns:

  • (Float) 


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

def min
  @min
end

#mvi_ratio ⇒ Float

The ratio of missing values in a signal filled/imputed by the IDP algorithm.

Returns:

  • (Float) 


24
25
26
 
# File 'lib/oci/ai_anomaly_detection/models/per_signal_details.rb', line 24

def mvi_ratio
  @mvi_ratio
end

#signal_name ⇒ String

**[Required]** The name of a signal.

Returns:

  • (String) 


20
21
22
 
# File 'lib/oci/ai_anomaly_detection/models/per_signal_details.rb', line 20

def signal_name
  @signal_name
end

#status ⇒ String

**[Required]** Status of the signal:

* ACCEPTED - the signal is used for training the model
* DROPPED - the signal does not meet requirement, and is dropped before training the model.
* OTHER - placeholder for other status

Returns:

  • (String) 


52
53
54
 
# File 'lib/oci/ai_anomaly_detection/models/per_signal_details.rb', line 52

def status
  @status
end

#std ⇒ Float

**[Required]** Standard deviation of values within a signal.

Returns:

  • (Float) 


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

def std
  @std
end

Class Method Details

.attribute_map ⇒ Object

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



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/oci/ai_anomaly_detection/models/per_signal_details.rb', line 59

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'signal_name': :'signalName',
    'mvi_ratio': :'mviRatio',
    'is_quantized': :'isQuantized',
    'fap': :'fap',
    'min': :'min',
    'max': :'max',
    'std': :'std',
    'status': :'status',
    'details': :'details'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/oci/ai_anomaly_detection/models/per_signal_details.rb', line 76

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'signal_name': :'String',
    'mvi_ratio': :'Float',
    'is_quantized': :'BOOLEAN',
    'fap': :'Float',
    'min': :'Float',
    'max': :'Float',
    'std': :'Float',
    'status': :'String',
    'details': :'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



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

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

  self.class == other.class &&
    signal_name == other.signal_name &&
    mvi_ratio == other.mvi_ratio &&
    is_quantized == other.is_quantized &&
    fap == other.fap &&
    min == other.min &&
    max == other.max &&
    std == other.std &&
    status == other.status &&
    details == other.details
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



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

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


182
183
184
 
# File 'lib/oci/ai_anomaly_detection/models/per_signal_details.rb', line 182

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



191
192
193
 
# File 'lib/oci/ai_anomaly_detection/models/per_signal_details.rb', line 191

def hash
  [signal_name, mvi_ratio, is_quantized, fap, min, max, std, status, details].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



235
236
237
238
239
240
241
242
243
244
 
# File 'lib/oci/ai_anomaly_detection/models/per_signal_details.rb', line 235

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



229
230
231
 
# File 'lib/oci/ai_anomaly_detection/models/per_signal_details.rb', line 229

def to_s
  to_hash.to_s
end