Class: OCI::LoadBalancer::Models::AllowRule

Inherits:
Rule
  • Object
show all
Defined in:
lib/oci/load_balancer/models/allow_rule.rb

Overview

An object that represents the action of configuring an access control rule. Access control rules permit access to application resources based on user-specified match conditions. This rule applies only to HTTP listeners.

NOTES: * If you do not specify any access control rules, the default rule is to allow all traffic. * If you add access control rules, the load balancer denies any traffic that does not match the rules. * Maximum of two match conditions can be specified in a rule. * You can specify this rule only with the following RuleCondition combinations: * SOURCE_IP_ADDRESS * SOURCE_VCN_ID * SOURCE_VCN_ID\", \"SOURCE_VCN_IP_ADDRESS

Constant Summary

Constants inherited from Rule

Rule::ACTION_ENUM

Instance Attribute Summary collapse

Attributes inherited from Rule

#action

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Rule

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ AllowRule

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



63
64
65
66
67
68
69
70
71
72
73
74
75
76
# File 'lib/oci/load_balancer/models/allow_rule.rb', line 63

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  attributes['action'] = 'ALLOW'

  super(attributes)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

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

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

Instance Attribute Details

#conditionsArray<OCI::LoadBalancer::Models::RuleCondition>

This attribute is required.



24
25
26
# File 'lib/oci/load_balancer/models/allow_rule.rb', line 24

def conditions
  @conditions
end

#descriptionString

A brief description of the access control rule. Avoid entering confidential information.

example: 192.168.0.0/16 and 2001:db8::/32 are trusted clients. Whitelist them.

Returns:

  • (String)


31
32
33
# File 'lib/oci/load_balancer/models/allow_rule.rb', line 31

def description
  @description
end

Class Method Details

.attribute_mapObject

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'action': :'action',
    'conditions': :'conditions',
    'description': :'description'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



45
46
47
48
49
50
51
52
53
# File 'lib/oci/load_balancer/models/allow_rule.rb', line 45

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'action': :'String',
    'conditions': :'Array<OCI::LoadBalancer::Models::RuleCondition>',
    '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



85
86
87
88
89
90
91
92
# File 'lib/oci/load_balancer/models/allow_rule.rb', line 85

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

  self.class == other.class &&
    action == other.action &&
    conditions == other.conditions &&
    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



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/load_balancer/models/allow_rule.rb', line 117

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


97
98
99
# File 'lib/oci/load_balancer/models/allow_rule.rb', line 97

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



106
107
108
# File 'lib/oci/load_balancer/models/allow_rule.rb', line 106

def hash
  [action, conditions, description].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



150
151
152
153
154
155
156
157
158
159
# File 'lib/oci/load_balancer/models/allow_rule.rb', line 150

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



144
145
146
# File 'lib/oci/load_balancer/models/allow_rule.rb', line 144

def to_s
  to_hash.to_s
end