Class: OCI::Waf::Models::CreateWebAppFirewallDetails

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

Overview

The information about new Web App Firewall. This class has direct subclasses. If you are using this class as input to a service operations then you should favor using a subclass over the base class

Direct Known Subclasses

CreateWebAppFirewallLoadBalancerDetails

Constant Summary collapse

BACKEND_TYPE_ENUM = 
[
  BACKEND_TYPE_LOAD_BALANCER = 'LOAD_BALANCER'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateWebAppFirewallDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :display_name (String) —

    The value to assign to the #display_name property

  • :backend_type (String) —

    The value to assign to the #backend_type property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :web_app_firewall_policy_id (String) —

    The value to assign to the #web_app_firewall_policy_id property

  • :freeform_tags (Hash<String, String>) —

    The value to assign to the #freeform_tags property

  • :defined_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #defined_tags property

  • :system_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #system_tags property



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/oci/waf/models/create_web_app_firewall_details.rb', line 108

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

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

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

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

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

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

  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

#backend_type ⇒ String

[Required] Type of the WebAppFirewall, as example LOAD_BALANCER.

Returns:

  • (String) 


22
23
24
 
# File 'lib/oci/waf/models/create_web_app_firewall_details.rb', line 22

def backend_type
  @backend_type
end

#compartment_id ⇒ String

[Required] The OCID of the compartment.

Returns:

  • (String) 


26
27
28
 
# File 'lib/oci/waf/models/create_web_app_firewall_details.rb', line 26

def compartment_id
  @compartment_id
end

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

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>>) 


42
43
44
 
# File 'lib/oci/waf/models/create_web_app_firewall_details.rb', line 42

def defined_tags
  @defined_tags
end

#display_name ⇒ String

WebAppFirewall display name, can be renamed.

Returns:

  • (String) 


18
19
20
 
# File 'lib/oci/waf/models/create_web_app_firewall_details.rb', line 18

def display_name
  @display_name
end

#freeform_tags ⇒ Hash<String, String>

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>) 


36
37
38
 
# File 'lib/oci/waf/models/create_web_app_firewall_details.rb', line 36

def freeform_tags
  @freeform_tags
end

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

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>>) 


48
49
50
 
# File 'lib/oci/waf/models/create_web_app_firewall_details.rb', line 48

def system_tags
  @system_tags
end

#web_app_firewall_policy_id ⇒ String

[Required] The OCID of WebAppFirewallPolicy, which is attached to the resource.

Returns:

  • (String) 


30
31
32
 
# File 'lib/oci/waf/models/create_web_app_firewall_details.rb', line 30

def web_app_firewall_policy_id
  @web_app_firewall_policy_id
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'displayName',
    'backend_type': :'backendType',
    'compartment_id': :'compartmentId',
    'web_app_firewall_policy_id': :'webAppFirewallPolicyId',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.get_subtype(object_hash) ⇒ Object

Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.



85
86
87
88
89
90
91
92
 
# File 'lib/oci/waf/models/create_web_app_firewall_details.rb', line 85

def self.get_subtype(object_hash)
  type = object_hash[:'backendType'] # rubocop:disable Style/SymbolLiteral

  return 'OCI::Waf::Models::CreateWebAppFirewallLoadBalancerDetails' if type == 'LOAD_BALANCER'

  # TODO: Log a warning when the subtype is not found.
  'OCI::Waf::Models::CreateWebAppFirewallDetails'
end

.swagger_types ⇒ Object

Attribute type mapping.



66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/oci/waf/models/create_web_app_firewall_details.rb', line 66

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



172
173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/oci/waf/models/create_web_app_firewall_details.rb', line 172

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

  self.class == other.class &&
    display_name == other.display_name &&
    backend_type == other.backend_type &&
    compartment_id == other.compartment_id &&
    web_app_firewall_policy_id == other.web_app_firewall_policy_id &&
    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



208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'lib/oci/waf/models/create_web_app_firewall_details.rb', line 208

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


188
189
190
 
# File 'lib/oci/waf/models/create_web_app_firewall_details.rb', line 188

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



197
198
199
 
# File 'lib/oci/waf/models/create_web_app_firewall_details.rb', line 197

def hash
  [display_name, backend_type, compartment_id, web_app_firewall_policy_id, 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



241
242
243
244
245
246
247
248
249
250
 
# File 'lib/oci/waf/models/create_web_app_firewall_details.rb', line 241

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



235
236
237
 
# File 'lib/oci/waf/models/create_web_app_firewall_details.rb', line 235

def to_s
  to_hash.to_s
end