Class: OCI::AiAnomalyDetection::Models::DetectAnomaliesDetails

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

Overview

Base class for the DetectAnomalies call. It contains the identifier that is used for deciding what type of request this is.

This class has direct subclasses. If you are using this class as input to a service operations then you should favor using a subclass over the base class

Constant Summary collapse

REQUEST_TYPE_ENUM = 
[
  REQUEST_TYPE_INLINE = 'INLINE'.freeze,
  REQUEST_TYPE_BASE64_ENCODED = 'BASE64_ENCODED'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DetectAnomaliesDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :model_id (String) —

    The value to assign to the #model_id property

  • :request_type (String) —

    The value to assign to the #request_type property

  • :sensitivity (Float) —

    The value to assign to the #sensitivity property



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/oci/ai_anomaly_detection/models/detect_anomalies_details.rb', line 80

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

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

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

  self.request_type = attributes[:'requestType'] if attributes[:'requestType']

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

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

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

Instance Attribute Details

#model_id ⇒ String

[Required] The OCID of the trained model.

Returns:

  • (String) 


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

def model_id
  @model_id
end

#request_type ⇒ String

[Required] Type of request. This parameter is automatically populated by classes generated by the SDK. For raw curl requests, you must provide this field.

Returns:

  • (String) 


27
28
29
 
# File 'lib/oci/ai_anomaly_detection/models/detect_anomalies_details.rb', line 27

def request_type
  @request_type
end

#sensitivity ⇒ Float

Sensitivity of the algorithm to detect anomalies - higher the value, more anomalies get flagged. The value estimated during training is used by default. You can choose to provide a custom value.

Returns:

  • (Float) 


31
32
33
 
# File 'lib/oci/ai_anomaly_detection/models/detect_anomalies_details.rb', line 31

def sensitivity
  @sensitivity
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'model_id': :'modelId',
    'request_type': :'requestType',
    'sensitivity': :'sensitivity'
    # rubocop:enable Style/SymbolLiteral
  }
end

.get_subtype(object_hash) ⇒ Object

Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.



60
61
62
63
64
65
66
67
68
 
# File 'lib/oci/ai_anomaly_detection/models/detect_anomalies_details.rb', line 60

def self.get_subtype(object_hash)
  type = object_hash[:'requestType'] # rubocop:disable Style/SymbolLiteral

  return 'OCI::AiAnomalyDetection::Models::InlineDetectAnomaliesRequest' if type == 'INLINE'
  return 'OCI::AiAnomalyDetection::Models::EmbeddedDetectAnomaliesRequest' if type == 'BASE64_ENCODED'

  # TODO: Log a warning when the subtype is not found.
  'OCI::AiAnomalyDetection::Models::DetectAnomaliesDetails'
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'model_id': :'String',
    'request_type': :'String',
    'sensitivity': :'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



116
117
118
119
120
121
122
123
 
# File 'lib/oci/ai_anomaly_detection/models/detect_anomalies_details.rb', line 116

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

  self.class == other.class &&
    model_id == other.model_id &&
    request_type == other.request_type &&
    sensitivity == other.sensitivity
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



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

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


128
129
130
 
# File 'lib/oci/ai_anomaly_detection/models/detect_anomalies_details.rb', line 128

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



137
138
139
 
# File 'lib/oci/ai_anomaly_detection/models/detect_anomalies_details.rb', line 137

def hash
  [model_id, request_type, sensitivity].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



181
182
183
184
185
186
187
188
189
190
 
# File 'lib/oci/ai_anomaly_detection/models/detect_anomalies_details.rb', line 181

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



175
176
177
 
# File 'lib/oci/ai_anomaly_detection/models/detect_anomalies_details.rb', line 175

def to_s
  to_hash.to_s
end