Class: OCI::Waf::Models::WebAppFirewallPolicy

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/waf/models/web_app_firewall_policy.rb

Overview

The details of WebAppFirewallPolicy. A policy is comprised of rules, which allows executing inspections of incoming/outgoing HTTP message parameters and execution of actions, based on results of rules execution.

In policy, rules are grouped into modules by their functionality. Modules can be further divided by the type of HTTP messages they handle: Modules that inspect incoming HTTP request. These modules are executed in the order they are enumerated here: * requestAccessControl * requestRateLimiting * requestProtection

Modules that inspect outgoing HTTP responses. These modules are executed in the order they are enumerated here: * responseAccessControl * responseProtection

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze,
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_DELETING = 'DELETING'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_FAILED = 'FAILED'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ WebAppFirewallPolicy

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
 
# File 'lib/oci/waf/models/web_app_firewall_policy.rb', line 175

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

  self.display_name = attributes[:'displayName'] if attributes[:'displayName']

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

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

  self.compartment_id = attributes[:'compartmentId'] if attributes[:'compartmentId']

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

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

  self.time_created = attributes[:'timeCreated'] if attributes[:'timeCreated']

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

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

  self.time_updated = attributes[:'timeUpdated'] if attributes[:'timeUpdated']

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

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

  self.lifecycle_state = attributes[:'lifecycleState'] if attributes[:'lifecycleState']

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

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

  self.lifecycle_details = attributes[:'lifecycleDetails'] if attributes[:'lifecycleDetails']

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

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

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

  self.request_access_control = attributes[:'requestAccessControl'] if attributes[:'requestAccessControl']

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

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

  self.request_rate_limiting = attributes[:'requestRateLimiting'] if attributes[:'requestRateLimiting']

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

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

  self.request_protection = attributes[:'requestProtection'] if attributes[:'requestProtection']

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

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

  self.response_access_control = attributes[:'responseAccessControl'] if attributes[:'responseAccessControl']

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

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

  self.response_protection = attributes[:'responseProtection'] if attributes[:'responseProtection']

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

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

  self.freeform_tags = attributes[:'freeformTags'] if attributes[:'freeformTags']

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

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

  self.defined_tags = attributes[:'definedTags'] if attributes[:'definedTags']

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

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

  self.system_tags = attributes[:'systemTags'] if attributes[:'systemTags']

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

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

Instance Attribute Details

#actions ⇒ Array<OCI::Waf::Models::Action>

Predefined actions for use in multiple different rules. Not all actions are supported in every module. Some actions terminate further execution of modules and rules in a module and some do not. Actions names must be unique within this array.

Returns:



70
71
72
 
# File 'lib/oci/waf/models/web_app_firewall_policy.rb', line 70

def actions
  @actions
end

#compartment_id ⇒ String

[Required] The OCID of the compartment.

Returns:

  • (String) 


45
46
47
 
# File 'lib/oci/waf/models/web_app_firewall_policy.rb', line 45

def compartment_id
  @compartment_id
end

#defined_tags ⇒ Hash<String, Hash<String, Object>>

