Class: OCI::NetworkFirewall::Models::AddressList

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

Overview

List of addresses with a reference name. The value of an entry is a list of IP addresses or prefixes in CIDR notation or FQDNs. The associated key is the identifier by which the IP address list is referenced.

Constant Summary collapse

TYPE_ENUM = 
[
  TYPE_FQDN = 'FQDN'.freeze,
  TYPE_IP = 'IP'.freeze,
  TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AddressList

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

  • :type (String) —

    The value to assign to the #type property

  • :addresses (Array<String>) —

    The value to assign to the #addresses property

  • :total_addresses (Integer) —

    The value to assign to the #total_addresses property

  • :parent_resource_id (String) —

    The value to assign to the #parent_resource_id property



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/oci/network_firewall/models/address_list.rb', line 78

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

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

  self.total_addresses = attributes[:'totalAddresses'] if attributes[:'totalAddresses']

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

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

  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

#addresses ⇒ Array<String>

[Required] List of addresses.

Returns:

  • (Array<String>) 


31
32
33
 
# File 'lib/oci/network_firewall/models/address_list.rb', line 31

def addresses
  @addresses
end

#name ⇒ String

[Required] Unique name to identify the group of addresses to be used in the policy rules.

Returns:

  • (String) 


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

def name
  @name
end

#parent_resource_id ⇒ String

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

Returns:

  • (String) 


39
40
41
 
# File 'lib/oci/network_firewall/models/address_list.rb', line 39

def parent_resource_id
  @parent_resource_id
end

#total_addresses ⇒ Integer

[Required] Count of total Addresses in the AddressList

Returns:

  • (Integer) 


35
36
37
 
# File 'lib/oci/network_firewall/models/address_list.rb', line 35

def total_addresses
  @total_addresses
end

#type ⇒ String

[Required] Type of address List. The accepted values are - * FQDN * IP

Returns:

  • (String) 


27
28
29
 
# File 'lib/oci/network_firewall/models/address_list.rb', line 27

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

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



42
43
44
45
46
47
48
49
50
51
52
 
# File 'lib/oci/network_firewall/models/address_list.rb', line 42

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'name',
    'type': :'type',
    'addresses': :'addresses',
    'total_addresses': :'totalAddresses',
    'parent_resource_id': :'parentResourceId'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'String',
    'type': :'String',
    'addresses': :'Array<String>',
    'total_addresses': :'Integer',
    '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



123
124
125
126
127
128
129
130
131
132
 
# File 'lib/oci/network_firewall/models/address_list.rb', line 123

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

  self.class == other.class &&
    name == other.name &&
    type == other.type &&
    addresses == other.addresses &&
    total_addresses == other.total_addresses &&
    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



157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
 
# File 'lib/oci/network_firewall/models/address_list.rb', line 157

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


137
138
139
 
# File 'lib/oci/network_firewall/models/address_list.rb', line 137

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



146
147
148
 
# File 'lib/oci/network_firewall/models/address_list.rb', line 146

def hash
  [name, type, addresses, total_addresses, 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



190
191
192
193
194
195
196
197
198
199
 
# File 'lib/oci/network_firewall/models/address_list.rb', line 190

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



184
185
186
 
# File 'lib/oci/network_firewall/models/address_list.rb', line 184

def to_s
  to_hash.to_s
end