Class: OCI::NetworkFirewall::Models::CreateNetworkFirewallPolicyDetails

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

Overview

Request data required to create a network firewall policy.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateNetworkFirewallPolicyDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/oci/network_firewall/models/create_network_firewall_policy_details.rb', line 132

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

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

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

  self.compartment_id = attributes[:'compartmentId'] if attributes[:'compartmentId']

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

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

  self.mapped_secrets = attributes[:'mappedSecrets'] if attributes[:'mappedSecrets']

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

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

  self.application_lists = attributes[:'applicationLists'] if attributes[:'applicationLists']

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

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

  self.url_lists = attributes[:'urlLists'] if attributes[:'urlLists']

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

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

  self.ip_address_lists = attributes[:'ipAddressLists'] if attributes[:'ipAddressLists']

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

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

  self.security_rules = attributes[:'securityRules'] if attributes[:'securityRules']

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

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

  self.decryption_rules = attributes[:'decryptionRules'] if attributes[:'decryptionRules']

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

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

  self.decryption_profiles = attributes[:'decryptionProfiles'] if attributes[:'decryptionProfiles']

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

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

  self.freeform_tags = attributes[:'freeformTags'] if attributes[:'freeformTags']

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

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

  self.defined_tags = attributes[:'definedTags'] if attributes[:'definedTags']

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

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

Instance Attribute Details

#application_lists ⇒ Hash<String, Array<OCI::NetworkFirewall::Models::Application>>

Map defining application lists of the policy. The value of an entry is a list of "applications", each consisting of a protocol identifier (such as TCP, UDP, or ICMP) and protocol-specific parameters (such as a port range). The associated key is the identifier by which the application list is referenced.

Returns:



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

def application_lists
  @application_lists
end

#compartment_id ⇒ String

