Class: OCI::Waas::Models::Whitelist

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/waas/models/whitelist.rb

Overview

An array of IP addresses that bypass the Web Application Firewall. Supports both single IP addresses or subnet masks (CIDR notation).

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Whitelist

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

  • :addresses (Array<String>)

    The value to assign to the #addresses property

  • :address_lists (Array<String>)

    The value to assign to the #address_lists property



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
# File 'lib/oci/waas/models/whitelist.rb', line 53

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

  self.address_lists = attributes[:'addressLists'] if attributes[:'addressLists']

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

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

Instance Attribute Details

#address_listsArray<String>

A list of OCID of IP address lists to include in the whitelist.

Returns:

  • (Array<String>)


20
21
22
# File 'lib/oci/waas/models/whitelist.rb', line 20

def address_lists
  @address_lists
end

#addressesArray<String>

A set of IP addresses or CIDR notations to include in the whitelist.

Returns:

  • (Array<String>)


16
17
18
# File 'lib/oci/waas/models/whitelist.rb', line 16

def addresses
  @addresses
end

#nameString

[Required] The unique name of the whitelist.

Returns:

  • (String)


12
13
14
# File 'lib/oci/waas/models/whitelist.rb', line 12

def name
  @name
end

Class Method Details

.attribute_mapObject

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



23
24
25
26
27
28
29
30
31
# File 'lib/oci/waas/models/whitelist.rb', line 23

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'name',
    'addresses': :'addresses',
    'address_lists': :'addressLists'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



34
35
36
37
38
39
40
41
42
# File 'lib/oci/waas/models/whitelist.rb', line 34

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



77
78
79
80
81
82
83
84
# File 'lib/oci/waas/models/whitelist.rb', line 77

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

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



109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
# File 'lib/oci/waas/models/whitelist.rb', line 109

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


89
90
91
# File 'lib/oci/waas/models/whitelist.rb', line 89

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



98
99
100
# File 'lib/oci/waas/models/whitelist.rb', line 98

def hash
  [name, addresses, address_lists].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



142
143
144
145
146
147
148
149
150
151
# File 'lib/oci/waas/models/whitelist.rb', line 142

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



136
137
138
# File 'lib/oci/waas/models/whitelist.rb', line 136

def to_s
  to_hash.to_s
end