Class: OCI::Waas::Models::ThreatFeed

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

Overview

The settings of the threat intelligence feed. You can block requests from IP addresses based on their reputations with various commercial and open source threat feeds.

Constant Summary collapse

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ThreatFeed

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

  • :name (String)

    The value to assign to the #name property

  • :action (String)

    The value to assign to the #action property

  • :description (String)

    The value to assign to the #description property



68
69
70
71
72
73
74
75
76
77
78
79
80
81
# File 'lib/oci/waas/models/threat_feed.rb', line 68

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

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

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

Instance Attribute Details

#actionString

The action to take when traffic is flagged as malicious by data from the threat intelligence feed. If unspecified, defaults to OFF.

Returns:

  • (String)


28
29
30
# File 'lib/oci/waas/models/threat_feed.rb', line 28

def action
  @action
end

#descriptionString

The description of the threat intelligence feed.

Returns:

  • (String)


32
33
34
# File 'lib/oci/waas/models/threat_feed.rb', line 32

def description
  @description
end

#keyString

The unique key of the threat intelligence feed.

Returns:

  • (String)


20
21
22
# File 'lib/oci/waas/models/threat_feed.rb', line 20

def key
  @key
end

#nameString

The name of the threat intelligence feed.

Returns:

  • (String)


24
25
26
# File 'lib/oci/waas/models/threat_feed.rb', line 24

def name
  @name
end

Class Method Details

.attribute_mapObject

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



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

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

.swagger_typesObject

Attribute type mapping.



47
48
49
50
51
52
53
54
55
56
# File 'lib/oci/waas/models/threat_feed.rb', line 47

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



103
104
105
106
107
108
109
110
111
# File 'lib/oci/waas/models/threat_feed.rb', line 103

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

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



136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
# File 'lib/oci/waas/models/threat_feed.rb', line 136

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


116
117
118
# File 'lib/oci/waas/models/threat_feed.rb', line 116

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



125
126
127
# File 'lib/oci/waas/models/threat_feed.rb', line 125

def hash
  [key, name, action, description].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



169
170
171
172
173
174
175
176
177
178
# File 'lib/oci/waas/models/threat_feed.rb', line 169

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



163
164
165
# File 'lib/oci/waas/models/threat_feed.rb', line 163

def to_s
  to_hash.to_s
end