[Required] Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {\"foo-namespace\": {\"bar-key\": \"value\"}}

Returns:

  • (Hash<String, Hash<String, Object>>) 


97
98
99
 
# File 'lib/oci/waf/models/web_app_firewall_policy.rb', line 97

def defined_tags
  @defined_tags
end

#display_name ⇒ String

[Required] WebAppFirewallPolicy display name, can be renamed.

Returns:

  • (String) 


41
42
43
 
# File 'lib/oci/waf/models/web_app_firewall_policy.rb', line 41

def display_name
  @display_name
end

#freeform_tags ⇒ Hash<String, String>

[Required] Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {\"bar-key\": \"value\"}

Returns:

  • (Hash<String, String>) 


91
92
93
 
# File 'lib/oci/waf/models/web_app_firewall_policy.rb', line 91

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the WebAppFirewallPolicy.

Returns:

  • (String) 


37
38
39
 
# File 'lib/oci/waf/models/web_app_firewall_policy.rb', line 37

def id
  @id
end

#lifecycle_details ⇒ String

A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in FAILED state.

Returns:

  • (String) 


63
64
65
 
# File 'lib/oci/waf/models/web_app_firewall_policy.rb', line 63

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

[Required] The current state of the WebAppFirewallPolicy.

Returns:

  • (String) 


57
58
59
 
# File 'lib/oci/waf/models/web_app_firewall_policy.rb', line 57

def lifecycle_state
  @lifecycle_state
end

#request_access_control ⇒ OCI::Waf::Models::RequestAccessControl

Returns:



73
74
75
 
# File 'lib/oci/waf/models/web_app_firewall_policy.rb', line 73

def request_access_control
  @request_access_control
end

#request_protection ⇒ OCI::Waf::Models::RequestProtection

Returns:



79
80
81
 
# File 'lib/oci/waf/models/web_app_firewall_policy.rb', line 79

def request_protection
  @request_protection
end

#request_rate_limiting ⇒ OCI::Waf::Models::RequestRateLimiting

Returns:



76
77
78
 
# File 'lib/oci/waf/models/web_app_firewall_policy.rb', line 76

def request_rate_limiting
  @request_rate_limiting
end

#response_access_control ⇒ OCI::Waf::Models::ResponseAccessControl

Returns:



82
83
84
 
# File 'lib/oci/waf/models/web_app_firewall_policy.rb', line 82

def response_access_control
  @response_access_control
end

#response_protection ⇒ OCI::Waf::Models::ResponseProtection

Returns:



85
86
87
 
# File 'lib/oci/waf/models/web_app_firewall_policy.rb', line 85

def response_protection
  @response_protection
end

#system_tags ⇒ Hash<String, Hash<String, Object>>

[Required] Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}

Returns:

  • (Hash<String, Hash<String, Object>>) 


103
104
105
 
# File 'lib/oci/waf/models/web_app_firewall_policy.rb', line 103

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

[Required] The time the WebAppFirewallPolicy was created. An RFC3339 formatted datetime string.

Returns:

  • (DateTime) 


49
50
51
 
# File 'lib/oci/waf/models/web_app_firewall_policy.rb', line 49

def time_created
  @time_created
end

#time_updated ⇒ DateTime

The time the WebAppFirewallPolicy was updated. An RFC3339 formatted datetime string.

Returns:

  • (DateTime) 


53
54
55
 
# File 'lib/oci/waf/models/web_app_firewall_policy.rb', line 53

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

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



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/oci/waf/models/web_app_firewall_policy.rb', line 106

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'display_name': :'displayName',
    'compartment_id': :'compartmentId',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails',
    'actions': :'actions',
    'request_access_control': :'requestAccessControl',
    'request_rate_limiting': :'requestRateLimiting',
    'request_protection': :'requestProtection',
    'response_access_control': :'responseAccessControl',
    'response_protection': :'responseProtection',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/oci/waf/models/web_app_firewall_policy.rb', line 130

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'display_name': :'String',
    'compartment_id': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'lifecycle_state': :'String',
    'lifecycle_details': :'String',
    'actions': :'Array<OCI::Waf::Models::Action>',
    'request_access_control': :'OCI::Waf::Models::RequestAccessControl',
    'request_rate_limiting': :'OCI::Waf::Models::RequestRateLimiting',
    'request_protection': :'OCI::Waf::Models::RequestProtection',
    'response_access_control': :'OCI::Waf::Models::ResponseAccessControl',
    'response_protection': :'OCI::Waf::Models::ResponseProtection',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'system_tags': :'Hash<String, Hash<String, Object>>'
    # 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



290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
 
# File 'lib/oci/waf/models/web_app_firewall_policy.rb', line 290

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

  self.class == other.class &&
    id == other.id &&
    display_name == other.display_name &&
    compartment_id == other.compartment_id &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_details == other.lifecycle_details &&
    actions == other.actions &&
    request_access_control == other.request_access_control &&
    request_rate_limiting == other.request_rate_limiting &&
    request_protection == other.request_protection &&
    response_access_control == other.response_access_control &&
    response_protection == other.response_protection &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    system_tags == other.system_tags
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



335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
 
# File 'lib/oci/waf/models/web_app_firewall_policy.rb', line 335

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


315
316
317
 
# File 'lib/oci/waf/models/web_app_firewall_policy.rb', line 315

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



324
325
326
 
# File 'lib/oci/waf/models/web_app_firewall_policy.rb', line 324

def hash
  [id, display_name, compartment_id, time_created, time_updated, lifecycle_state, lifecycle_details, actions, request_access_control, request_rate_limiting, request_protection, response_access_control, response_protection, freeform_tags, defined_tags, system_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



368
369
370
371
372
373
374
375
376
377
 
# File 'lib/oci/waf/models/web_app_firewall_policy.rb', line 368

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



362
363
364
 
# File 'lib/oci/waf/models/web_app_firewall_policy.rb', line 362

def to_s
  to_hash.to_s
end