Class: OCI::Waas::Models::StickyCookieLoadBalancingMethod

Inherits:
LoadBalancingMethod show all
Defined in:
lib/oci/waas/models/sticky_cookie_load_balancing_method.rb

Overview

An object that represents the sticky-cookie load balancing method and its properties.

Constant Summary

Constants inherited from LoadBalancingMethod

LoadBalancingMethod::METHOD_ENUM

Instance Attribute Summary collapse

Attributes inherited from LoadBalancingMethod

#method

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from LoadBalancingMethod

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ StickyCookieLoadBalancingMethod

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

  • :domain (String)

    The value to assign to the #domain property

  • :expiration_time_in_seconds (Integer)

    The value to assign to the #expiration_time_in_seconds property



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
# File 'lib/oci/waas/models/sticky_cookie_load_balancing_method.rb', line 62

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

  attributes['method'] = 'STICKY_COOKIE'

  super(attributes)

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

  self.expiration_time_in_seconds = attributes[:'expirationTimeInSeconds'] if attributes[:'expirationTimeInSeconds']

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

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

Instance Attribute Details

#domainString

The domain for which the cookie is set, defaults to WAAS policy domain.

Returns:

  • (String)


21
22
23
# File 'lib/oci/waas/models/sticky_cookie_load_balancing_method.rb', line 21

def domain
  @domain
end

#expiration_time_in_secondsInteger

The time for which a browser should keep the cookie in seconds. Empty value will cause the cookie to expire at the end of a browser session.

Returns:

  • (Integer)


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

def expiration_time_in_seconds
  @expiration_time_in_seconds
end

#nameString

The name of the cookie used to track the persistence. Can contain any US-ASCII character except separator or control character.

Returns:

  • (String)


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

def name
  @name
end

Class Method Details

.attribute_mapObject

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



30
31
32
33
34
35
36
37
38
39
# File 'lib/oci/waas/models/sticky_cookie_load_balancing_method.rb', line 30

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'method': :'method',
    'name': :'name',
    'domain': :'domain',
    'expiration_time_in_seconds': :'expirationTimeInSeconds'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'method': :'String',
    'name': :'String',
    'domain': :'String',
    'expiration_time_in_seconds': :'Integer'
    # 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



90
91
92
93
94
95
96
97
98
# File 'lib/oci/waas/models/sticky_cookie_load_balancing_method.rb', line 90

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

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



123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
# File 'lib/oci/waas/models/sticky_cookie_load_balancing_method.rb', line 123

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


103
104
105
# File 'lib/oci/waas/models/sticky_cookie_load_balancing_method.rb', line 103

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



112
113
114
# File 'lib/oci/waas/models/sticky_cookie_load_balancing_method.rb', line 112

def hash
  [method, name, domain, expiration_time_in_seconds].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



156
157
158
159
160
161
162
163
164
165
# File 'lib/oci/waas/models/sticky_cookie_load_balancing_method.rb', line 156

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



150
151
152
# File 'lib/oci/waas/models/sticky_cookie_load_balancing_method.rb', line 150

def to_s
  to_hash.to_s
end