**[Required]** The [OCID](docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the NetworkFirewall Policy.

Returns:

  • (String) 


16
17
18
 
# File 'lib/oci/network_firewall/models/create_network_firewall_policy_details.rb', line 16

def compartment_id
  @compartment_id
end

#decryption_profiles ⇒ Hash<String, OCI::NetworkFirewall::Models::DecryptionProfile>

Map defining decryption profiles of the policy. The value of an entry is a decryption profile. The associated key is the identifier by which the decryption profile is referenced.

Returns:



63
64
65
 
# File 'lib/oci/network_firewall/models/create_network_firewall_policy_details.rb', line 63

def decryption_profiles
  @decryption_profiles
end

#decryption_rules ⇒ Array<OCI::NetworkFirewall::Models::DecryptionRule>

List of Decryption Rules defining the behavior of the policy. The first rule with a matching condition determines the action taken upon network traffic.

Returns:



56
57
58
 
# File 'lib/oci/network_firewall/models/create_network_firewall_policy_details.rb', line 56

def decryption_rules
  @decryption_rules
end

#defined_tags ⇒ Hash<String, Hash<String, Object>>

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"bar-key": "value"}`

Returns:

  • (Hash<String, Hash<String, Object>>) 


75
76
77
 
# File 'lib/oci/network_firewall/models/create_network_firewall_policy_details.rb', line 75

def defined_tags
  @defined_tags
end

#display_name ⇒ String

A user-friendly optional name for the firewall policy. Avoid entering confidential information.

Returns:

  • (String) 


12
13
14
 
# File 'lib/oci/network_firewall/models/create_network_firewall_policy_details.rb', line 12

def display_name
  @display_name
end

#freeform_tags ⇒ Hash<String, String>

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `"value"`

Returns:

  • (Hash<String, String>) 


69
70
71
 
# File 'lib/oci/network_firewall/models/create_network_firewall_policy_details.rb', line 69

def freeform_tags
  @freeform_tags
end

#ip_address_lists ⇒ Hash<String, Array<String>>

Map defining IP address lists of the policy. The value of an entry is a list of IP addresses or prefixes in CIDR notation. The associated key is the identifier by which the IP address list is referenced.

Returns:

  • (Hash<String, Array<String>>) 


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

def ip_address_lists
  @ip_address_lists
end

#mapped_secrets ⇒ Hash<String, OCI::NetworkFirewall::Models::MappedSecret>

Map defining secrets of the policy. The value of an entry is a "mapped secret" consisting of a purpose and source. The associated key is the identifier by which the mapped secret is referenced.

Returns:



23
24
25
 
# File 'lib/oci/network_firewall/models/create_network_firewall_policy_details.rb', line 23

def mapped_secrets
  @mapped_secrets
end

#security_rules ⇒ Array<OCI::NetworkFirewall::Models::SecurityRule>

List of Security Rules defining the behavior of the policy. The first rule with a matching condition determines the action taken upon network traffic.

Returns:



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

def security_rules
  @security_rules
end

#url_lists ⇒ Hash<String, Array<OCI::NetworkFirewall::Models::UrlPattern>>

Map defining URL pattern lists of the policy. The value of an entry is a list of URL patterns. The associated key is the identifier by which the URL pattern list is referenced.

Returns:



37
38
39
 
# File 'lib/oci/network_firewall/models/create_network_firewall_policy_details.rb', line 37

def url_lists
  @url_lists
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'displayName',
    'compartment_id': :'compartmentId',
    'mapped_secrets': :'mappedSecrets',
    'application_lists': :'applicationLists',
    'url_lists': :'urlLists',
    'ip_address_lists': :'ipAddressLists',
    'security_rules': :'securityRules',
    'decryption_rules': :'decryptionRules',
    'decryption_profiles': :'decryptionProfiles',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/oci/network_firewall/models/create_network_firewall_policy_details.rb', line 97

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'String',
    'compartment_id': :'String',
    'mapped_secrets': :'Hash<String, OCI::NetworkFirewall::Models::MappedSecret>',
    'application_lists': :'Hash<String, Array<OCI::NetworkFirewall::Models::Application>>',
    'url_lists': :'Hash<String, Array<OCI::NetworkFirewall::Models::UrlPattern>>',
    'ip_address_lists': :'Hash<String, Array<String>>',
    'security_rules': :'Array<OCI::NetworkFirewall::Models::SecurityRule>',
    'decryption_rules': :'Array<OCI::NetworkFirewall::Models::DecryptionRule>',
    'decryption_profiles': :'Hash<String, OCI::NetworkFirewall::Models::DecryptionProfile>',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>'
    # 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



212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/oci/network_firewall/models/create_network_firewall_policy_details.rb', line 212

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

  self.class == other.class &&
    display_name == other.display_name &&
    compartment_id == other.compartment_id &&
    mapped_secrets == other.mapped_secrets &&
    application_lists == other.application_lists &&
    url_lists == other.url_lists &&
    ip_address_lists == other.ip_address_lists &&
    security_rules == other.security_rules &&
    decryption_rules == other.decryption_rules &&
    decryption_profiles == other.decryption_profiles &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags
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



252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
 
# File 'lib/oci/network_firewall/models/create_network_firewall_policy_details.rb', line 252

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


232
233
234
 
# File 'lib/oci/network_firewall/models/create_network_firewall_policy_details.rb', line 232

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



241
242
243
 
# File 'lib/oci/network_firewall/models/create_network_firewall_policy_details.rb', line 241

def hash
  [display_name, compartment_id, mapped_secrets, application_lists, url_lists, ip_address_lists, security_rules, decryption_rules, decryption_profiles, freeform_tags, defined_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



285
286
287
288
289
290
291
292
293
294
 
# File 'lib/oci/network_firewall/models/create_network_firewall_policy_details.rb', line 285

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



279
280
281
 
# File 'lib/oci/network_firewall/models/create_network_firewall_policy_details.rb', line 279

def to_s
  to_hash.to_s
end