class DatadogAPIClient::V2::SecurityMonitoringRuleUpdatePayload

Update an existing rule.

Attributes

cases[RW]

Cases for generating signals.

filters[RW]

Additional queries to filter matched events before they are processed.

has_extended_title[RW]

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

is_enabled[RW]

Whether the rule is enabled.

message[RW]

Message for generated signals.

name[RW]

Name of the rule.

options[RW]
queries[RW]

Queries for selecting logs which are part of the rule.

tags[RW]

Tags for generated signals.

version[RW]

The version of the rule being updated.

Public Class Methods

acceptable_attributes() click to toggle source

Returns all the JSON keys this model knows about

# File lib/datadog_api_client/v2/models/security_monitoring_rule_update_payload.rb, line 68
def self.acceptable_attributes
  attribute_map.values
end
attribute_map() click to toggle source

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

# File lib/datadog_api_client/v2/models/security_monitoring_rule_update_payload.rb, line 52
def self.attribute_map
  {
    :'cases' => :'cases',
    :'filters' => :'filters',
    :'has_extended_title' => :'hasExtendedTitle',
    :'is_enabled' => :'isEnabled',
    :'message' => :'message',
    :'name' => :'name',
    :'options' => :'options',
    :'queries' => :'queries',
    :'tags' => :'tags',
    :'version' => :'version'
  }
end
build_from_hash(attributes) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/datadog_api_client/v2/models/security_monitoring_rule_update_payload.rb, line 218
def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/datadog_api_client/v2/models/security_monitoring_rule_update_payload.rb, line 96
def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `DatadogAPIClient::V2::SecurityMonitoringRuleUpdatePayload` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `DatadogAPIClient::V2::SecurityMonitoringRuleUpdatePayload`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'cases')
    if (value = attributes[:'cases']).is_a?(Array)
      self.cases = value
    end
  end

  if attributes.key?(:'filters')
    if (value = attributes[:'filters']).is_a?(Array)
      self.filters = value
    end
  end

  if attributes.key?(:'has_extended_title')
    self.has_extended_title = attributes[:'has_extended_title']
  end

  if attributes.key?(:'is_enabled')
    self.is_enabled = attributes[:'is_enabled']
  end

  if attributes.key?(:'message')
    self.message = attributes[:'message']
  end

  if attributes.key?(:'name')
    self.name = attributes[:'name']
  end

  if attributes.key?(:'options')
    self.options = attributes[:'options']
  end

  if attributes.key?(:'queries')
    if (value = attributes[:'queries']).is_a?(Array)
      self.queries = value
    end
  end

  if attributes.key?(:'tags')
    if (value = attributes[:'tags']).is_a?(Array)
      self.tags = value
    end
  end

  if attributes.key?(:'version')
    self.version = attributes[:'version']
  end
end
openapi_nullable() click to toggle source

List of attributes with nullable: true

# File lib/datadog_api_client/v2/models/security_monitoring_rule_update_payload.rb, line 89
def self.openapi_nullable
  Set.new([
  ])
end
openapi_types() click to toggle source

Attribute type mapping.

# File lib/datadog_api_client/v2/models/security_monitoring_rule_update_payload.rb, line 73
def self.openapi_types
  {
    :'cases' => :'Array<SecurityMonitoringRuleCase>',
    :'filters' => :'Array<SecurityMonitoringFilter>',
    :'has_extended_title' => :'Boolean',
    :'is_enabled' => :'Boolean',
    :'message' => :'String',
    :'name' => :'String',
    :'options' => :'SecurityMonitoringRuleOptions',
    :'queries' => :'Array<SecurityMonitoringRuleQuery>',
    :'tags' => :'Array<String>',
    :'version' => :'Integer'
  }
end

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/datadog_api_client/v2/models/security_monitoring_rule_update_payload.rb, line 188
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      cases == o.cases &&
      filters == o.filters &&
      has_extended_title == o.has_extended_title &&
      is_enabled == o.is_enabled &&
      message == o.message &&
      name == o.name &&
      options == o.options &&
      queries == o.queries &&
      tags == o.tags &&
      version == o.version
end
_deserialize(type, value) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# File lib/datadog_api_client/v2/models/security_monitoring_rule_update_payload.rb, line 248
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)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end
_to_hash(value) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# File lib/datadog_api_client/v2/models/security_monitoring_rule_update_payload.rb, line 322
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) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/datadog_api_client/v2/models/security_monitoring_rule_update_payload.rb, line 225
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) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/datadog_api_client/v2/models/security_monitoring_rule_update_payload.rb, line 205
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Integer] Hash code

# File lib/datadog_api_client/v2/models/security_monitoring_rule_update_payload.rb, line 211
def hash
  [cases, filters, has_extended_title, is_enabled, message, name, options, queries, tags, version].hash
end
list_invalid_properties() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

# File lib/datadog_api_client/v2/models/security_monitoring_rule_update_payload.rb, line 160
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() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/datadog_api_client/v2/models/security_monitoring_rule_update_payload.rb, line 298
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/datadog_api_client/v2/models/security_monitoring_rule_update_payload.rb, line 304
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() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/datadog_api_client/v2/models/security_monitoring_rule_update_payload.rb, line 292
def to_s
  to_hash.to_s
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# File lib/datadog_api_client/v2/models/security_monitoring_rule_update_payload.rb, line 171
def valid?
  return false if !@version.nil? && @version > 2147483647
  true
end
version=(version) click to toggle source

Custom attribute writer method with validation @param [Object] version Value to be assigned

# File lib/datadog_api_client/v2/models/security_monitoring_rule_update_payload.rb, line 178
def version=(version)
  if !version.nil? && version > 2147483647
    fail ArgumentError, 'invalid value for "version", must be smaller than or equal to 2147483647.'
  end

  @version = version
end