Class: OCI::NetworkFirewall::Models::DecryptionRule

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

Overview

Decryption Rule used in the firewall policy rules. A Decryption Rule is used to define which traffic should be decrypted by the firewall, and how it should do so.

Constant Summary collapse

ACTION_ENUM = 
[
  ACTION_NO_DECRYPT = 'NO_DECRYPT'.freeze,
  ACTION_DECRYPT = 'DECRYPT'.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 = {}) ⇒ DecryptionRule

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'lib/oci/network_firewall/models/decryption_rule.rb', line 94

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

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

  self.decryption_profile = attributes[:'decryptionProfile'] if attributes[:'decryptionProfile']

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

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

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

  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

#action ⇒ String

[Required] Action:

  • NO_DECRYPT - Matching traffic is not decrypted.

  • DECRYPT - Matching traffic is decrypted with the specified secret according to the specified decryptionProfile.

Returns:

  • (String) 


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

def action
  @action
end

#condition ⇒ OCI::NetworkFirewall::Models::DecryptionRuleMatchCriteria

This attribute is required.

Returns:



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

def condition
  @condition
end

#decryption_profile ⇒ String

The name of the decryption profile to use.

Returns:

  • (String) 


38
39
40
 
# File 'lib/oci/network_firewall/models/decryption_rule.rb', line 38

def decryption_profile
  @decryption_profile
end

#name ⇒ String

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

Returns:

  • (String) 


22
23
24
 
# File 'lib/oci/network_firewall/models/decryption_rule.rb', line 22

def name
  @name
end

#parent_resource_id ⇒ String

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

Returns:

  • (String) 


49
50
51
 
# File 'lib/oci/network_firewall/models/decryption_rule.rb', line 49

def parent_resource_id
  @parent_resource_id
end

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

Returns:



45
46
47
 
# File 'lib/oci/network_firewall/models/decryption_rule.rb', line 45

def position
  @position
end

#secret ⇒ String

The name of a mapped secret. Its type must match that of the specified decryption profile.

Returns:

  • (String) 


42
43
44
 
# File 'lib/oci/network_firewall/models/decryption_rule.rb', line 42

def secret
  @secret
end

Class Method Details

.attribute_map ⇒ Object

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



52
53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/oci/network_firewall/models/decryption_rule.rb', line 52

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'name',
    'condition': :'condition',
    'action': :'action',
    'decryption_profile': :'decryptionProfile',
    'secret': :'secret',
    'position': :'position',
    'parent_resource_id': :'parentResourceId'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/oci/network_firewall/models/decryption_rule.rb', line 67

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'String',
    'condition': :'OCI::NetworkFirewall::Models::DecryptionRuleMatchCriteria',
    'action': :'String',
    'decryption_profile': :'String',
    'secret': :'String',
    '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



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

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

  self.class == other.class &&
    name == other.name &&
    condition == other.condition &&
    action == other.action &&
    decryption_profile == other.decryption_profile &&
    secret == other.secret &&
    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



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

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


159
160
161
 
# File 'lib/oci/network_firewall/models/decryption_rule.rb', line 159

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



168
169
170
 
# File 'lib/oci/network_firewall/models/decryption_rule.rb', line 168

def hash
  [name, condition, action, decryption_profile, secret, 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



212
213
214
215
216
217
218
219
220
221
 
# File 'lib/oci/network_firewall/models/decryption_rule.rb', line 212

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



206
207
208
 
# File 'lib/oci/network_firewall/models/decryption_rule.rb', line 206

def to_s
  to_hash.to_s
end