Class: OCI::LoadBalancer::Models::SessionPersistenceConfigurationDetails

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

Overview

The configuration details for implementing session persistence. Session persistence enables the Load Balancing Service to direct any number of requests that originate from a single logical client to a single backend web server. For more information, see [Session Persistence](docs.us-phoenix-1.oraclecloud.com/Content/Balance/Reference/sessionpersistence.htm).

To disable session persistence on a running load balancer, use the update_backend_set operation and specify "null" for the ‘SessionPersistenceConfigurationDetails` object.

Example: ‘SessionPersistenceConfigurationDetails: null`

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SessionPersistenceConfigurationDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :cookie_name (String) —

    The value to assign to the #cookie_name property

  • :disable_fallback (BOOLEAN) —

    The value to assign to the #disable_fallback property



38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/oci/load_balancer/models/session_persistence_configuration_details.rb', line 38

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}

  if attributes[:'cookieName']
    self.cookie_name = attributes[:'cookieName']
  end

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

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

  unless attributes[:'disableFallback'].nil?
    self.disable_fallback = attributes[:'disableFallback']
  else
    self.disable_fallback = false
  end

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

  unless attributes[:'disable_fallback'].nil?
    self.disable_fallback = attributes[:'disable_fallback']
  else
    self.disable_fallback = false
  end

end

Instance Attribute Details

[Required] The name of the cookie used to detect a session initiated by the backend server. Use ‘*’ to specify that any cookie set by the backend causes the session to persist.

Example: ‘myCookieName`

Returns:

  • (String) 


23
24
25
 
# File 'lib/oci/load_balancer/models/session_persistence_configuration_details.rb', line 23

def cookie_name
  @cookie_name
end

#disable_fallback ⇒ BOOLEAN

Whether the load balancer is prevented from directing traffic from a persistent session client to a different backend server if the original server is unavailable. Defaults to false.

Example: ‘true`

Returns:

  • (BOOLEAN) 


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

def disable_fallback
  @disable_fallback
end

Instance Method Details

#==(other_object) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other_object (Object) —

    to be compared



72
73
74
75
76
77
 
# File 'lib/oci/load_balancer/models/session_persistence_configuration_details.rb', line 72

def ==(other_object)
  return true if self.equal?(other_object)
  self.class == other_object.class &&
      cookie_name == other_object.cookie_name &&
      disable_fallback == other_object.disable_fallback
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



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/oci/load_balancer/models/session_persistence_configuration_details.rb', line 94

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)
        self.public_method("#{key}=").call(attributes[self.class.attribute_map[key]].map{ |v| OCI::Internal::Util.convert_to_type($1, v) } )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.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_object) ⇒ Boolean

Parameters:

  • other_object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


81
82
83
 
# File 'lib/oci/load_balancer/models/session_persistence_configuration_details.rb', line 81

def eql?(other_object)
  self == other_object
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



87
88
89
 
# File 'lib/oci/load_balancer/models/session_persistence_configuration_details.rb', line 87

def hash
  [cookie_name, disable_fallback].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



119
120
121
122
123
124
125
126
127
 
# File 'lib/oci/load_balancer/models/session_persistence_configuration_details.rb', line 119

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



113
114
115
 
# File 'lib/oci/load_balancer/models/session_persistence_configuration_details.rb', line 113

def to_s
  to_hash.to_s
end