Class: OCI::NetworkFirewall::Models::NatRule

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

Overview

A Nat Rule is used to define to which traffic NAT should be applied by the 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

NatV4NatRule

Constant Summary collapse

TYPE_ENUM = 
[
  TYPE_NATV4 = 'NATV4'.freeze,
  TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ NatRule

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/oci/network_firewall/models/nat_rule.rb', line 100

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

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

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

  self.priority_order = attributes[:'priorityOrder'] if attributes[:'priorityOrder']

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

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

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

  self.parent_resource_id = attributes[:'parentResourceId'] if attributes[:'parentResourceId']

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

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

Instance Attribute Details

#description ⇒ String

Description of a NAT rule. This field can be used to add additional info.

Returns:

  • (String) 


32
33
34
 
# File 'lib/oci/network_firewall/models/nat_rule.rb', line 32

def description
  @description
end

#name ⇒ String

[Required] Name for the NAT rule, must be unique within the policy.

Returns:

  • (String) 


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

def name
  @name
end

#parent_resource_id ⇒ String

[Required] OCID of the Network Firewall Policy this decryption profile belongs to.

Returns:

  • (String) 


43
44
45
 
# File 'lib/oci/network_firewall/models/nat_rule.rb', line 43

def parent_resource_id
  @parent_resource_id
end

#position ⇒ OCI::NetworkFirewall::Models::RulePosition

Returns:



39
40
41
 
# File 'lib/oci/network_firewall/models/nat_rule.rb', line 39

def position
  @position
end

#priority_order ⇒ Integer

The priority order in which this rule should be evaluated

Returns:

  • (Integer) 


36
37
38
 
# File 'lib/oci/network_firewall/models/nat_rule.rb', line 36

def priority_order
  @priority_order
end

#type ⇒ String

[Required] NAT type:

  • NATV4 - NATV4 type NAT.

Returns:

  • (String) 


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

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

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



46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/oci/network_firewall/models/nat_rule.rb', line 46

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'name',
    'type': :'type',
    'description': :'description',
    'priority_order': :'priorityOrder',
    'position': :'position',
    'parent_resource_id': :'parentResourceId'
    # 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.



78
79
80
81
82
83
84
85
 
# File 'lib/oci/network_firewall/models/nat_rule.rb', line 78

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

  return 'OCI::NetworkFirewall::Models::NatV4NatRule' if type == 'NATV4'

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

.swagger_types ⇒ Object

Attribute type mapping.



60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/oci/network_firewall/models/nat_rule.rb', line 60

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



147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/oci/network_firewall/models/nat_rule.rb', line 147

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



182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
 
# File 'lib/oci/network_firewall/models/nat_rule.rb', line 182

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


162
163
164
 
# File 'lib/oci/network_firewall/models/nat_rule.rb', line 162

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



171
172
173
 
# File 'lib/oci/network_firewall/models/nat_rule.rb', line 171

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

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



215
216
217
218
219
220
221
222
223
224
 
# File 'lib/oci/network_firewall/models/nat_rule.rb', line 215

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



209
210
211
 
# File 'lib/oci/network_firewall/models/nat_rule.rb', line 209

def to_s
  to_hash.to_s
end