Class: OCI::Waas::Models::WafBlockedRequest

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

Overview

WafBlockedRequest model.

Constant Summary collapse

WAF_FEATURE_ENUM =

rubocop:disable Metrics/LineLength

[
  WAF_FEATURE_PROTECTION_RULES = 'PROTECTION_RULES'.freeze,
  WAF_FEATURE_JS_CHALLENGE = 'JS_CHALLENGE'.freeze,
  WAF_FEATURE_ACCESS_RULES = 'ACCESS_RULES'.freeze,
  WAF_FEATURE_THREAT_FEEDS = 'THREAT_FEEDS'.freeze,
  WAF_FEATURE_HUMAN_INTERACTION_CHALLENGE = 'HUMAN_INTERACTION_CHALLENGE'.freeze,
  WAF_FEATURE_DEVICE_FINGERPRINT_CHALLENGE = 'DEVICE_FINGERPRINT_CHALLENGE'.freeze,
  WAF_FEATURE_CAPTCHA = 'CAPTCHA'.freeze,
  WAF_FEATURE_ADDRESS_RATE_LIMITING = 'ADDRESS_RATE_LIMITING'.freeze,
  WAF_FEATURE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ WafBlockedRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :time_observed (DateTime) —

    The value to assign to the #time_observed property

  • :time_range_in_seconds (Integer) —

    The value to assign to the #time_range_in_seconds property

  • :waf_feature (String) —

    The value to assign to the #waf_feature property

  • :count (Integer) —

    The value to assign to the #count property



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/oci/waas/models/waf_blocked_request.rb', line 72

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

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

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

  self.time_range_in_seconds = attributes[:'timeRangeInSeconds'] if attributes[:'timeRangeInSeconds']

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

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

  self.waf_feature = attributes[:'wafFeature'] if attributes[:'wafFeature']

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

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

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

Instance Attribute Details

#count ⇒ Integer

The count of blocked requests.

Returns:

  • (Integer) 


36
37
38
 
# File 'lib/oci/waas/models/waf_blocked_request.rb', line 36

def count
  @count
end

#time_observed ⇒ DateTime

The date and time the blocked requests were observed, expressed in RFC 3339 timestamp format.

Returns:

  • (DateTime) 


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

def time_observed
  @time_observed
end

#time_range_in_seconds ⇒ Integer

The number of seconds the data covers.

Returns:

  • (Integer) 


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

def time_range_in_seconds
  @time_range_in_seconds
end

#waf_feature ⇒ String

The specific Web Application Firewall feature that blocked the requests, such as JavaScript Challenge or Access Control.

Returns:

  • (String) 


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

def waf_feature
  @waf_feature
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'time_observed': :'timeObserved',
    'time_range_in_seconds': :'timeRangeInSeconds',
    'waf_feature': :'wafFeature',
    'count': :'count'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



51
52
53
54
55
56
57
58
59
60
 
# File 'lib/oci/waas/models/waf_blocked_request.rb', line 51

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'time_observed': :'DateTime',
    'time_range_in_seconds': :'Integer',
    'waf_feature': :'String',
    'count': :'Integer'
    # 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



121
122
123
124
125
126
127
128
129
 
# File 'lib/oci/waas/models/waf_blocked_request.rb', line 121

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

  self.class == other.class &&
    time_observed == other.time_observed &&
    time_range_in_seconds == other.time_range_in_seconds &&
    waf_feature == other.waf_feature &&
    count == other.count
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



154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
 
# File 'lib/oci/waas/models/waf_blocked_request.rb', line 154

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


134
135
136
 
# File 'lib/oci/waas/models/waf_blocked_request.rb', line 134

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



143
144
145
 
# File 'lib/oci/waas/models/waf_blocked_request.rb', line 143

def hash
  [time_observed, time_range_in_seconds, waf_feature, count].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



187
188
189
190
191
192
193
194
195
196
 
# File 'lib/oci/waas/models/waf_blocked_request.rb', line 187

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_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



181
182
183
 
# File 'lib/oci/waas/models/waf_blocked_request.rb', line 181

def to_s
  to_hash.to_s
end