Class: OCI::Waf::Models::UpdateWebAppFirewallDetails

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

Overview

The information to be updated for WebAppFirewall.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UpdateWebAppFirewallDetails

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

  • :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

[View source]

76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/oci/waf/models/update_web_app_firewall_details.rb', line 76

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

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

31
32
33
 
# File 'lib/oci/waf/models/update_web_app_firewall_details.rb', line 31

def defined_tags
  @defined_tags
end

#display_name ⇒ String

WebAppFirewall display name, can be renamed.

Returns:

  • (String) 

13
14
15
 
# File 'lib/oci/waf/models/update_web_app_firewall_details.rb', line 13

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

25
26
27
 
# File 'lib/oci/waf/models/update_web_app_firewall_details.rb', line 25

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

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

def system_tags
  @system_tags
end

#web_app_firewall_policy_id ⇒ String

The OCID of WebAppFirewallPolicy, which is attached to the resource. This update guarantees that the resource always has WebAppFirewallPolicy attached at any time.

Returns:

  • (String) 

19
20
21
 
# File 'lib/oci/waf/models/update_web_app_firewall_details.rb', line 19

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.

[View source]

40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/oci/waf/models/update_web_app_firewall_details.rb', line 40

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

.swagger_types ⇒ Object

Attribute type mapping.

[View source]

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

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

[View source]

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

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

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

[View source]

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/waf/models/update_web_app_firewall_details.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
[View source]

134
135
136
 
# File 'lib/oci/waf/models/update_web_app_firewall_details.rb', line 134

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code

[View source]

143
144
145
 
# File 'lib/oci/waf/models/update_web_app_firewall_details.rb', line 143

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

[View source]

187
188
189
190
191
192
193
194
195
196
 
# File 'lib/oci/waf/models/update_web_app_firewall_details.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

[View source]

181
182
183
 
# File 'lib/oci/waf/models/update_web_app_firewall_details.rb', line 181

def to_s
  to_hash.to_s
end