Class: OCI::LoadBalancer::Models::SessionPersistenceConfigurationDetails
- Inherits:
-
Object
- Object
- OCI::LoadBalancer::Models::SessionPersistenceConfigurationDetails
- Defined in:
- lib/oci/load_balancer/models/session_persistence_configuration_details.rb
Overview
The configuration details for implementing session persistence based on a user-specified cookie name (application cookie stickiness).
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.
With application cookie stickiness, the load balancer enables session persistence only when the response from a backend application server includes a Set-cookie
header with the user-specified cookie name.
To disable application cookie stickiness on a running load balancer, use the update_backend_set operation and specify null
for the SessionPersistenceConfigurationDetails
object.
Example: SessionPersistenceConfigurationDetails: null
Note: SessionPersistenceConfigurationDetails
(application cookie stickiness) and LBCookieSessionPersistenceConfigurationDetails
(LB cookie stickiness) are mutually exclusive. An error results if you try to enable both types of session persistence.
Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.
Instance Attribute Summary collapse
-
#cookie_name ⇒ String
[Required] The name of the cookie used to detect a session initiated by the backend server.
-
#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.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(other) ⇒ Object
Checks equality by comparing each attribute.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(other) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ SessionPersistenceConfigurationDetails
constructor
Initializes the object.
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
Constructor Details
#initialize(attributes = {}) ⇒ SessionPersistenceConfigurationDetails
Initializes the object
75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 |
# File 'lib/oci/load_balancer/models/session_persistence_configuration_details.rb', line 75 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. = attributes[:'cookieName'] if attributes[:'cookieName'] raise 'You cannot provide both :cookieName and :cookie_name' if attributes.key?(:'cookieName') && attributes.key?(:'cookie_name') self. = attributes[:'cookie_name'] if attributes[:'cookie_name'] self.disable_fallback = attributes[:'disableFallback'] unless attributes[:'disableFallback'].nil? self.disable_fallback = false if disable_fallback.nil? && !attributes.key?(:'disableFallback') # rubocop:disable Style/StringLiterals raise 'You cannot provide both :disableFallback and :disable_fallback' if attributes.key?(:'disableFallback') && attributes.key?(:'disable_fallback') self.disable_fallback = attributes[:'disable_fallback'] unless attributes[:'disable_fallback'].nil? self.disable_fallback = false if disable_fallback.nil? && !attributes.key?(:'disableFallback') && !attributes.key?(:'disable_fallback') # rubocop:disable Style/StringLiterals end |
Instance Attribute Details
#cookie_name ⇒ String
[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: example_cookie
37 38 39 |
# File 'lib/oci/load_balancer/models/session_persistence_configuration_details.rb', line 37 def @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: false
45 46 47 |
# File 'lib/oci/load_balancer/models/session_persistence_configuration_details.rb', line 45 def disable_fallback @disable_fallback end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
48 49 50 51 52 53 54 55 |
# File 'lib/oci/load_balancer/models/session_persistence_configuration_details.rb', line 48 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'cookie_name': :'cookieName', 'disable_fallback': :'disableFallback' # rubocop:enable Style/SymbolLiteral } end |
.swagger_types ⇒ Object
Attribute type mapping.
58 59 60 61 62 63 64 65 |
# File 'lib/oci/load_balancer/models/session_persistence_configuration_details.rb', line 58 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'cookie_name': :'String', 'disable_fallback': :'BOOLEAN' # rubocop:enable Style/SymbolLiteral } end |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
103 104 105 106 107 108 109 |
# File 'lib/oci/load_balancer/models/session_persistence_configuration_details.rb', line 103 def ==(other) return true if equal?(other) self.class == other.class && == other. && disable_fallback == other.disable_fallback end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 |
# File 'lib/oci/load_balancer/models/session_persistence_configuration_details.rb', line 134 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
114 115 116 |
# File 'lib/oci/load_balancer/models/session_persistence_configuration_details.rb', line 114 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
123 124 125 |
# File 'lib/oci/load_balancer/models/session_persistence_configuration_details.rb', line 123 def hash [, disable_fallback].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
167 168 169 170 171 172 173 174 175 176 |
# File 'lib/oci/load_balancer/models/session_persistence_configuration_details.rb', line 167 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
161 162 163 |
# File 'lib/oci/load_balancer/models/session_persistence_configuration_details.rb', line 161 def to_s to_hash.to_s end |