Class: OCI::LoadBalancer::Models::Rule

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

Overview

An object that represents an action to apply to a listener. This class has direct subclasses. If you are using this class as input to a service operations then you should favor using a subclass over the base class

Constant Summary collapse

ACTION_ENUM = 
[
  ACTION_ADD_HTTP_REQUEST_HEADER = 'ADD_HTTP_REQUEST_HEADER'.freeze,
  ACTION_EXTEND_HTTP_REQUEST_HEADER_VALUE = 'EXTEND_HTTP_REQUEST_HEADER_VALUE'.freeze,
  ACTION_REMOVE_HTTP_REQUEST_HEADER = 'REMOVE_HTTP_REQUEST_HEADER'.freeze,
  ACTION_ADD_HTTP_RESPONSE_HEADER = 'ADD_HTTP_RESPONSE_HEADER'.freeze,
  ACTION_EXTEND_HTTP_RESPONSE_HEADER_VALUE = 'EXTEND_HTTP_RESPONSE_HEADER_VALUE'.freeze,
  ACTION_REMOVE_HTTP_RESPONSE_HEADER = 'REMOVE_HTTP_RESPONSE_HEADER'.freeze,
  ACTION_ALLOW = 'ALLOW'.freeze,
  ACTION_CONTROL_ACCESS_USING_HTTP_METHODS = 'CONTROL_ACCESS_USING_HTTP_METHODS'.freeze,
  ACTION_REDIRECT = 'REDIRECT'.freeze,
  ACTION_HTTP_HEADER = 'HTTP_HEADER'.freeze,
  ACTION_IP_BASED_MAX_CONNECTIONS = 'IP_BASED_MAX_CONNECTIONS'.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 = {}) ⇒ Rule

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :action (String) —

    The value to assign to the #action property



82
83
84
85
86
87
88
89
 
# File 'lib/oci/load_balancer/models/rule.rb', line 82

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

Instance Attribute Details

#action ⇒ String

This attribute is required.

Returns:

  • (String) 


30
31
32
 
# File 'lib/oci/load_balancer/models/rule.rb', line 30

def action
  @action
end

Class Method Details

.attribute_map ⇒ Object

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



33
34
35
36
37
38
39
 
# File 'lib/oci/load_balancer/models/rule.rb', line 33

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

.get_subtype(object_hash) ⇒ Object

Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/oci/load_balancer/models/rule.rb', line 55

def self.get_subtype(object_hash)
  type = object_hash[:'action'] # rubocop:disable Style/SymbolLiteral

  return 'OCI::LoadBalancer::Models::AddHttpRequestHeaderRule' if type == 'ADD_HTTP_REQUEST_HEADER'
  return 'OCI::LoadBalancer::Models::RedirectRule' if type == 'REDIRECT'
  return 'OCI::LoadBalancer::Models::RemoveHttpRequestHeaderRule' if type == 'REMOVE_HTTP_REQUEST_HEADER'
  return 'OCI::LoadBalancer::Models::ExtendHttpRequestHeaderValueRule' if type == 'EXTEND_HTTP_REQUEST_HEADER_VALUE'
  return 'OCI::LoadBalancer::Models::RemoveHttpResponseHeaderRule' if type == 'REMOVE_HTTP_RESPONSE_HEADER'
  return 'OCI::LoadBalancer::Models::ControlAccessUsingHttpMethodsRule' if type == 'CONTROL_ACCESS_USING_HTTP_METHODS'
  return 'OCI::LoadBalancer::Models::AllowRule' if type == 'ALLOW'
  return 'OCI::LoadBalancer::Models::IpBasedMaxConnectionsRule' if type == 'IP_BASED_MAX_CONNECTIONS'
  return 'OCI::LoadBalancer::Models::HttpHeaderRule' if type == 'HTTP_HEADER'
  return 'OCI::LoadBalancer::Models::AddHttpResponseHeaderRule' if type == 'ADD_HTTP_RESPONSE_HEADER'
  return 'OCI::LoadBalancer::Models::ExtendHttpResponseHeaderValueRule' if type == 'EXTEND_HTTP_RESPONSE_HEADER_VALUE'

  # TODO: Log a warning when the subtype is not found.
  'OCI::LoadBalancer::Models::Rule'
end

.swagger_types ⇒ Object

Attribute type mapping.



42
43
44
45
46
47
48
 
# File 'lib/oci/load_balancer/models/rule.rb', line 42

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'action': :'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



111
112
113
114
115
116
 
# File 'lib/oci/load_balancer/models/rule.rb', line 111

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

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



141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/oci/load_balancer/models/rule.rb', line 141

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


121
122
123
 
# File 'lib/oci/load_balancer/models/rule.rb', line 121

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



130
131
132
 
# File 'lib/oci/load_balancer/models/rule.rb', line 130

def hash
  [action].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



174
175
176
177
178
179
180
181
182
183
 
# File 'lib/oci/load_balancer/models/rule.rb', line 174

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



168
169
170
 
# File 'lib/oci/load_balancer/models/rule.rb', line 168

def to_s
  to_hash.to_s
end