Class: OCI::NetworkFirewall::Models::CreateNatRuleDetails

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

Overview

Request for creating Nat Rule used in the firewall policy. A Nat Rule is used to define to which traffic NAT should be applied by the firewall, and how it should do so.

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

CreateNatV4RuleDetails

Constant Summary collapse

TYPE_ENUM = 
[
  TYPE_NATV4 = 'NATV4'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateNatRuleDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/oci/network_firewall/models/create_nat_rule_details.rb', line 85

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

Instance Attribute Details

#description ⇒ String

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

Returns:

  • (String) 


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

def description
  @description
end

#name ⇒ String

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

Returns:

  • (String) 


20
21
22
 
# File 'lib/oci/network_firewall/models/create_nat_rule_details.rb', line 20

def name
  @name
end

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

Returns:



34
35
36
 
# File 'lib/oci/network_firewall/models/create_nat_rule_details.rb', line 34

def position
  @position
end

#type ⇒ String

[Required] NAT type:

  • NATV4 - NATV4 type NAT.

Returns:

  • (String) 


27
28
29
 
# File 'lib/oci/network_firewall/models/create_nat_rule_details.rb', line 27

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

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



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

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



65
66
67
68
69
70
71
72
 
# File 'lib/oci/network_firewall/models/create_nat_rule_details.rb', line 65

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

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

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

.swagger_types ⇒ Object

Attribute type mapping.



49
50
51
52
53
54
55
56
57
58
 
# File 'lib/oci/network_firewall/models/create_nat_rule_details.rb', line 49

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



115
116
117
118
119
120
121
122
123
 
# File 'lib/oci/network_firewall/models/create_nat_rule_details.rb', line 115

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

  self.class == other.class &&
    name == other.name &&
    type == other.type &&
    description == other.description &&
    position == other.position
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/create_nat_rule_details.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/create_nat_rule_details.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/create_nat_rule_details.rb', line 137

def hash
  [name, type, description, position].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/create_nat_rule_details.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/create_nat_rule_details.rb', line 175

def to_s
  to_hash.to_s
end