Class: DatadogAPIClient::V2::SecurityMonitoringRuleOptions

Inherits:
Object
  • Object
show all
Includes:
BaseGenericModel
Defined in:
lib/datadog_api_client/v2/models/security_monitoring_rule_options.rb

Overview

Options on rules.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from BaseGenericModel

included

Instance Attribute Details

#_unparsed ⇒ Object

whether the object has unparsed attributes



23
24
25
 
# File 'lib/datadog_api_client/v2/models/security_monitoring_rule_options.rb', line 23

def _unparsed
  @_unparsed
end

#additional_properties ⇒ Object

Returns the value of attribute additional_properties.



61
62
63
 
# File 'lib/datadog_api_client/v2/models/security_monitoring_rule_options.rb', line 61

def additional_properties
  @additional_properties
end

#compliance_rule_options ⇒ Object

Options for cloud_configuration rules. Fields resourceType and regoRule are mandatory when managing custom cloud_configuration rules.



27
28
29
 
# File 'lib/datadog_api_client/v2/models/security_monitoring_rule_options.rb', line 27

def compliance_rule_options
  @compliance_rule_options
end

#decrease_criticality_based_on_env ⇒ Object

If true, signals in non-production environments have a lower severity than what is defined by the rule case, which can reduce signal noise. The severity is decreased by one level: CRITICAL in production becomes HIGH in non-production, HIGH becomes MEDIUM and so on. INFO remains INFO. The decrement is applied when the environment tag of the signal starts with staging, test or dev.



32
33
34
 
# File 'lib/datadog_api_client/v2/models/security_monitoring_rule_options.rb', line 32

def decrease_criticality_based_on_env
  @decrease_criticality_based_on_env
end

#detection_method ⇒ Object

The detection method.



35
36
37
 
# File 'lib/datadog_api_client/v2/models/security_monitoring_rule_options.rb', line 35

def detection_method
  @detection_method
end

#evaluation_window ⇒ Object

A time window is specified to match when at least one of the cases matches true. This is a sliding window and evaluates in real time. For third party rules, this field is not used.



39
40
41
 
# File 'lib/datadog_api_client/v2/models/security_monitoring_rule_options.rb', line 39

def evaluation_window
  @evaluation_window
end

#hardcoded_evaluator_type ⇒ Object

Hardcoded evaluator type.



42
43
44
 
# File 'lib/datadog_api_client/v2/models/security_monitoring_rule_options.rb', line 42

def hardcoded_evaluator_type
  @hardcoded_evaluator_type
end

#impossible_travel_options ⇒ Object

Options on impossible travel rules.



45
46
47
 
# File 'lib/datadog_api_client/v2/models/security_monitoring_rule_options.rb', line 45

def impossible_travel_options
  @impossible_travel_options
end

#keep_alive ⇒ Object

Once a signal is generated, the signal will remain “open” if a case is matched at least once within this keep alive window. For third party rules, this field is not used.



49
50
51
 
# File 'lib/datadog_api_client/v2/models/security_monitoring_rule_options.rb', line 49

def keep_alive
  @keep_alive
end

#max_signal_duration ⇒ Object

A signal will “close” regardless of the query being matched once the time exceeds the maximum duration. This time is calculated from the first seen timestamp.



53
54
55
 
# File 'lib/datadog_api_client/v2/models/security_monitoring_rule_options.rb', line 53

def max_signal_duration
  @max_signal_duration
end

#new_value_options ⇒ Object

Options on new value rules.



56
57
58
 
# File 'lib/datadog_api_client/v2/models/security_monitoring_rule_options.rb', line 56

def new_value_options
  @new_value_options
end

#third_party_rule_options ⇒ Object

Options on third party rules.



59
60
61
 
# File 'lib/datadog_api_client/v2/models/security_monitoring_rule_options.rb', line 59

def third_party_rule_options
  @third_party_rule_options
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



47
48
49
 
# File 'lib/datadog_api_client/v2/models/security_monitoring_rule_options.rb', line 47

def self.acceptable_attributes
  attribute_map.values
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



144
145
146
 
# File 'lib/datadog_api_client/v2/models/security_monitoring_rule_options.rb', line 144

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



63
64
65
66
 
# File 'lib/datadog_api_client/v2/models/security_monitoring_rule_options.rb', line 63

def self.openapi_nullable
  Set.new([
  ])
end

Instance Method Details

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
 
# File 'lib/datadog_api_client/v2/models/security_monitoring_rule_options.rb', line 174

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :Boolean
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when :Array
    # generic array, return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    # models (e.g. Pet) or oneOf
    klass = DatadogAPIClient::V2.const_get(type)
    res = klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
    if res.instance_of? DatadogAPIClient::V2::UnparsedObject
      self._unparsed = true
    end
    res
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'lib/datadog_api_client/v2/models/security_monitoring_rule_options.rb', line 252

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
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



151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/datadog_api_client/v2/models/security_monitoring_rule_options.rb', line 151

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


131
132
133
 
# File 'lib/datadog_api_client/v2/models/security_monitoring_rule_options.rb', line 131

def eql?(o)
  self == o
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



106
107
108
109
 
# File 'lib/datadog_api_client/v2/models/security_monitoring_rule_options.rb', line 106

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



228
229
230
 
# File 'lib/datadog_api_client/v2/models/security_monitoring_rule_options.rb', line 228

def to_body
  to_hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



222
223
224
 
# File 'lib/datadog_api_client/v2/models/security_monitoring_rule_options.rb', line 222

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



113
114
115
 
# File 'lib/datadog_api_client/v2/models/security_monitoring_rule_options.rb', line 113

def valid?
  true
end