Class: OCI::LoadBalancer::Models::UpdateBackendSetDetails

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

Overview

The configuration details for updating a load balancer backend set. For more information on backend set configuration, see Managing Backend Sets.

Note: The sessionPersistenceConfiguration (application cookie stickiness) and lbCookieSessionPersistenceConfiguration (LB cookie stickiness) attributes are mutually exclusive. To avoid returning an error, configure only one of these two attributes per backend set.

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 = {}) ⇒ UpdateBackendSetDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
# File 'lib/oci/load_balancer/models/update_backend_set_details.rb', line 96

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

  self.backends = attributes[:'backends'] if attributes[:'backends']

  self.backend_max_connections = attributes[:'backendMaxConnections'] if attributes[:'backendMaxConnections']

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

  self.backend_max_connections = attributes[:'backend_max_connections'] if attributes[:'backend_max_connections']

  self.health_checker = attributes[:'healthChecker'] if attributes[:'healthChecker']

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

  self.health_checker = attributes[:'health_checker'] if attributes[:'health_checker']

  self.ssl_configuration = attributes[:'sslConfiguration'] if attributes[:'sslConfiguration']

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

  self.ssl_configuration = attributes[:'ssl_configuration'] if attributes[:'ssl_configuration']

  self.session_persistence_configuration = attributes[:'sessionPersistenceConfiguration'] if attributes[:'sessionPersistenceConfiguration']

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

  self.session_persistence_configuration = attributes[:'session_persistence_configuration'] if attributes[:'session_persistence_configuration']

  self.lb_cookie_session_persistence_configuration = attributes[:'lbCookieSessionPersistenceConfiguration'] if attributes[:'lbCookieSessionPersistenceConfiguration']

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

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

Instance Attribute Details

#backend_max_connectionsInteger

The maximum number of simultaneous connections the load balancer can make to any backend in the backend set unless the backend has its own maxConnections setting.

Example: 300

Returns:

  • (Integer)


38
39
40
# File 'lib/oci/load_balancer/models/update_backend_set_details.rb', line 38

def backend_max_connections
  @backend_max_connections
end

#backendsArray<OCI::LoadBalancer::Models::BackendDetails>

This attribute is required.



30
31
32
# File 'lib/oci/load_balancer/models/update_backend_set_details.rb', line 30

def backends
  @backends
end

#health_checkerOCI::LoadBalancer::Models::HealthCheckerDetails

This attribute is required.



42
43
44
# File 'lib/oci/load_balancer/models/update_backend_set_details.rb', line 42

def health_checker
  @health_checker
end


51
52
53
# File 'lib/oci/load_balancer/models/update_backend_set_details.rb', line 51

def lb_cookie_session_persistence_configuration
  @lb_cookie_session_persistence_configuration
end

#policyString

[Required] The load balancer policy for the backend set. To get a list of available policies, use the list_policies operation.

Example: LEAST_CONNECTIONS

Returns:

  • (String)


26
27
28
# File 'lib/oci/load_balancer/models/update_backend_set_details.rb', line 26

def policy
  @policy
end

#session_persistence_configurationOCI::LoadBalancer::Models::SessionPersistenceConfigurationDetails



48
49
50
# File 'lib/oci/load_balancer/models/update_backend_set_details.rb', line 48

def session_persistence_configuration
  @session_persistence_configuration
end

#ssl_configurationOCI::LoadBalancer::Models::SSLConfigurationDetails



45
46
47
# File 'lib/oci/load_balancer/models/update_backend_set_details.rb', line 45

def ssl_configuration
  @ssl_configuration
end

Class Method Details

.attribute_mapObject

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



54
55
56
57
58
59
60
61
62
63
64
65
66
# File 'lib/oci/load_balancer/models/update_backend_set_details.rb', line 54

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'policy': :'policy',
    'backends': :'backends',
    'backend_max_connections': :'backendMaxConnections',
    'health_checker': :'healthChecker',
    'ssl_configuration': :'sslConfiguration',
    'session_persistence_configuration': :'sessionPersistenceConfiguration',
    'lb_cookie_session_persistence_configuration': :'lbCookieSessionPersistenceConfiguration'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



69
70
71
72
73
74
75
76
77
78
79
80
81
# File 'lib/oci/load_balancer/models/update_backend_set_details.rb', line 69

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'policy': :'String',
    'backends': :'Array<OCI::LoadBalancer::Models::BackendDetails>',
    'backend_max_connections': :'Integer',
    'health_checker': :'OCI::LoadBalancer::Models::HealthCheckerDetails',
    'ssl_configuration': :'OCI::LoadBalancer::Models::SSLConfigurationDetails',
    'session_persistence_configuration': :'OCI::LoadBalancer::Models::SessionPersistenceConfigurationDetails',
    'lb_cookie_session_persistence_configuration': :'OCI::LoadBalancer::Models::LBCookieSessionPersistenceConfigurationDetails'
    # 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



144
145
146
147
148
149
150
151
152
153
154
155
# File 'lib/oci/load_balancer/models/update_backend_set_details.rb', line 144

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

  self.class == other.class &&
    policy == other.policy &&
    backends == other.backends &&
    backend_max_connections == other.backend_max_connections &&
    health_checker == other.health_checker &&
    ssl_configuration == other.ssl_configuration &&
    session_persistence_configuration == other.session_persistence_configuration &&
    lb_cookie_session_persistence_configuration == other.lb_cookie_session_persistence_configuration
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



180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
# File 'lib/oci/load_balancer/models/update_backend_set_details.rb', line 180

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


160
161
162
# File 'lib/oci/load_balancer/models/update_backend_set_details.rb', line 160

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



169
170
171
# File 'lib/oci/load_balancer/models/update_backend_set_details.rb', line 169

def hash
  [policy, backends, backend_max_connections, health_checker, ssl_configuration, session_persistence_configuration, lb_cookie_session_persistence_configuration].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



213
214
215
216
217
218
219
220
221
222
# File 'lib/oci/load_balancer/models/update_backend_set_details.rb', line 213

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



207
208
209
# File 'lib/oci/load_balancer/models/update_backend_set_details.rb', line 207

def to_s
  to_hash.to_s
end