Class: OCI::NetworkFirewall::Models::UpdateNetworkFirewallDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/network_firewall/models/update_network_firewall_details.rb

Overview

The information to be updated.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UpdateNetworkFirewallDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
112
113
114
115
116
117
118
119
120
121
 
# File 'lib/oci/network_firewall/models/update_network_firewall_details.rb', line 80

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

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

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

  self.network_security_group_ids = attributes[:'networkSecurityGroupIds'] if attributes[:'networkSecurityGroupIds']

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

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

  self.nat_configuration = attributes[:'natConfiguration'] if attributes[:'natConfiguration']

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

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

  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']
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. For more information, see Resource Tags. Example: {\"Operations\": {\"CostCenter\": \"42\"}}

Returns:

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


38
39
40
 
# File 'lib/oci/network_firewall/models/update_network_firewall_details.rb', line 38

def defined_tags
  @defined_tags
end

#display_name ⇒ String

A user-friendly name for the Network Firewall. Does not have to be unique, and it's changeable. Avoid entering confidential information.

Returns:

  • (String) 


13
14
15
 
# File 'lib/oci/network_firewall/models/update_network_firewall_details.rb', line 13

def display_name
  @display_name
end

#freeform_tags ⇒ Hash<String, String>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {\"Department\": \"Finance\"}

Returns:

  • (Hash<String, String>) 


31
32
33
 
# File 'lib/oci/network_firewall/models/update_network_firewall_details.rb', line 31

def freeform_tags
  @freeform_tags
end

#nat_configuration ⇒ OCI::NetworkFirewall::Models::NatConfigurationRequest

Returns:



24
25
26
 
# File 'lib/oci/network_firewall/models/update_network_firewall_details.rb', line 24

def nat_configuration
  @nat_configuration
end

#network_firewall_policy_id ⇒ String

The OCID of the Network Firewall Policy.

Returns:

  • (String) 


17
18
19
 
# File 'lib/oci/network_firewall/models/update_network_firewall_details.rb', line 17

def network_firewall_policy_id
  @network_firewall_policy_id
end

#network_security_group_ids ⇒ Array<String>

An array of network security groups OCID associated with the Network Firewall.

Returns:

  • (Array<String>) 


21
22
23
 
# File 'lib/oci/network_firewall/models/update_network_firewall_details.rb', line 21

def network_security_group_ids
  @network_security_group_ids
end

Class Method Details

.attribute_map ⇒ Object

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



41
42
43
44
45
46
47
48
49
50
51
52
 
# File 'lib/oci/network_firewall/models/update_network_firewall_details.rb', line 41

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'displayName',
    'network_firewall_policy_id': :'networkFirewallPolicyId',
    'network_security_group_ids': :'networkSecurityGroupIds',
    'nat_configuration': :'natConfiguration',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/oci/network_firewall/models/update_network_firewall_details.rb', line 55

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'String',
    'network_firewall_policy_id': :'String',
    'network_security_group_ids': :'Array<String>',
    'nat_configuration': :'OCI::NetworkFirewall::Models::NatConfigurationRequest',
    'freeform_tags': :'Hash<String, String>',
    'defined_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



130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/oci/network_firewall/models/update_network_firewall_details.rb', line 130

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

  self.class == other.class &&
    display_name == other.display_name &&
    network_firewall_policy_id == other.network_firewall_policy_id &&
    network_security_group_ids == other.network_security_group_ids &&
    nat_configuration == other.nat_configuration &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_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



165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'lib/oci/network_firewall/models/update_network_firewall_details.rb', line 165

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


145
146
147
 
# File 'lib/oci/network_firewall/models/update_network_firewall_details.rb', line 145

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



154
155
156
 
# File 'lib/oci/network_firewall/models/update_network_firewall_details.rb', line 154

def hash
  [display_name, network_firewall_policy_id, network_security_group_ids, nat_configuration, freeform_tags, defined_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



198
199
200
201
202
203
204
205
206
207
 
# File 'lib/oci/network_firewall/models/update_network_firewall_details.rb', line 198

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



192
193
194
 
# File 'lib/oci/network_firewall/models/update_network_firewall_details.rb', line 192

def to_s
  to_hash.to_s
end