Class: OCI::Waas::Models::LoadBalancingMethod

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

Overview

LoadBalancingMethod model. 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

METHOD_ENUM =
[
  METHOD_IP_HASH = 'IP_HASH'.freeze,
  METHOD_ROUND_ROBIN = 'ROUND_ROBIN'.freeze,
  METHOD_STICKY_COOKIE = 'STICKY_COOKIE'.freeze,
  METHOD_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ LoadBalancingMethod

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :method (String)

    The value to assign to the #method property



71
72
73
74
75
76
77
78
# File 'lib/oci/waas/models/load_balancing_method.rb', line 71

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

Instance Attribute Details

#methodString

[Required] Load balancing methods are algorithms used to efficiently distribute traffic among origin servers.

  • IP_HASH: All the incoming requests from the same client IP address should go to the same content origination server. IP_HASH load balancing method uses origin weights when choosing which origin should the hash be assigned to initially.

  • ROUND_ROBIN: Forwards requests sequentially to the available origin servers. The first request - to the first origin server, the second request - to the next origin server, and so on. After it sends a request to the last origin server, it starts again with the first origin server. When using weights on origins, Weighted Round Robin assigns more requests to origins with a greater weight. Over a period of time, origins will receive a number of requests in proportion to their weight.

  • STICKY_COOKIE: Adds a session cookie to the first response from the origin server and identifies the server that sent the response. The client's next request contains the cookie value, and nginx routes the request to the origin server that responded to the first request. STICKY_COOKIE load balancing method falls back to Round Robin for the first request.

Returns:

  • (String)


27
28
29
# File 'lib/oci/waas/models/load_balancing_method.rb', line 27

def method
  @method
end

Class Method Details

.attribute_mapObject

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



30
31
32
33
34
35
36
# File 'lib/oci/waas/models/load_balancing_method.rb', line 30

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



52
53
54
55
56
57
58
59
60
61
# File 'lib/oci/waas/models/load_balancing_method.rb', line 52

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

  return 'OCI::Waas::Models::RoundRobinLoadBalancingMethod' if type == 'ROUND_ROBIN'
  return 'OCI::Waas::Models::StickyCookieLoadBalancingMethod' if type == 'STICKY_COOKIE'
  return 'OCI::Waas::Models::IPHashLoadBalancingMethod' if type == 'IP_HASH'

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

.swagger_typesObject

Attribute type mapping.



39
40
41
42
43
44
45
# File 'lib/oci/waas/models/load_balancing_method.rb', line 39

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



100
101
102
103
104
105
# File 'lib/oci/waas/models/load_balancing_method.rb', line 100

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

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



130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
# File 'lib/oci/waas/models/load_balancing_method.rb', line 130

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


110
111
112
# File 'lib/oci/waas/models/load_balancing_method.rb', line 110

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



119
120
121
# File 'lib/oci/waas/models/load_balancing_method.rb', line 119

def hash
  [method].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



163
164
165
166
167
168
169
170
171
172
# File 'lib/oci/waas/models/load_balancing_method.rb', line 163

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



157
158
159
# File 'lib/oci/waas/models/load_balancing_method.rb', line 157

def to_s
  to_hash.to_s
end