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



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/oci/network_firewall/models/decryption_rule.rb', line 108

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

  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

[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

#description ⇒ String

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

Returns:

  • (String) 


57
58
59
 
# File 'lib/oci/network_firewall/models/decryption_rule.rb', line 57

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


53
54
55
 
# File 'lib/oci/network_firewall/models/decryption_rule.rb', line 53

def parent_resource_id
  @parent_resource_id
end

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

Returns:



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

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

#secrets ⇒ Array<String>

An array of mapped secrets.

Returns:

  • (Array<String>) 


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

def secrets
  @secrets
end

Class Method Details

.attribute_map ⇒ Object

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



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

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

.swagger_types ⇒ Object

Attribute type mapping.



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

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



161
162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/oci/network_firewall/models/decryption_rule.rb', line 161

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 &&
    secrets == other.secrets &&
    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



199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
 
# File 'lib/oci/network_firewall/models/decryption_rule.rb', line 199

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


179
180
181
 
# File 'lib/oci/network_firewall/models/decryption_rule.rb', line 179

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



188
189
190
 
# File 'lib/oci/network_firewall/models/decryption_rule.rb', line 188

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



232
233
234
235
236
237
238
239
240
241
 
# File 'lib/oci/network_firewall/models/decryption_rule.rb', line 232

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



226
227
228
 
# File 'lib/oci/network_firewall/models/decryption_rule.rb', line 226

def to_s
  to_hash.to_s
end