Class: OCI::Waas::Models::ThreatFeedAction

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

Overview

The action to take for a request that has been determined to be potentially malicious.

Constant Summary collapse

ACTION_ENUM =
[
  ACTION_OFF = 'OFF'.freeze,
  ACTION_DETECT = 'DETECT'.freeze,
  ACTION_BLOCK = 'BLOCK'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ThreatFeedAction

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

  • :action (String)

    The value to assign to the #action property



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

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

Instance Attribute Details

#actionString

[Required] The selected action. If unspecified, defaults to OFF.

Returns:

  • (String)


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

def action
  @action
end

#keyString

[Required] The unique key of the object for which the action applies.

Returns:

  • (String)


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

def key
  @key
end

Class Method Details

.attribute_mapObject

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



26
27
28
29
30
31
32
33
# File 'lib/oci/waas/models/threat_feed_action.rb', line 26

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'key': :'key',
    'action': :'action'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



36
37
38
39
40
41
42
43
# File 'lib/oci/waas/models/threat_feed_action.rb', line 36

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



79
80
81
82
83
84
85
# File 'lib/oci/waas/models/threat_feed_action.rb', line 79

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

  self.class == other.class &&
    key == other.key &&
    action == other.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



110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
# File 'lib/oci/waas/models/threat_feed_action.rb', line 110

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


90
91
92
# File 'lib/oci/waas/models/threat_feed_action.rb', line 90

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



99
100
101
# File 'lib/oci/waas/models/threat_feed_action.rb', line 99

def hash
  [key, action].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



143
144
145
146
147
148
149
150
151
152
# File 'lib/oci/waas/models/threat_feed_action.rb', line 143

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



137
138
139
# File 'lib/oci/waas/models/threat_feed_action.rb', line 137

def to_s
  to_hash.to_s
end