Class: OCI::NetworkFirewall::Models::DecryptionRuleSummary

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

Overview

Summary for 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 = {}) ⇒ DecryptionRuleSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :name (String) —

    The value to assign to the #name property

  • :action (String) —

    The value to assign to the #action property

  • :decryption_profile (String) —

    The value to assign to the #decryption_profile property

  • :secret (String) —

    The value to assign to the #secret property

  • :priority_order (Integer) —

    The value to assign to the #priority_order property

  • :parent_resource_id (String) —

    The value to assign to the #parent_resource_id property

  • :description (String) —

    The value to assign to the #description property



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
122
123
124
125
126
 
# File 'lib/oci/network_firewall/models/decryption_rule_summary.rb', line 95

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


30
31
32
 
# File 'lib/oci/network_firewall/models/decryption_rule_summary.rb', line 30

def action
  @action
end

#decryption_profile ⇒ String

[Required] The name of the decryption profile to use.

Returns:

  • (String) 


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

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) 


50
51
52
 
# File 'lib/oci/network_firewall/models/decryption_rule_summary.rb', line 50

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_summary.rb', line 22

def name
  @name
end

#parent_resource_id ⇒ String

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

Returns:

  • (String) 


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

def parent_resource_id
  @parent_resource_id
end

#priority_order ⇒ Integer

[Required] The priority order in which this rule should be evaluated.

Returns:

  • (Integer) 


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

def priority_order
  @priority_order
end

#secret ⇒ String

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

Returns:

  • (String) 


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

def secret
  @secret
end

Class Method Details

.attribute_map ⇒ Object

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



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

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

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'String',
    'action': :'String',
    'decryption_profile': :'String',
    'secret': :'String',
    'priority_order': :'Integer',
    '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



148
149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/oci/network_firewall/models/decryption_rule_summary.rb', line 148

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

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



184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/oci/network_firewall/models/decryption_rule_summary.rb', line 184

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


164
165
166
 
# File 'lib/oci/network_firewall/models/decryption_rule_summary.rb', line 164

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



173
174
175
 
# File 'lib/oci/network_firewall/models/decryption_rule_summary.rb', line 173

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



217
218
219
220
221
222
223
224
225
226
 
# File 'lib/oci/network_firewall/models/decryption_rule_summary.rb', line 217

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



211
212
213
 
# File 'lib/oci/network_firewall/models/decryption_rule_summary.rb', line 211

def to_s
  to_hash.to_s
end