Class: OCI::NetworkFirewall::Models::NatV4NatRule

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

Overview

A Nat Rule is used to define to which traffic NAT should be applied by the firewall.

Constant Summary collapse

ACTION_ENUM = 
[
  ACTION_DIPP_SRC_NAT = 'DIPP_SRC_NAT'.freeze,
  ACTION_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Constants inherited from NatRule

OCI::NetworkFirewall::Models::NatRule::TYPE_ENUM

Instance Attribute Summary collapse

Attributes inherited from NatRule

#description, #name, #parent_resource_id, #position, #priority_order, #type

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from NatRule

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ NatV4NatRule

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/oci/network_firewall/models/nat_v4_nat_rule.rb', line 75

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  attributes['type'] = 'NATV4'

  super(attributes)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

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

  self.action = attributes[:'action'] if attributes[:'action']
  self.action = "DIPP_SRC_NAT" if action.nil? && !attributes.key?(:'action') # rubocop:disable Style/StringLiterals
end

Instance Attribute Details

#action ⇒ String

[Required] action:

  • DIPP_SRC_NAT - Dynamic-ip-port source NAT.

Returns:

  • (String) 


28
29
30
 
# File 'lib/oci/network_firewall/models/nat_v4_nat_rule.rb', line 28

def action
  @action
end

#condition ⇒ OCI::NetworkFirewall::Models::NatRuleMatchCriteria

This attribute is required.

Returns:



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

def condition
  @condition
end

Class Method Details

.attribute_map ⇒ Object

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



31
32
33
34
35
36
37
38
39
40
41
42
43
44
 
# File 'lib/oci/network_firewall/models/nat_v4_nat_rule.rb', line 31

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'name',
    'type': :'type',
    'description': :'description',
    'priority_order': :'priorityOrder',
    'position': :'position',
    'parent_resource_id': :'parentResourceId',
    'condition': :'condition',
    'action': :'action'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



47
48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/oci/network_firewall/models/nat_v4_nat_rule.rb', line 47

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'String',
    'type': :'String',
    'description': :'String',
    'priority_order': :'Integer',
    'position': :'OCI::NetworkFirewall::Models::RulePosition',
    'parent_resource_id': :'String',
    'condition': :'OCI::NetworkFirewall::Models::NatRuleMatchCriteria',
    'action': :'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



111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/oci/network_firewall/models/nat_v4_nat_rule.rb', line 111

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

  self.class == other.class &&
    name == other.name &&
    type == other.type &&
    description == other.description &&
    priority_order == other.priority_order &&
    position == other.position &&
    parent_resource_id == other.parent_resource_id &&
    condition == other.condition &&
    action == other.action
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



148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
 
# File 'lib/oci/network_firewall/models/nat_v4_nat_rule.rb', line 148

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


128
129
130
 
# File 'lib/oci/network_firewall/models/nat_v4_nat_rule.rb', line 128

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



137
138
139
 
# File 'lib/oci/network_firewall/models/nat_v4_nat_rule.rb', line 137

def hash
  [name, type, description, priority_order, position, parent_resource_id, condition, action].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



181
182
183
184
185
186
187
188
189
190
 
# File 'lib/oci/network_firewall/models/nat_v4_nat_rule.rb', line 181

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



175
176
177
 
# File 'lib/oci/network_firewall/models/nat_v4_nat_rule.rb', line 175

def to_s
  to_hash.to_s
end