Class: OCI::NetworkFirewall::Models::NatConfigurationResponse

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

Overview

Response to a request to configure Network Address Translation (NAT) on a firewall.

To perform NAT on traffic passing the private NAT IPs to the firewall, the attached network firewall policy must also have NAT rules and NAT configuration must be enabled. If NAT configuration is enabled and the attached firewall policy does not contain NAT rule then NAT IPs will get allocated but NAT will not be performed on any traffic.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ NatConfigurationResponse

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/oci/network_firewall/models/nat_configuration_response.rb', line 54

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.must_enable_private_nat = attributes[:'mustEnablePrivateNat'] unless attributes[:'mustEnablePrivateNat'].nil?

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

  self.must_enable_private_nat = attributes[:'must_enable_private_nat'] unless attributes[:'must_enable_private_nat'].nil?

  self.nat_ip_address_list = attributes[:'natIpAddressList'] if attributes[:'natIpAddressList']

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

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

Instance Attribute Details

#must_enable_private_nat ⇒ BOOLEAN

True indicates that NAT configuration is enabled. False indicates NAT configuration is disabled.

Returns:

  • (BOOLEAN) 


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

def must_enable_private_nat
  @must_enable_private_nat
end

#nat_ip_address_list ⇒ Array<String>

An array of Private NAT IP addresses that are associated with the Network Firewall. These IP addresses are reserved for NAT and shouldn't be used for any other purpose in the subnet.

This list contains IP addresses when NAT configuration is enabled. This list is empty or null IP when NAT configuration is disabled.

Returns:

  • (Array<String>) 


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

def nat_ip_address_list
  @nat_ip_address_list
end

Class Method Details

.attribute_map ⇒ Object

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



27
28
29
30
31
32
33
34
 
# File 'lib/oci/network_firewall/models/nat_configuration_response.rb', line 27

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'must_enable_private_nat': :'mustEnablePrivateNat',
    'nat_ip_address_list': :'natIpAddressList'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



37
38
39
40
41
42
43
44
 
# File 'lib/oci/network_firewall/models/nat_configuration_response.rb', line 37

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'must_enable_private_nat': :'BOOLEAN',
    'nat_ip_address_list': :'Array<String>'
    # 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



80
81
82
83
84
85
86
 
# File 'lib/oci/network_firewall/models/nat_configuration_response.rb', line 80

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

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



111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/oci/network_firewall/models/nat_configuration_response.rb', line 111

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


91
92
93
 
# File 'lib/oci/network_firewall/models/nat_configuration_response.rb', line 91

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



100
101
102
 
# File 'lib/oci/network_firewall/models/nat_configuration_response.rb', line 100

def hash
  [must_enable_private_nat, nat_ip_address_list].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



144
145
146
147
148
149
150
151
152
153
 
# File 'lib/oci/network_firewall/models/nat_configuration_response.rb', line 144

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



138
139
140
 
# File 'lib/oci/network_firewall/models/nat_configuration_response.rb', line 138

def to_s
  to_hash.to_s
end