Class: OCI::NetworkFirewall::Models::CreateTunnelInspectionRuleDetails

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

Overview

Request for creating Tunnel Inspection Rule used in the firewall policy rules. Tunnel Inspection Rule determines whether tunnel inspection is applied on the traffic based on attributes such as Tunnel Inspection protocol, the source and destination IP address.

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

CreateVxlanInspectionRuleDetails

Constant Summary collapse

ACTION_ENUM = 
[
  ACTION_INSPECT = 'INSPECT'.freeze,
  ACTION_INSPECT_AND_CAPTURE_LOG = 'INSPECT_AND_CAPTURE_LOG'.freeze
].freeze
PROTOCOL_ENUM = 
[
  PROTOCOL_VXLAN = 'VXLAN'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateTunnelInspectionRuleDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/oci/network_firewall/models/create_tunnel_inspection_rule_details.rb', line 102

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.action = attributes[:'action'] if attributes[:'action']
  self.action = "INSPECT_AND_CAPTURE_LOG" if action.nil? && !attributes.key?(:'action') # rubocop:disable Style/StringLiterals

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

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

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

Instance Attribute Details

#action ⇒ String

Types of Inspect Action on the traffic flow.

  • INSPECT - Inspect the traffic.

  • INSPECT_AND_CAPTURE_LOG - Inspect and capture logs for the traffic.

Returns:

  • (String) 


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

def action
  @action
end

#description ⇒ String

The description of the tunnel inspect rule. This field can be used to add additional info.

Returns:

  • (String) 


48
49
50
 
# File 'lib/oci/network_firewall/models/create_tunnel_inspection_rule_details.rb', line 48

def description
  @description
end

#name ⇒ String

[Required] Name for the Tunnel Inspection Rule, must be unique within the policy.

Returns:

  • (String) 


26
27
28
 
# File 'lib/oci/network_firewall/models/create_tunnel_inspection_rule_details.rb', line 26

def name
  @name
end

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

Returns:



44
45
46
 
# File 'lib/oci/network_firewall/models/create_tunnel_inspection_rule_details.rb', line 44

def position
  @position
end

#protocol ⇒ String

[Required] Types of Tunnel Inspection Protocol to be applied on the traffic.

  • VXLAN - VXLAN Tunnel Inspection Protocol will be applied on the traffic.

Returns:

  • (String) 


41
42
43
 
# File 'lib/oci/network_firewall/models/create_tunnel_inspection_rule_details.rb', line 41

def protocol
  @protocol
end

Class Method Details

.attribute_map ⇒ Object

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



51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/oci/network_firewall/models/create_tunnel_inspection_rule_details.rb', line 51

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



81
82
83
84
85
86
87
88
 
# File 'lib/oci/network_firewall/models/create_tunnel_inspection_rule_details.rb', line 81

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

  return 'OCI::NetworkFirewall::Models::CreateVxlanInspectionRuleDetails' if type == 'VXLAN'

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

.swagger_types ⇒ Object

Attribute type mapping.



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

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



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

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

  self.class == other.class &&
    name == other.name &&
    action == other.action &&
    protocol == other.protocol &&
    position == other.position &&
    description == other.description
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



177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
 
# File 'lib/oci/network_firewall/models/create_tunnel_inspection_rule_details.rb', line 177

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


157
158
159
 
# File 'lib/oci/network_firewall/models/create_tunnel_inspection_rule_details.rb', line 157

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



166
167
168
 
# File 'lib/oci/network_firewall/models/create_tunnel_inspection_rule_details.rb', line 166

def hash
  [name, action, protocol, position, description].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



210
211
212
213
214
215
216
217
218
219
 
# File 'lib/oci/network_firewall/models/create_tunnel_inspection_rule_details.rb', line 210

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



204
205
206
 
# File 'lib/oci/network_firewall/models/create_tunnel_inspection_rule_details.rb', line 204

def to_s
  to_hash.to_s
end