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 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](docs.cloud.oracle.com/Content/Balance/Reference/sessionpersistence.htm).

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`

Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.

Instance Attribute Summary collapse

Class Method 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



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/oci/load_balancer/models/session_persistence_configuration_details.rb', line 67

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

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

  self.cookie_name = 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

[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`

Returns:

  • (String) 


29
30
31
 
# File 'lib/oci/load_balancer/models/session_persistence_configuration_details.rb', line 29

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: ‘false`

Returns:

  • (BOOLEAN) 


37
38
39
 
# File 'lib/oci/load_balancer/models/session_persistence_configuration_details.rb', line 37

def disable_fallback
  @disable_fallback
end

Class Method Details

.attribute_map ⇒ Object

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



40
41
42
43
44
45
46
47
 
# File 'lib/oci/load_balancer/models/session_persistence_configuration_details.rb', line 40

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.



50
51
52
53
54
55
56
57
 
# File 'lib/oci/load_balancer/models/session_persistence_configuration_details.rb', line 50

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.

Parameters:

  • other (Object) —

    the other object to be compared



95
96
97
98
99
100
101
 
# File 'lib/oci/load_balancer/models/session_persistence_configuration_details.rb', line 95

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

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



126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/oci/load_balancer/models/session_persistence_configuration_details.rb', line 126

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


106
107
108
 
# File 'lib/oci/load_balancer/models/session_persistence_configuration_details.rb', line 106

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



115
116
117
 
# File 'lib/oci/load_balancer/models/session_persistence_configuration_details.rb', line 115

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



159
160
161
162
163
164
165
166
167
168
 
# File 'lib/oci/load_balancer/models/session_persistence_configuration_details.rb', line 159

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



153
154
155
 
# File 'lib/oci/load_balancer/models/session_persistence_configuration_details.rb', line 153

def to_s
  to_hash.to_s
end