Class: OCI::NetworkFirewall::Models::TunnelInspectionRule

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

Overview

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 Inspect protocol, the source and destination IP addresses.

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

VxlanInspectionRule

Constant Summary collapse

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TunnelInspectionRule

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/oci/network_firewall/models/tunnel_inspection_rule.rb', line 119

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

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

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

  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) 


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

def action
  @action
end

#description ⇒ String

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

Returns:

  • (String) 


59
60
61
 
# File 'lib/oci/network_firewall/models/tunnel_inspection_rule.rb', line 59

def description
  @description
end

#name ⇒ String

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

Returns:

  • (String) 


29
30
31
 
# File 'lib/oci/network_firewall/models/tunnel_inspection_rule.rb', line 29

def name
  @name
end

#parent_resource_id ⇒ String

[Required] OCID of the Network Firewall Policy this Tunnel Inspection Rule belongs to.

Returns:

  • (String) 


55
56
57
 
# File 'lib/oci/network_firewall/models/tunnel_inspection_rule.rb', line 55

def parent_resource_id
  @parent_resource_id
end

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

Returns:



51
52
53
 
# File 'lib/oci/network_firewall/models/tunnel_inspection_rule.rb', line 51

def position
  @position
end

#priority_order ⇒ Integer

The priority order in which this rule should be evaluated

Returns:

  • (Integer) 


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

def priority_order
  @priority_order
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) 


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

def protocol
  @protocol
end

Class Method Details

.attribute_map ⇒ Object

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



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

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



96
97
98
99
100
101
102
103
 
# File 'lib/oci/network_firewall/models/tunnel_inspection_rule.rb', line 96

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

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

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

.swagger_types ⇒ Object

Attribute type mapping.



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

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



182
183
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/oci/network_firewall/models/tunnel_inspection_rule.rb', line 182

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

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



218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'lib/oci/network_firewall/models/tunnel_inspection_rule.rb', line 218

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


198
199
200
 
# File 'lib/oci/network_firewall/models/tunnel_inspection_rule.rb', line 198

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



207
208
209
 
# File 'lib/oci/network_firewall/models/tunnel_inspection_rule.rb', line 207

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

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



251
252
253
254
255
256
257
258
259
260
 
# File 'lib/oci/network_firewall/models/tunnel_inspection_rule.rb', line 251

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



245
246
247
 
# File 'lib/oci/network_firewall/models/tunnel_inspection_rule.rb', line 245

def to_s
  to_hash.to_s
end