Class: DatadogAPIClient::V2::SecurityMonitoringRuleUpdatePayload

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

Overview

Update an existing rule.

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_update_payload.rb', line 23

def _unparsed
  @_unparsed
end

#cases ⇒ Object

Cases for generating signals.



26
27
28
 
# File 'lib/datadog_api_client/v2/models/security_monitoring_rule_update_payload.rb', line 26

def cases
  @cases
end

#compliance_signal_options ⇒ Object

How to generate compliance signals. Useful for cloud_configuration rules only.



28
29
30
 
# File 'lib/datadog_api_client/v2/models/security_monitoring_rule_update_payload.rb', line 28

def compliance_signal_options
  @compliance_signal_options
end

#filters ⇒ Object

Additional queries to filter matched events before they are processed. This field is deprecated for log detection, signal correlation, and workload security rules.



29
30
31
 
# File 'lib/datadog_api_client/v2/models/security_monitoring_rule_update_payload.rb', line 29

def filters
  @filters
end

#has_extended_title ⇒ Object

Whether the notifications include the triggering group-by values in their title.



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

def has_extended_title
  @has_extended_title
end

#is_enabled ⇒ Object

Whether the rule is enabled.



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

def is_enabled
  @is_enabled
end

#message ⇒ Object

Message for generated signals.



38
39
40
 
# File 'lib/datadog_api_client/v2/models/security_monitoring_rule_update_payload.rb', line 38

def message
  @message
end

#name ⇒ Object

Name of the rule.



41
42
43
 
# File 'lib/datadog_api_client/v2/models/security_monitoring_rule_update_payload.rb', line 41

def name
  @name
end

#options ⇒ Object

Options on rules.



46
47
48
 
# File 'lib/datadog_api_client/v2/models/security_monitoring_rule_update_payload.rb', line 46

def options
  @options
end

#queries ⇒ Object

Queries for selecting logs which are part of the rule.



46
47
48
 
# File 'lib/datadog_api_client/v2/models/security_monitoring_rule_update_payload.rb', line 46

def queries
  @queries
end

#tags ⇒ Object

Tags for generated signals.



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

def tags
  @tags
end

#third_party_cases ⇒ Object

Cases for generating signals from third party rules. Only available for third party rules.



55
56
57
 
# File 'lib/datadog_api_client/v2/models/security_monitoring_rule_update_payload.rb', line 55

def third_party_cases
  @third_party_cases
end

#version ⇒ Object

The version of the rule being updated.



52
53
54
 
# File 'lib/datadog_api_client/v2/models/security_monitoring_rule_update_payload.rb', line 52

def version
  @version
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



71
72
73
 
# File 'lib/datadog_api_client/v2/models/security_monitoring_rule_update_payload.rb', line 71

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



221
222
223
 
# File 'lib/datadog_api_client/v2/models/security_monitoring_rule_update_payload.rb', line 221

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



92
93
94
95
 
# File 'lib/datadog_api_client/v2/models/security_monitoring_rule_update_payload.rb', line 92

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



251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
 
# File 'lib/datadog_api_client/v2/models/security_monitoring_rule_update_payload.rb', line 251

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



329
330
331
332
333
334
335
336
337
338
339
340
341
 
# File 'lib/datadog_api_client/v2/models/security_monitoring_rule_update_payload.rb', line 329

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



228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
 
# File 'lib/datadog_api_client/v2/models/security_monitoring_rule_update_payload.rb', line 228

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


208
209
210
 
# File 'lib/datadog_api_client/v2/models/security_monitoring_rule_update_payload.rb', line 208

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



163
164
165
166
167
168
169
170
 
# File 'lib/datadog_api_client/v2/models/security_monitoring_rule_update_payload.rb', line 163

def list_invalid_properties
  invalid_properties = Array.new
  if !@version.nil? && @version > 2147483647
    invalid_properties.push('invalid value for "version", must be smaller than or equal to 2147483647.')
  end

  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



305
306
307
 
# File 'lib/datadog_api_client/v2/models/security_monitoring_rule_update_payload.rb', line 305

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



311
312
313
314
315
316
317
318
319
320
321
322
323
 
# File 'lib/datadog_api_client/v2/models/security_monitoring_rule_update_payload.rb', line 311

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    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



299
300
301
 
# File 'lib/datadog_api_client/v2/models/security_monitoring_rule_update_payload.rb', line 299

def to_s
  to_hash.to_s
end