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

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



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

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) 


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

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) 


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

def disable_fallback
  @disable_fallback
end

Class Method Details

.attribute_map ⇒ Object

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



35
36
37
38
39
40
41
42
 
# File 'lib/oci/load_balancer/models/session_persistence_configuration_details.rb', line 35

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.



45
46
47
48
49
50
51
52
 
# File 'lib/oci/load_balancer/models/session_persistence_configuration_details.rb', line 45

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



90
91
92
93
94
95
 
# File 'lib/oci/load_balancer/models/session_persistence_configuration_details.rb', line 90

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



120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/oci/load_balancer/models/session_persistence_configuration_details.rb', line 120

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


100
101
102
 
# File 'lib/oci/load_balancer/models/session_persistence_configuration_details.rb', line 100

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



109
110
111
 
# File 'lib/oci/load_balancer/models/session_persistence_configuration_details.rb', line 109

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



152
153
154
155
156
157
158
159
160
 
# File 'lib/oci/load_balancer/models/session_persistence_configuration_details.rb', line 152

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



146
147
148
 
# File 'lib/oci/load_balancer/models/session_persistence_configuration_details.rb', line 146

def to_s
  to_hash.to_s
end