Class: OCI::Waas::Models::Recommendation

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/waas/models/recommendation.rb

Overview

A recommended protection rule for a web application. This recommendation can be accepted to apply it to the Web Application Firewall configuration for this policy.

Use the POST /waasPolicies/{waasPolicyId}/actions/acceptWafConfigRecommendations method to accept recommended protection rules.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Recommendation

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :key (String)

    The value to assign to the #key property

  • :mod_security_rule_ids (Array<String>)

    The value to assign to the #mod_security_rule_ids property

  • :name (String)

    The value to assign to the #name property

  • :description (String)

    The value to assign to the #description property

  • :labels (Array<String>)

    The value to assign to the #labels property

  • :recommended_action (String)

    The value to assign to the #recommended_action property



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
# File 'lib/oci/waas/models/recommendation.rb', line 77

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

  self.mod_security_rule_ids = attributes[:'modSecurityRuleIds'] if attributes[:'modSecurityRuleIds']

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

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

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

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

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

  self.recommended_action = attributes[:'recommendedAction'] if attributes[:'recommendedAction']

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

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

Instance Attribute Details

#descriptionString

The description of the recommended protection rule.

Returns:

  • (String)


27
28
29
# File 'lib/oci/waas/models/recommendation.rb', line 27

def description
  @description
end

#keyString

The unique key for the recommended protection rule.

Returns:

  • (String)


14
15
16
# File 'lib/oci/waas/models/recommendation.rb', line 14

def key
  @key
end

#labelsArray<String>

The list of labels for the recommended protection rule.

Returns:

  • (Array<String>)


31
32
33
# File 'lib/oci/waas/models/recommendation.rb', line 31

def labels
  @labels
end

#mod_security_rule_idsArray<String>

The list of the ModSecurity rule IDs associated with the protection rule. For more information about ModSecurity's open source WAF rules, see Mod Security’s documentation.

Returns:

  • (Array<String>)


19
20
21
# File 'lib/oci/waas/models/recommendation.rb', line 19

def mod_security_rule_ids
  @mod_security_rule_ids
end

#nameString

The name of the recommended protection rule.

Returns:

  • (String)


23
24
25
# File 'lib/oci/waas/models/recommendation.rb', line 23

def name
  @name
end

The recommended action to apply to the protection rule.

Returns:

  • (String)


35
36
37
# File 'lib/oci/waas/models/recommendation.rb', line 35

def recommended_action
  @recommended_action
end

Class Method Details

.attribute_mapObject

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



38
39
40
41
42
43
44
45
46
47
48
49
# File 'lib/oci/waas/models/recommendation.rb', line 38

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'key': :'key',
    'mod_security_rule_ids': :'modSecurityRuleIds',
    'name': :'name',
    'description': :'description',
    'labels': :'labels',
    'recommended_action': :'recommendedAction'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



52
53
54
55
56
57
58
59
60
61
62
63
# File 'lib/oci/waas/models/recommendation.rb', line 52

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'key': :'String',
    'mod_security_rule_ids': :'Array<String>',
    'name': :'String',
    'description': :'String',
    'labels': :'Array<String>',
    'recommended_action': :'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



111
112
113
114
115
116
117
118
119
120
121
# File 'lib/oci/waas/models/recommendation.rb', line 111

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

  self.class == other.class &&
    key == other.key &&
    mod_security_rule_ids == other.mod_security_rule_ids &&
    name == other.name &&
    description == other.description &&
    labels == other.labels &&
    recommended_action == other.recommended_action
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



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

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


126
127
128
# File 'lib/oci/waas/models/recommendation.rb', line 126

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



135
136
137
# File 'lib/oci/waas/models/recommendation.rb', line 135

def hash
  [key, mod_security_rule_ids, name, description, labels, recommended_action].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



179
180
181
182
183
184
185
186
187
188
# File 'lib/oci/waas/models/recommendation.rb', line 179

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



173
174
175
# File 'lib/oci/waas/models/recommendation.rb', line 173

def to_s
  to_hash.to_s
end